text
stringlengths 0
13M
|
|---|
View on GitHub Forms Examples and usage guidelines for form control styles, layout options, and custom components for creating a wide variety of forms. Overview Bootstrap’s form controls expand on our Rebooted form styles with classes. Use these classes to opt into their customized displays for a more consistent rendering across browsers and devices. Be sure to use an appropriate type attribute on all inputs (e.g., email for email address or number for numerical information) to take advantage of newer input controls like email verification, number selection, and more. Here’s a quick example to demonstrate Bootstrap’s form styles. Keep reading for documentation on required classes, form layout, and more. Open example on getbootstrap.com <form>
<div class="form-group">
<label for="exampleInputEmail1">Email address</label>
<input type="email" class="form-control" id="exampleInputEmail1" aria-describedby="emailHelp">
<small id="emailHelp" class="form-text text-muted">We'll never share your email with anyone else.</small>
</div>
<div class="form-group">
<label for="exampleInputPassword1">Password</label>
<input type="password" class="form-control" id="exampleInputPassword1">
</div>
<div class="form-group form-check">
<input type="checkbox" class="form-check-input" id="exampleCheck1">
<label class="form-check-label" for="exampleCheck1">Check me out</label>
</div>
<button type="submit" class="btn btn-primary">Submit</button>
</form> Form controls Textual form controls—like <input>s, <select>s, and <textarea>s—are styled with the .form-control class. Included are styles for general appearance, focus state, sizing, and more. Be sure to explore our custom forms to further style <select>s. Open example on getbootstrap.com <form>
<div class="form-group">
<label for="exampleFormControlInput1">Email address</label>
<input type="email" class="form-control" id="exampleFormControlInput1" placeholder="[email protected]">
</div>
<div class="form-group">
<label for="exampleFormControlSelect1">Example select</label>
<select class="form-control" id="exampleFormControlSelect1">
<option>1</option>
<option>2</option>
<option>3</option>
<option>4</option>
<option>5</option>
</select>
</div>
<div class="form-group">
<label for="exampleFormControlSelect2">Example multiple select</label>
<select multiple class="form-control" id="exampleFormControlSelect2">
<option>1</option>
<option>2</option>
<option>3</option>
<option>4</option>
<option>5</option>
</select>
</div>
<div class="form-group">
<label for="exampleFormControlTextarea1">Example textarea</label>
<textarea class="form-control" id="exampleFormControlTextarea1" rows="3"></textarea>
</div>
</form> For file inputs, swap the .form-control for .form-control-file. Open example on getbootstrap.com <form>
<div class="form-group">
<label for="exampleFormControlFile1">Example file input</label>
<input type="file" class="form-control-file" id="exampleFormControlFile1">
</div>
</form> Sizing Set heights using classes like .form-control-lg and .form-control-sm. Open example on getbootstrap.com <input class="form-control form-control-lg" type="text" placeholder=".form-control-lg">
<input class="form-control" type="text" placeholder="Default input">
<input class="form-control form-control-sm" type="text" placeholder=".form-control-sm"> Open example on getbootstrap.com <select class="form-control form-control-lg">
<option>Large select</option>
</select>
<select class="form-control">
<option>Default select</option>
</select>
<select class="form-control form-control-sm">
<option>Small select</option>
</select> Readonly Add the readonly boolean attribute on an input to prevent modification of the input’s value. Read-only inputs appear lighter (just like disabled inputs), but retain the standard cursor. Open example on getbootstrap.com <input class="form-control" type="text" placeholder="Readonly input here..." readonly> Readonly plain text If you want to have <input readonly> elements in your form styled as plain text, use the .form-control-plaintext class to remove the default form field styling and preserve the correct margin and padding. Open example on getbootstrap.com <form>
<div class="form-group row">
<label for="staticEmail" class="col-sm-2 col-form-label">Email</label>
<div class="col-sm-10">
<input type="text" readonly class="form-control-plaintext" id="staticEmail" value="[email protected]">
</div>
</div>
<div class="form-group row">
<label for="inputPassword" class="col-sm-2 col-form-label">Password</label>
<div class="col-sm-10">
<input type="password" class="form-control" id="inputPassword">
</div>
</div>
</form> Open example on getbootstrap.com <form class="form-inline">
<div class="form-group mb-2">
<label for="staticEmail2" class="sr-only">Email</label>
<input type="text" readonly class="form-control-plaintext" id="staticEmail2" value="[email protected]">
</div>
<div class="form-group mx-sm-3 mb-2">
<label for="inputPassword2" class="sr-only">Password</label>
<input type="password" class="form-control" id="inputPassword2" placeholder="Password">
</div>
<button type="submit" class="btn btn-primary mb-2">Confirm identity</button>
</form> Range Inputs Set horizontally scrollable range inputs using .form-control-range. Open example on getbootstrap.com <form>
<div class="form-group">
<label for="formControlRange">Example Range input</label>
<input type="range" class="form-control-range" id="formControlRange">
</div>
</form> Checkboxes and radios Default checkboxes and radios are improved upon with the help of .form-check, a single class for both input types that improves the layout and behavior of their HTML elements. Checkboxes are for selecting one or several options in a list, while radios are for selecting one option from many. Disabled checkboxes and radios are supported. The disabled attribute will apply a lighter color to help indicate the input’s state. Checkboxes and radio buttons support HTML-based form validation and provide concise, accessible labels. As such, our <input>s and <label>s are sibling elements as opposed to an <input> within a <label>. This is slightly more verbose as you must specify id and for attributes to relate the <input> and <label>. Default (stacked) By default, any number of checkboxes and radios that are immediate sibling will be vertically stacked and appropriately spaced with .form-check. Open example on getbootstrap.com <div class="form-check">
<input class="form-check-input" type="checkbox" value="" id="defaultCheck1">
<label class="form-check-label" for="defaultCheck1">
Default checkbox
</label>
</div>
<div class="form-check">
<input class="form-check-input" type="checkbox" value="" id="defaultCheck2" disabled>
<label class="form-check-label" for="defaultCheck2">
Disabled checkbox
</label>
</div> Open example on getbootstrap.com <div class="form-check">
<input class="form-check-input" type="radio" name="exampleRadios" id="exampleRadios1" value="option1" checked>
<label class="form-check-label" for="exampleRadios1">
Default radio
</label>
</div>
<div class="form-check">
<input class="form-check-input" type="radio" name="exampleRadios" id="exampleRadios2" value="option2">
<label class="form-check-label" for="exampleRadios2">
Second default radio
</label>
</div>
<div class="form-check">
<input class="form-check-input" type="radio" name="exampleRadios" id="exampleRadios3" value="option3" disabled>
<label class="form-check-label" for="exampleRadios3">
Disabled radio
</label>
</div> Inline Group checkboxes or radios on the same horizontal row by adding .form-check-inline to any .form-check. Open example on getbootstrap.com <div class="form-check form-check-inline">
<input class="form-check-input" type="checkbox" id="inlineCheckbox1" value="option1">
<label class="form-check-label" for="inlineCheckbox1">1</label>
</div>
<div class="form-check form-check-inline">
<input class="form-check-input" type="checkbox" id="inlineCheckbox2" value="option2">
<label class="form-check-label" for="inlineCheckbox2">2</label>
</div>
<div class="form-check form-check-inline">
<input class="form-check-input" type="checkbox" id="inlineCheckbox3" value="option3" disabled>
<label class="form-check-label" for="inlineCheckbox3">3 (disabled)</label>
</div> Open example on getbootstrap.com <div class="form-check form-check-inline">
<input class="form-check-input" type="radio" name="inlineRadioOptions" id="inlineRadio1" value="option1">
<label class="form-check-label" for="inlineRadio1">1</label>
</div>
<div class="form-check form-check-inline">
<input class="form-check-input" type="radio" name="inlineRadioOptions" id="inlineRadio2" value="option2">
<label class="form-check-label" for="inlineRadio2">2</label>
</div>
<div class="form-check form-check-inline">
<input class="form-check-input" type="radio" name="inlineRadioOptions" id="inlineRadio3" value="option3" disabled>
<label class="form-check-label" for="inlineRadio3">3 (disabled)</label>
</div> Without labels Add .position-static to inputs within .form-check that don’t have any label text. Remember to still provide some form of accessible name for assistive technologies (for instance, using aria-label). Open example on getbootstrap.com <div class="form-check">
<input class="form-check-input position-static" type="checkbox" id="blankCheckbox" value="option1" aria-label="...">
</div>
<div class="form-check">
<input class="form-check-input position-static" type="radio" name="blankRadio" id="blankRadio1" value="option1" aria-label="...">
</div> Layout Since Bootstrap applies display: block and width: 100% to almost all our form controls, forms will by default stack vertically. Additional classes can be used to vary this layout on a per-form basis. Form groups The .form-group class is the easiest way to add some structure to forms. It provides a flexible class that encourages proper grouping of labels, controls, optional help text, and form validation messaging. By default it only applies margin-bottom, but it picks up additional styles in .form-inline as needed. Use it with <fieldset>s, <div>s, or nearly any other element. Open example on getbootstrap.com <form>
<div class="form-group">
<label for="formGroupExampleInput">Example label</label>
<input type="text" class="form-control" id="formGroupExampleInput" placeholder="Example input placeholder">
</div>
<div class="form-group">
<label for="formGroupExampleInput2">Another label</label>
<input type="text" class="form-control" id="formGroupExampleInput2" placeholder="Another input placeholder">
</div>
</form> Form grid More complex forms can be built using our grid classes. Use these for form layouts that require multiple columns, varied widths, and additional alignment options. Open example on getbootstrap.com <form>
<div class="row">
<div class="col">
<input type="text" class="form-control" placeholder="First name">
</div>
<div class="col">
<input type="text" class="form-control" placeholder="Last name">
</div>
</div>
</form> Form row You may also swap .row for .form-row, a variation of our standard grid row that overrides the default column gutters for tighter and more compact layouts. Open example on getbootstrap.com <form>
<div class="form-row">
<div class="col">
<input type="text" class="form-control" placeholder="First name">
</div>
<div class="col">
<input type="text" class="form-control" placeholder="Last name">
</div>
</div>
</form> More complex layouts can also be created with the grid system. Open example on getbootstrap.com <form>
<div class="form-row">
<div class="form-group col-md-6">
<label for="inputEmail4">Email</label>
<input type="email" class="form-control" id="inputEmail4">
</div>
<div class="form-group col-md-6">
<label for="inputPassword4">Password</label>
<input type="password" class="form-control" id="inputPassword4">
</div>
</div>
<div class="form-group">
<label for="inputAddress">Address</label>
<input type="text" class="form-control" id="inputAddress" placeholder="1234 Main St">
</div>
<div class="form-group">
<label for="inputAddress2">Address 2</label>
<input type="text" class="form-control" id="inputAddress2" placeholder="Apartment, studio, or floor">
</div>
<div class="form-row">
<div class="form-group col-md-6">
<label for="inputCity">City</label>
<input type="text" class="form-control" id="inputCity">
</div>
<div class="form-group col-md-4">
<label for="inputState">State</label>
<select id="inputState" class="form-control">
<option selected>Choose...</option>
<option>...</option>
</select>
</div>
<div class="form-group col-md-2">
<label for="inputZip">Zip</label>
<input type="text" class="form-control" id="inputZip">
</div>
</div>
<div class="form-group">
<div class="form-check">
<input class="form-check-input" type="checkbox" id="gridCheck">
<label class="form-check-label" for="gridCheck">
Check me out
</label>
</div>
</div>
<button type="submit" class="btn btn-primary">Sign in</button>
</form> Horizontal form Create horizontal forms with the grid by adding the .row class to form groups and using the .col-*-* classes to specify the width of your labels and controls. Be sure to add .col-form-label to your <label>s as well so they’re vertically centered with their associated form controls. At times, you maybe need to use margin or padding utilities to create that perfect alignment you need. For example, we’ve removed the padding-top on our stacked radio inputs label to better align the text baseline. Open example on getbootstrap.com <form>
<div class="form-group row">
<label for="inputEmail3" class="col-sm-2 col-form-label">Email</label>
<div class="col-sm-10">
<input type="email" class="form-control" id="inputEmail3">
</div>
</div>
<div class="form-group row">
<label for="inputPassword3" class="col-sm-2 col-form-label">Password</label>
<div class="col-sm-10">
<input type="password" class="form-control" id="inputPassword3">
</div>
</div>
<fieldset class="form-group">
<div class="row">
<legend class="col-form-label col-sm-2 pt-0">Radios</legend>
<div class="col-sm-10">
<div class="form-check">
<input class="form-check-input" type="radio" name="gridRadios" id="gridRadios1" value="option1" checked>
<label class="form-check-label" for="gridRadios1">
First radio
</label>
</div>
<div class="form-check">
<input class="form-check-input" type="radio" name="gridRadios" id="gridRadios2" value="option2">
<label class="form-check-label" for="gridRadios2">
Second radio
</label>
</div>
<div class="form-check disabled">
<input class="form-check-input" type="radio" name="gridRadios" id="gridRadios3" value="option3" disabled>
<label class="form-check-label" for="gridRadios3">
Third disabled radio
</label>
</div>
</div>
</div>
</fieldset>
<div class="form-group row">
<div class="col-sm-2">Checkbox</div>
<div class="col-sm-10">
<div class="form-check">
<input class="form-check-input" type="checkbox" id="gridCheck1">
<label class="form-check-label" for="gridCheck1">
Example checkbox
</label>
</div>
</div>
</div>
<div class="form-group row">
<div class="col-sm-10">
<button type="submit" class="btn btn-primary">Sign in</button>
</div>
</div>
</form> Horizontal form label sizing Be sure to use .col-form-label-sm or .col-form-label-lg to your <label>s or <legend>s to correctly follow the size of .form-control-lg and .form-control-sm. Open example on getbootstrap.com <form>
<div class="form-group row">
<label for="colFormLabelSm" class="col-sm-2 col-form-label col-form-label-sm">Email</label>
<div class="col-sm-10">
<input type="email" class="form-control form-control-sm" id="colFormLabelSm" placeholder="col-form-label-sm">
</div>
</div>
<div class="form-group row">
<label for="colFormLabel" class="col-sm-2 col-form-label">Email</label>
<div class="col-sm-10">
<input type="email" class="form-control" id="colFormLabel" placeholder="col-form-label">
</div>
</div>
<div class="form-group row">
<label for="colFormLabelLg" class="col-sm-2 col-form-label col-form-label-lg">Email</label>
<div class="col-sm-10">
<input type="email" class="form-control form-control-lg" id="colFormLabelLg" placeholder="col-form-label-lg">
</div>
</div>
</form> Column sizing As shown in the previous examples, our grid system allows you to place any number of .cols within a .row or .form-row. They’ll split the available width equally between them. You may also pick a subset of your columns to take up more or less space, while the remaining .cols equally split the rest, with specific column classes like .col-7. Open example on getbootstrap.com <form>
<div class="form-row">
<div class="col-7">
<input type="text" class="form-control" placeholder="City">
</div>
<div class="col">
<input type="text" class="form-control" placeholder="State">
</div>
<div class="col">
<input type="text" class="form-control" placeholder="Zip">
</div>
</div>
</form> Auto-sizing The example below uses a flexbox utility to vertically center the contents and changes .col to .col-auto so that your columns only take up as much space as needed. Put another way, the column sizes itself based on the contents. Open example on getbootstrap.com <form>
<div class="form-row align-items-center">
<div class="col-auto">
<label class="sr-only" for="inlineFormInput">Name</label>
<input type="text" class="form-control mb-2" id="inlineFormInput" placeholder="Jane Doe">
</div>
<div class="col-auto">
<label class="sr-only" for="inlineFormInputGroup">Username</label>
<div class="input-group mb-2">
<div class="input-group-prepend">
<div class="input-group-text">@</div>
</div>
<input type="text" class="form-control" id="inlineFormInputGroup" placeholder="Username">
</div>
</div>
<div class="col-auto">
<div class="form-check mb-2">
<input class="form-check-input" type="checkbox" id="autoSizingCheck">
<label class="form-check-label" for="autoSizingCheck">
Remember me
</label>
</div>
</div>
<div class="col-auto">
<button type="submit" class="btn btn-primary mb-2">Submit</button>
</div>
</div>
</form> You can then remix that once again with size-specific column classes. Open example on getbootstrap.com <form>
<div class="form-row align-items-center">
<div class="col-sm-3 my-1">
<label class="sr-only" for="inlineFormInputName">Name</label>
<input type="text" class="form-control" id="inlineFormInputName" placeholder="Jane Doe">
</div>
<div class="col-sm-3 my-1">
<label class="sr-only" for="inlineFormInputGroupUsername">Username</label>
<div class="input-group">
<div class="input-group-prepend">
<div class="input-group-text">@</div>
</div>
<input type="text" class="form-control" id="inlineFormInputGroupUsername" placeholder="Username">
</div>
</div>
<div class="col-auto my-1">
<div class="form-check">
<input class="form-check-input" type="checkbox" id="autoSizingCheck2">
<label class="form-check-label" for="autoSizingCheck2">
Remember me
</label>
</div>
</div>
<div class="col-auto my-1">
<button type="submit" class="btn btn-primary">Submit</button>
</div>
</div>
</form> And of course custom form controls are supported. Open example on getbootstrap.com <form>
<div class="form-row align-items-center">
<div class="col-auto my-1">
<label class="mr-sm-2 sr-only" for="inlineFormCustomSelect">Preference</label>
<select class="custom-select mr-sm-2" id="inlineFormCustomSelect">
<option selected>Choose...</option>
<option value="1">One</option>
<option value="2">Two</option>
<option value="3">Three</option>
</select>
</div>
<div class="col-auto my-1">
<div class="custom-control custom-checkbox mr-sm-2">
<input type="checkbox" class="custom-control-input" id="customControlAutosizing">
<label class="custom-control-label" for="customControlAutosizing">Remember my preference</label>
</div>
</div>
<div class="col-auto my-1">
<button type="submit" class="btn btn-primary">Submit</button>
</div>
</div>
</form> Inline forms Use the .form-inline class to display a series of labels, form controls, and buttons on a single horizontal row. Form controls within inline forms vary slightly from their default states. Controls are display: flex, collapsing any HTML white space and allowing you to provide alignment control with spacing and flexbox utilities. Controls and input groups receive width: auto to override the Bootstrap default width: 100%. Controls only appear inline in viewports that are at least 576px wide to account for narrow viewports on mobile devices. You may need to manually address the width and alignment of individual form controls with spacing utilities (as shown below). Lastly, be sure to always include a <label> with each form control, even if you need to hide it from non-screenreader visitors with .sr-only. Open example on getbootstrap.com <form class="form-inline">
<label class="sr-only" for="inlineFormInputName2">Name</label>
<input type="text" class="form-control mb-2 mr-sm-2" id="inlineFormInputName2" placeholder="Jane Doe">
<label class="sr-only" for="inlineFormInputGroupUsername2">Username</label>
<div class="input-group mb-2 mr-sm-2">
<div class="input-group-prepend">
<div class="input-group-text">@</div>
</div>
<input type="text" class="form-control" id="inlineFormInputGroupUsername2" placeholder="Username">
</div>
<div class="form-check mb-2 mr-sm-2">
<input class="form-check-input" type="checkbox" id="inlineFormCheck">
<label class="form-check-label" for="inlineFormCheck">
Remember me
</label>
</div>
<button type="submit" class="btn btn-primary mb-2">Submit</button>
</form> Custom form controls and selects are also supported. Open example on getbootstrap.com <form class="form-inline">
<label class="my-1 mr-2" for="inlineFormCustomSelectPref">Preference</label>
<select class="custom-select my-1 mr-sm-2" id="inlineFormCustomSelectPref">
<option selected>Choose...</option>
<option value="1">One</option>
<option value="2">Two</option>
<option value="3">Three</option>
</select>
<div class="custom-control custom-checkbox my-1 mr-sm-2">
<input type="checkbox" class="custom-control-input" id="customControlInline">
<label class="custom-control-label" for="customControlInline">Remember my preference</label>
</div>
<button type="submit" class="btn btn-primary my-1">Submit</button>
</form> Alternatives to hidden labels Assistive technologies such as screen readers will have trouble with your forms if you don’t include a label for every input. For these inline forms, you can hide the labels using the .sr-only class. There are further alternative methods of providing a label for assistive technologies, such as the aria-label, aria-labelledby or title attribute. If none of these are present, assistive technologies may resort to using the placeholder attribute, if present, but note that use of placeholder as a replacement for other labelling methods is not advised. Help text Block-level help text in forms can be created using .form-text (previously known as .help-block in v3). Inline help text can be flexibly implemented using any inline HTML element and utility classes like .text-muted. Associating help text with form controls Help text should be explicitly associated with the form control it relates to using the aria-describedby attribute. This will ensure that assistive technologies—such as screen readers—will announce this help text when the user focuses or enters the control. Help text below inputs can be styled with .form-text. This class includes display: block and adds some top margin for easy spacing from the inputs above. Open example on getbootstrap.com <label for="inputPassword5">Password</label>
<input type="password" id="inputPassword5" class="form-control" aria-describedby="passwordHelpBlock">
<small id="passwordHelpBlock" class="form-text text-muted">
Your password must be 8-20 characters long, contain letters and numbers, and must not contain spaces, special characters, or emoji.
</small> Inline text can use any typical inline HTML element (be it a <small>, <span>, or something else) with nothing more than a utility class. Open example on getbootstrap.com <form class="form-inline">
<div class="form-group">
<label for="inputPassword6">Password</label>
<input type="password" id="inputPassword6" class="form-control mx-sm-3" aria-describedby="passwordHelpInline">
<small id="passwordHelpInline" class="text-muted">
Must be 8-20 characters long.
</small>
</div>
</form> Disabled forms Add the disabled boolean attribute on an input to prevent user interactions and make it appear lighter. <input class="form-control" id="disabledInput" type="text" placeholder="Disabled input here..." disabled> Add the disabled attribute to a <fieldset> to disable all the controls within. Open example on getbootstrap.com <form>
<fieldset disabled>
<div class="form-group">
<label for="disabledTextInput">Disabled input</label>
<input type="text" id="disabledTextInput" class="form-control" placeholder="Disabled input">
</div>
<div class="form-group">
<label for="disabledSelect">Disabled select menu</label>
<select id="disabledSelect" class="form-control">
<option>Disabled select</option>
</select>
</div>
<div class="form-group">
<div class="form-check">
<input class="form-check-input" type="checkbox" id="disabledFieldsetCheck" disabled>
<label class="form-check-label" for="disabledFieldsetCheck">
Can't check this
</label>
</div>
</div>
<button type="submit" class="btn btn-primary">Submit</button>
</fieldset>
</form> Caveat with anchors Browsers treat all native form controls (<input>, <select>, and <button> elements) inside a <fieldset disabled> as disabled, preventing both keyboard and mouse interactions on them. However, if your form also includes custom button-like elements such as <a ... class="btn btn-*">, these will only be given a style of pointer-events: none. As noted in the section about disabled state for buttons (and specifically in the sub-section for anchor elements), this CSS property is not yet standardized and isn’t fully supported in Internet Explorer 10. The anchor-based controls will also still be focusable and operable using the keyboard. You must manually modify these controls by adding tabindex="-1" to prevent them from receiving focus and aria-disabled="disabled" to signal their state to assistive technologies. Cross-browser compatibility While Bootstrap will apply these styles in all browsers, Internet Explorer 11 and below don’t fully support the disabled attribute on a <fieldset>. Use custom JavaScript to disable the fieldset in these browsers. Validation Provide valuable, actionable feedback to your users with HTML5 form validation–available in all our supported browsers. Choose from the browser default validation feedback, or implement custom messages with our built-in classes and starter JavaScript. We are aware that currently the client-side custom validation styles and tooltips are not accessible, since they are not exposed to assistive technologies. While we work on a solution, we’d recommend either using the server-side option or the default browser validation method. Input group validation Input groups have difficulty with validation styles, unfortunately. Our recommendation is to place feedback messages as sibling elements of the .input-group that has .is-{valid|invalid}. Placing feedback messages within input groups breaks the border-radius. See this workaround. How it works Here’s how form validation works with Bootstrap: HTML form validation is applied via CSS’s two pseudo-classes, :invalid and :valid. It applies to <input>, <select>, and <textarea> elements. Bootstrap scopes the :invalid and :valid styles to parent .was-validated class, usually applied to the <form>. Otherwise, any required field without a value shows up as invalid on page load. This way, you may choose when to activate them (typically after form submission is attempted). To reset the appearance of the form (for instance, in the case of dynamic form submissions using AJAX), remove the .was-validated class from the <form> again after submission. As a fallback, .is-invalid and .is-valid classes may be used instead of the pseudo-classes for server side validation. They do not require a .was-validated parent class. Due to constraints in how CSS works, we cannot (at present) apply styles to a <label> that comes before a form control in the DOM without the help of custom JavaScript. All modern browsers support the constraint validation API, a series of JavaScript methods for validating form controls. Feedback messages may utilize the browser defaults (different for each browser, and unstylable via CSS) or our custom feedback styles with additional HTML and CSS. You may provide custom validity messages with setCustomValidity in JavaScript. With that in mind, consider the following demos for our custom form validation styles, optional server side classes, and browser defaults. Custom styles For custom Bootstrap form validation messages, you’ll need to add the novalidate boolean attribute to your <form>. This disables the browser default feedback tooltips, but still provides access to the form validation APIs in JavaScript. Try to submit the form below; our JavaScript will intercept the submit button and relay feedback to you. When attempting to submit, you’ll see the :invalid and :valid styles applied to your form controls. Custom feedback styles apply custom colors, borders, focus styles, and background icons to better communicate feedback. Background icons for <select>s are only available with .custom-select, and not .form-control. Open example on getbootstrap.com <form class="needs-validation" novalidate>
<div class="form-row">
<div class="col-md-6 mb-3">
<label for="validationCustom01">First name</label>
<input type="text" class="form-control" id="validationCustom01" value="Mark" required>
<div class="valid-feedback">
Looks good!
</div>
</div>
<div class="col-md-6 mb-3">
<label for="validationCustom02">Last name</label>
<input type="text" class="form-control" id="validationCustom02" value="Otto" required>
<div class="valid-feedback">
Looks good!
</div>
</div>
</div>
<div class="form-row">
<div class="col-md-6 mb-3">
<label for="validationCustom03">City</label>
<input type="text" class="form-control" id="validationCustom03" required>
<div class="invalid-feedback">
Please provide a valid city.
</div>
</div>
<div class="col-md-3 mb-3">
<label for="validationCustom04">State</label>
<select class="custom-select" id="validationCustom04" required>
<option selected disabled value="">Choose...</option>
<option>...</option>
</select>
<div class="invalid-feedback">
Please select a valid state.
</div>
</div>
<div class="col-md-3 mb-3">
<label for="validationCustom05">Zip</label>
<input type="text" class="form-control" id="validationCustom05" required>
<div class="invalid-feedback">
Please provide a valid zip.
</div>
</div>
</div>
<div class="form-group">
<div class="form-check">
<input class="form-check-input" type="checkbox" value="" id="invalidCheck" required>
<label class="form-check-label" for="invalidCheck">
Agree to terms and conditions
</label>
<div class="invalid-feedback">
You must agree before submitting.
</div>
</div>
</div>
<button class="btn btn-primary" type="submit">Submit form</button>
</form>
<script>
// Example starter JavaScript for disabling form submissions if there are invalid fields
(function() {
'use strict';
window.addEventListener('load', function() {
// Fetch all the forms we want to apply custom Bootstrap validation styles to
var forms = document.getElementsByClassName('needs-validation');
// Loop over them and prevent submission
var validation = Array.prototype.filter.call(forms, function(form) {
form.addEventListener('submit', function(event) {
if (form.checkValidity() === false) {
event.preventDefault();
event.stopPropagation();
}
form.classList.add('was-validated');
}, false);
});
}, false);
})();
</script> Browser defaults Not interested in custom validation feedback messages or writing JavaScript to change form behaviors? All good, you can use the browser defaults. Try submitting the form below. Depending on your browser and OS, you’ll see a slightly different style of feedback. While these feedback styles cannot be styled with CSS, you can still customize the feedback text through JavaScript. Open example on getbootstrap.com <form>
<div class="form-row">
<div class="col-md-6 mb-3">
<label for="validationDefault01">First name</label>
<input type="text" class="form-control" id="validationDefault01" value="Mark" required>
</div>
<div class="col-md-6 mb-3">
<label for="validationDefault02">Last name</label>
<input type="text" class="form-control" id="validationDefault02" value="Otto" required>
</div>
</div>
<div class="form-row">
<div class="col-md-6 mb-3">
<label for="validationDefault03">City</label>
<input type="text" class="form-control" id="validationDefault03" required>
</div>
<div class="col-md-3 mb-3">
<label for="validationDefault04">State</label>
<select class="custom-select" id="validationDefault04" required>
<option selected disabled value="">Choose...</option>
<option>...</option>
</select>
</div>
<div class="col-md-3 mb-3">
<label for="validationDefault05">Zip</label>
<input type="text" class="form-control" id="validationDefault05" required>
</div>
</div>
<div class="form-group">
<div class="form-check">
<input class="form-check-input" type="checkbox" value="" id="invalidCheck2" required>
<label class="form-check-label" for="invalidCheck2">
Agree to terms and conditions
</label>
</div>
</div>
<button class="btn btn-primary" type="submit">Submit form</button>
</form> Server side We recommend using client-side validation, but in case you require server-side validation, you can indicate invalid and valid form fields with .is-invalid and .is-valid. Note that .invalid-feedback is also supported with these classes. For invalid fields, ensure that the invalid feedback/error message is associated with the relevant form field using aria-describedby. This attribute allows more than one id to be referenced, in case the field already points to additional form text. Open example on getbootstrap.com <form>
<div class="form-row">
<div class="col-md-6 mb-3">
<label for="validationServer01">First name</label>
<input type="text" class="form-control is-valid" id="validationServer01" value="Mark" required>
<div class="valid-feedback">
Looks good!
</div>
</div>
<div class="col-md-6 mb-3">
<label for="validationServer02">Last name</label>
<input type="text" class="form-control is-valid" id="validationServer02" value="Otto" required>
<div class="valid-feedback">
Looks good!
</div>
</div>
</div>
<div class="form-row">
<div class="col-md-6 mb-3">
<label for="validationServer03">City</label>
<input type="text" class="form-control is-invalid" id="validationServer03" aria-describedby="validationServer03Feedback" required>
<div id="validationServer03Feedback" class="invalid-feedback">
Please provide a valid city.
</div>
</div>
<div class="col-md-3 mb-3">
<label for="validationServer04">State</label>
<select class="custom-select is-invalid" id="validationServer04" aria-describedby="validationServer04Feedback" required>
<option selected disabled value="">Choose...</option>
<option>...</option>
</select>
<div id="validationServer04Feedback" class="invalid-feedback">
Please select a valid state.
</div>
</div>
<div class="col-md-3 mb-3">
<label for="validationServer05">Zip</label>
<input type="text" class="form-control is-invalid" id="validationServer05" aria-describedby="validationServer05Feedback" required>
<div id="validationServer05Feedback" class="invalid-feedback">
Please provide a valid zip.
</div>
</div>
</div>
<div class="form-group">
<div class="form-check">
<input class="form-check-input is-invalid" type="checkbox" value="" id="invalidCheck3" aria-describedby="invalidCheck3Feedback" required>
<label class="form-check-label" for="invalidCheck3">
Agree to terms and conditions
</label>
<div id="invalidCheck3Feedback" class="invalid-feedback">
You must agree before submitting.
</div>
</div>
</div>
<button class="btn btn-primary" type="submit">Submit form</button>
</form> Supported elements Validation styles are available for the following form controls and components:
<input>s and <textarea>s with .form-control
<select>s with .form-control or .custom-select
.form-checks
.custom-checkboxs and .custom-radios .custom-file Open example on getbootstrap.com <form class="was-validated">
<div class="mb-3">
<label for="validationTextarea">Textarea</label>
<textarea class="form-control is-invalid" id="validationTextarea" placeholder="Required example textarea" required></textarea>
<div class="invalid-feedback">
Please enter a message in the textarea.
</div>
</div>
<div class="custom-control custom-checkbox mb-3">
<input type="checkbox" class="custom-control-input" id="customControlValidation1" required>
<label class="custom-control-label" for="customControlValidation1">Check this custom checkbox</label>
<div class="invalid-feedback">Example invalid feedback text</div>
</div>
<div class="custom-control custom-radio">
<input type="radio" class="custom-control-input" id="customControlValidation2" name="radio-stacked" required>
<label class="custom-control-label" for="customControlValidation2">Toggle this custom radio</label>
</div>
<div class="custom-control custom-radio mb-3">
<input type="radio" class="custom-control-input" id="customControlValidation3" name="radio-stacked" required>
<label class="custom-control-label" for="customControlValidation3">Or toggle this other custom radio</label>
<div class="invalid-feedback">More example invalid feedback text</div>
</div>
<div class="mb-3">
<select class="custom-select" required>
<option value="">Choose...</option>
<option value="1">One</option>
<option value="2">Two</option>
<option value="3">Three</option>
</select>
<div class="invalid-feedback">Example invalid custom select feedback</div>
</div>
<div class="custom-file mb-3">
<input type="file" class="custom-file-input" id="validatedCustomFile" required>
<label class="custom-file-label" for="validatedCustomFile">Choose file...</label>
<div class="invalid-feedback">Example invalid custom file feedback</div>
</div>
<div class="mb-3">
<div class="input-group is-invalid">
<div class="input-group-prepend">
<span class="input-group-text" id="validatedInputGroupPrepend">@</span>
</div>
<input type="text" class="form-control is-invalid" aria-describedby="validatedInputGroupPrepend" required>
</div>
<div class="invalid-feedback">
Example invalid input group feedback
</div>
</div>
<div class="mb-3">
<div class="input-group is-invalid">
<div class="input-group-prepend">
<label class="input-group-text" for="validatedInputGroupSelect">Options</label>
</div>
<select class="custom-select" id="validatedInputGroupSelect" required>
<option value="">Choose...</option>
<option value="1">One</option>
<option value="2">Two</option>
<option value="3">Three</option>
</select>
</div>
<div class="invalid-feedback">
Example invalid input group feedback
</div>
</div>
<div class="input-group is-invalid">
<div class="custom-file">
<input type="file" class="custom-file-input" id="validatedInputGroupCustomFile" required>
<label class="custom-file-label" for="validatedInputGroupCustomFile">Choose file...</label>
</div>
<div class="input-group-append">
<button class="btn btn-outline-secondary" type="button">Button</button>
</div>
</div>
<div class="invalid-feedback">
Example invalid input group feedback
</div>
</form> Tooltips If your form layout allows it, you can swap the .{valid|invalid}-feedback classes for .{valid|invalid}-tooltip classes to display validation feedback in a styled tooltip. Be sure to have a parent with position: relative on it for tooltip positioning. In the example below, our column classes have this already, but your project may require an alternative setup. Open example on getbootstrap.com <form class="needs-validation" novalidate>
<div class="form-row">
<div class="col-md-6 mb-3">
<label for="validationTooltip01">First name</label>
<input type="text" class="form-control" id="validationTooltip01" value="Mark" required>
<div class="valid-tooltip">
Looks good!
</div>
</div>
<div class="col-md-6 mb-3">
<label for="validationTooltip02">Last name</label>
<input type="text" class="form-control" id="validationTooltip02" value="Otto" required>
<div class="valid-tooltip">
Looks good!
</div>
</div>
</div>
<div class="form-row">
<div class="col-md-6 mb-3">
<label for="validationTooltip03">City</label>
<input type="text" class="form-control" id="validationTooltip03" required>
<div class="invalid-tooltip">
Please provide a valid city.
</div>
</div>
<div class="col-md-3 mb-3">
<label for="validationTooltip04">State</label>
<select class="custom-select" id="validationTooltip04" required>
<option selected disabled value="">Choose...</option>
<option>...</option>
</select>
<div class="invalid-tooltip">
Please select a valid state.
</div>
</div>
<div class="col-md-3 mb-3">
<label for="validationTooltip05">Zip</label>
<input type="text" class="form-control" id="validationTooltip05" required>
<div class="invalid-tooltip">
Please provide a valid zip.
</div>
</div>
</div>
<button class="btn btn-primary" type="submit">Submit form</button>
</form> Customizing Validation states can be customized via Sass with the $form-validation-states map. Located in our _variables.scss file, this Sass map is looped over to generate the default valid/invalid validation states. Included is a nested map for customizing each state’s color and icon. While no other states are supported by browsers, those using custom styles can easily add more complex form feedback. Please note that we do not recommend customizing these values without also modifying the form-validation-state mixin. // Sass map from `_variables.scss`
// Override this and recompile your Sass to generate different states
$form-validation-states: map-merge(
(
"valid": (
"color": $form-feedback-valid-color,
"icon": $form-feedback-icon-valid
),
"invalid": (
"color": $form-feedback-invalid-color,
"icon": $form-feedback-icon-invalid
)
),
$form-validation-states
);
// Loop from `_forms.scss`
// Any modifications to the above Sass map will be reflected in your compiled
// CSS via this loop.
@each $state, $data in $form-validation-states {
@include form-validation-state($state, map-get($data, color), map-get($data, icon));
} Input group validation workaround We’re unable to resolve the broken border-radius of input groups with validation due to selector limitations, so manual overrides are required. When you’re using a standard input group and don’t customize the default border radius values, add .rounded-right to the elements with the broken border-radius. <div class="input-group">
<div class="input-group-prepend">
<span class="input-group-text">@</span>
</div>
<input type="text" class="form-control rounded-right" required>
<div class="invalid-feedback">
Please choose a username.
</div>
</div> Open example on getbootstrap.com When you are using a small or large input group or customizing the default border-radius values, add custom CSS to the element with the busted border-radius. /* Change values to match the radius of your form control */
.fix-rounded-right {
border-top-right-radius: .2rem !important;
border-bottom-right-radius: .2rem !important;
} <div class="input-group input-group-sm">
<div class="input-group-prepend">
<span class="input-group-text">@</span>
</div>
<input type="text" class="form-control fix-rounded-right" required>
<div class="invalid-feedback">
Please choose a username.
</div>
</div> Open example on getbootstrap.com Custom forms For even more customization and cross browser consistency, use our completely custom form elements to replace the browser defaults. They’re built on top of semantic and accessible markup, so they’re solid replacements for any default form control. Checkboxes and radios Each checkbox and radio <input> and <label> pairing is wrapped in a <div> to create our custom control. Structurally, this is the same approach as our default .form-check. We use the sibling selector (~) for all our <input> states—like :checked—to properly style our custom form indicator. When combined with the .custom-control-label class, we can also style the text for each item based on the <input>’s state. We hide the default <input> with opacity and use the .custom-control-label to build a new custom form indicator in its place with 8b7c:f320:99b9:690f:4595:cd17:293a:c069ore and 8b7c:f320:99b9:690f:4595:cd17:293a:c069ter. Unfortunately we can’t build a custom one from just the <input> because CSS’s content doesn’t work on that element. In the checked states, we use base64 embedded SVG icons from Open Iconic. This provides us the best control for styling and positioning across browsers and devices. Checkboxes Open example on getbootstrap.com <div class="custom-control custom-checkbox">
<input type="checkbox" class="custom-control-input" id="customCheck1">
<label class="custom-control-label" for="customCheck1">Check this custom checkbox</label>
</div> Custom checkboxes can also utilize the :indeterminate pseudo class when manually set via JavaScript (there is no available HTML attribute for specifying it). Open example on getbootstrap.com If you’re using jQuery, something like this should suffice: $('.your-checkbox').prop('indeterminate', true) Radios Open example on getbootstrap.com <div class="custom-control custom-radio">
<input type="radio" id="customRadio1" name="customRadio" class="custom-control-input">
<label class="custom-control-label" for="customRadio1">Toggle this custom radio</label>
</div>
<div class="custom-control custom-radio">
<input type="radio" id="customRadio2" name="customRadio" class="custom-control-input">
<label class="custom-control-label" for="customRadio2">Or toggle this other custom radio</label>
</div> Inline Open example on getbootstrap.com <div class="custom-control custom-radio custom-control-inline">
<input type="radio" id="customRadioInline1" name="customRadioInline1" class="custom-control-input">
<label class="custom-control-label" for="customRadioInline1">Toggle this custom radio</label>
</div>
<div class="custom-control custom-radio custom-control-inline">
<input type="radio" id="customRadioInline2" name="customRadioInline1" class="custom-control-input">
<label class="custom-control-label" for="customRadioInline2">Or toggle this other custom radio</label>
</div> Disabled Custom checkboxes and radios can also be disabled. Add the disabled boolean attribute to the <input> and the custom indicator and label description will be automatically styled. Open example on getbootstrap.com <div class="custom-control custom-checkbox">
<input type="checkbox" class="custom-control-input" id="customCheckDisabled1" disabled>
<label class="custom-control-label" for="customCheckDisabled1">Check this custom checkbox</label>
</div>
<div class="custom-control custom-radio">
<input type="radio" name="radioDisabled" id="customRadioDisabled2" class="custom-control-input" disabled>
<label class="custom-control-label" for="customRadioDisabled2">Toggle this custom radio</label>
</div> Switches A switch has the markup of a custom checkbox but uses the .custom-switch class to render a toggle switch. Switches also support the disabled attribute. Open example on getbootstrap.com <div class="custom-control custom-switch">
<input type="checkbox" class="custom-control-input" id="customSwitch1">
<label class="custom-control-label" for="customSwitch1">Toggle this switch element</label>
</div>
<div class="custom-control custom-switch">
<input type="checkbox" class="custom-control-input" disabled id="customSwitch2">
<label class="custom-control-label" for="customSwitch2">Disabled switch element</label>
</div> Select menu Custom <select> menus need only a custom class, .custom-select to trigger the custom styles. Custom styles are limited to the <select>’s initial appearance and cannot modify the <option>s due to browser limitations. Open example on getbootstrap.com <select class="custom-select">
<option selected>Open this select menu</option>
<option value="1">One</option>
<option value="2">Two</option>
<option value="3">Three</option>
</select> You may also choose from small and large custom selects to match our similarly sized text inputs. Open example on getbootstrap.com <select class="custom-select custom-select-lg mb-3">
<option selected>Open this select menu</option>
<option value="1">One</option>
<option value="2">Two</option>
<option value="3">Three</option>
</select>
<select class="custom-select custom-select-sm">
<option selected>Open this select menu</option>
<option value="1">One</option>
<option value="2">Two</option>
<option value="3">Three</option>
</select> The multiple attribute is also supported: Open example on getbootstrap.com <select class="custom-select" multiple>
<option selected>Open this select menu</option>
<option value="1">One</option>
<option value="2">Two</option>
<option value="3">Three</option>
</select> As is the size attribute: Open example on getbootstrap.com <select class="custom-select" size="3">
<option selected>Open this select menu</option>
<option value="1">One</option>
<option value="2">Two</option>
<option value="3">Three</option>
</select> Range Create custom <input type="range"> controls with .custom-range. The track (the background) and thumb (the value) are both styled to appear the same across browsers. As only IE and Firefox support “filling” their track from the left or right of the thumb as a means to visually indicate progress, we do not currently support it. Open example on getbootstrap.com <label for="customRange1">Example range</label>
<input type="range" class="custom-range" id="customRange1"> Range inputs have implicit values for min and max—0 and 100, respectively. You may specify new values for those using the min and max attributes. Open example on getbootstrap.com <label for="customRange2">Example range</label>
<input type="range" class="custom-range" min="0" max="5" id="customRange2"> By default, range inputs “snap” to integer values. To change this, you can specify a step value. In the example below, we double the number of steps by using step="0.5". Open example on getbootstrap.com <label for="customRange3">Example range</label>
<input type="range" class="custom-range" min="0" max="5" step="0.5" id="customRange3"> File browser The recommended plugin to animate custom file input: bs-custom-file-input, that’s what we are using currently here in our docs. The file input is the most gnarly of the bunch and requires additional JavaScript if you’d like to hook them up with functional Choose file… and selected file name text. Open example on getbootstrap.com <div class="custom-file">
<input type="file" class="custom-file-input" id="customFile">
<label class="custom-file-label" for="customFile">Choose file</label>
</div> We hide the default file <input> via opacity and instead style the <label>. The button is generated and positioned with 8b7c:f320:99b9:690f:4595:cd17:293a:c069ter. Lastly, we declare a width and height on the <input> for proper spacing for surrounding content. Translating or customizing the strings with SCSS The :lang() pseudo-class is used to allow for translation of the “Browse” text into other languages. Override or add entries to the $custom-file-text Sass variable with the relevant language tag and localized strings. The English strings can be customized the same way. For example, here’s how one might add a Spanish translation (Spanish’s language code is es): $custom-file-text: (
en: "Browse",
es: "Elegir"
); Here’s lang(es) in action on the custom file input for a Spanish translation: Open example on getbootstrap.com <div class="custom-file">
<input type="file" class="custom-file-input" id="customFileLang" lang="es">
<label class="custom-file-label" for="customFileLang">Seleccionar Archivo</label>
</div> You’ll need to set the language of your document (or subtree thereof) correctly in order for the correct text to be shown. This can be done using the lang attribute on the <html> element or the Content-Language HTTP header, among other methods. Translating or customizing the strings with HTML Bootstrap also provides a way to translate the “Browse” text in HTML with the data-browse attribute which can be added to the custom input label (example in Dutch): Open example on getbootstrap.com <div class="custom-file">
<input type="file" class="custom-file-input" id="customFileLangHTML">
<label class="custom-file-label" for="customFileLangHTML" data-browse="Bestand kiezen">Voeg je document toe</label>
</div>
© 2011–2020 Twitter, Inc. |
SeeInOrder class SeeInOrder extends Constraint (View source) Properties protected string $content The string under validation. protected string $failedValue The last value that failed to pass validation. Methods void __construct(string $content) Create a new constraint instance. bool matches(array $values) Determine if the rule passes validation. string failureDescription(array $values) Get the description of the failure. string toString() Get a string representation of the object. Details void
__construct(string $content)
Create a new constraint instance. Parameters string $content Return Value void bool
matches(array $values)
Determine if the rule passes validation. Parameters array $values Return Value bool string
failureDescription(array $values)
Get the description of the failure. Parameters array $values Return Value string string
toString()
Get a string representation of the object. Return Value string
|
protected property QueueFactory8b7c:f320:99b9:690f:4595:cd17:293a:c069$queues Instantiated queues, keyed by name. Type: array File
core/lib/Drupal/Core/Queue/QueueFactory.php, line 21 Class
QueueFactory Defines the queue factory. Namespace Drupal\Core\Queue Code protected $queues = array();
|
Symbol.toStringTag
The Symbol.toStringTag well-known symbol is a string valued property that is used in the creation of the default string description of an object. It is accessed internally by the Object.prototype.toString() method.
Try it
Property attributes of Symbol.toStringTag
Writable no Enumerable no Configurable no
Examples
Default tags
Object.prototype.toString.call('foo'); // "[object String]"
Object.prototype.toString.call([1, 2]); // "[object Array]"
Object.prototype.toString.call(3); // "[object Number]"
Object.prototype.toString.call(true); // "[object Boolean]"
Object.prototype.toString.call(undefined); // "[object Undefined]"
Object.prototype.toString.call(null); // "[object Null]"
// ... and more
Built-in toStringTag symbols
Object.prototype.toString.call(new Map()); // "[object Map]"
Object.prototype.toString.call(function* () {}); // "[object GeneratorFunction]"
Object.prototype.toString.call(Promise.resolve()); // "[object Promise]"
// ... and more
Custom classes default to object tag
When creating your own class, JavaScript defaults to the "Object" tag: class ValidatorClass {}
Object.prototype.toString.call(new ValidatorClass()); // "[object Object]"
Custom tag with toStringTag
Now, with the help of toStringTag, you are able to set your own custom tag: class ValidatorClass {
get [Symbol.toStringTag]() {
return 'Validator';
}
}
Object.prototype.toString.call(new ValidatorClass()); // "[object Validator]"
toStringTag available on all DOM prototype objects
Due to a WebIDL spec change in mid-2020, browsers are adding a Symbol.toStringTag property to all DOM prototype objects. For example, to access the Symbol.toStringTag property on HTMLButtonElement: const test = document.createElement('button');
test.toString(); // Returns [object HTMLButtonElement]
test[Symbol.toStringTag]; // Returns HTMLButtonElement
Specifications
Specification
ECMAScript Language Specification # sec-symbol.tostringtag
Browser compatibility
Desktop
Mobile
Server
Chrome
Edge
Firefox
Internet Explorer
Opera
Safari
WebView Android
Chrome Android
Firefox for Android
Opera Android
Safari on IOS
Samsung Internet
Deno
Node.js
toStringTag
49
15
51
No
36
10
49
49
51
36
10
5.0
1.0
6.0.0
4.0.0
dom_objects
50
79
78
No
37
14
50
50
79
37
14
5.0
1.0
No
See also
Polyfill of Symbol.toStringTag in core-js Object.prototype.toString()
Found a problem with this page?
Edit on GitHub
Source on GitHub
Report a problem with this content on GitHub
Want to fix the problem yourself? See our Contribution guide.
Last modified: Aug 5, 2022, by MDN contributors
|
community.aws.s3_bucket_notification – Creates, updates or deletes S3 Bucket notification for lambda Note This plugin is part of the community.aws collection (version 1.3.0). To install it use: ansible-galaxy collection install community.aws. To use it in a playbook, specify: community.aws.s3_bucket_notification. New in version 1.0.0: of community.aws Synopsis Requirements Parameters Notes Examples Return Values Synopsis This module allows the management of AWS Lambda function bucket event mappings via the Ansible framework. Use module community.aws.lambda to manage the lambda function itself, community.aws.lambda_alias to manage function aliases and community.aws.lambda_policy to modify lambda permissions. Requirements The below requirements are needed on the host that executes this module. boto boto3 python >= 2.6 Parameters Parameter Choices/Defaults Comments aws_access_key string AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used. If profile is set this parameter is ignored. Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.
aliases: ec2_access_key, access_key aws_ca_bundle path The location of a CA Bundle to use when validating SSL certificates. Only used for boto3 based modules. Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally. aws_config dictionary A dictionary to modify the botocore configuration. Parameters can be found at https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config. Only the 'user_agent' key is used for boto modules. See http://boto.cloudhackers.com/en/latest/boto_config_tut.html#boto for more boto configuration. aws_secret_key string AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used. If profile is set this parameter is ignored. Passing the aws_secret_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.
aliases: ec2_secret_key, secret_key bucket_name string / required S3 bucket name. debug_botocore_endpoint_logs boolean
Choices:
no ← yes Use a botocore.endpoint logger to parse the unique (rather than total) "resource:action" API calls made during a task, outputing the set to the resource_actions key in the task results. Use the aws_resource_action callback to output to total list made during a playbook. The ANSIBLE_DEBUG_BOTOCORE_LOGS environment variable may also be used. ec2_url string Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
aliases: aws_endpoint_url, endpoint_url event_name string / required Unique name for event notification on bucket. events list / elements=string
Choices: s3:ObjectCreated:* s3:ObjectCreated:Put s3:ObjectCreated:Post s3:ObjectCreated:Copy s3:ObjectCreated:CompleteMultipartUpload s3:ObjectRemoved:* s3:ObjectRemoved:Delete s3:ObjectRemoved:DeleteMarkerCreated s3:ObjectRestore:Post s3:ObjectRestore:Completed s3:ReducedRedundancyLostObject Events that you want to be triggering notifications. You can select multiple events to send to the same destination, you can set up different events to send to different destinations, and you can set up a prefix or suffix for an event. However, for each bucket, individual events cannot have multiple configurations with overlapping prefixes or suffixes that could match the same object key. Required when state=present. lambda_alias string Name of the Lambda function alias. Mutually exclusive with lambda_version. lambda_function_arn string The ARN of the lambda function.
aliases: function_arn lambda_version integer Version of the Lambda function. Mutually exclusive with lambda_alias. prefix string Optional prefix to limit the notifications to objects with keys that start with matching characters. profile string Uses a boto profile. Only works with boto >= 2.24.0. Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated.
aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01.
aliases: aws_profile region string The AWS region to use. If not specified then the value of the AWS_REGION or EC2_REGION environment variable, if any, is used. See http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region
aliases: aws_region, ec2_region security_token string AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used. If profile is set this parameter is ignored. Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.
aliases: aws_security_token, access_token state string
Choices:
present ← absent Describes the desired state. suffix string Optional suffix to limit the notifications to objects with keys that end with matching characters. validate_certs boolean
Choices: no
yes ← When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0. Notes Note This module heavily depends on community.aws.lambda_policy as you need to allow lambda:InvokeFunction permission for your lambda function. If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence AWS_URL or EC2_URL, AWS_PROFILE or AWS_DEFAULT_PROFILE, AWS_ACCESS_KEY_ID or AWS_ACCESS_KEY or EC2_ACCESS_KEY, AWS_SECRET_ACCESS_KEY or AWS_SECRET_KEY or EC2_SECRET_KEY, AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN, AWS_REGION or EC2_REGION, AWS_CA_BUNDLE
Ansible uses the boto configuration file (typically ~/.boto) if no credentials are provided. See https://boto.readthedocs.io/en/latest/boto_config_tut.html
AWS_REGION or EC2_REGION can be typically be used to specify the AWS region, when required, but this can also be configured in the boto config file Examples ---
# Example that creates a lambda event notification for a bucket
- name: Process jpg image
community.aws.s3_bucket_notification:
state: present
event_name: on_file_add_or_remove
bucket_name: test-bucket
function_name: arn:aws:lambda:us-east-2:526810320200:function:test-lambda
events: ["s3:ObjectCreated:*", "s3:ObjectRemoved:*"]
prefix: images/
suffix: .jpg
Return Values Common return values are documented here, the following are the fields unique to this module: Key Returned Description notification_configuration list / elements=string success list of currently applied notifications Authors XLAB d.o.o. (@xlab-si) Aljaz Kosir (@aljazkosir) Miha Plesko (@miha-plesko)
© 2012–2018 Michael DeHaan |
Class InetAddressResolver.LookupPolicy
java.lang.Object java.net.spi.InetAddressResolver.LookupPolicy Enclosing interface: InetAddressResolver public static final class InetAddressResolver.LookupPolicy extends Object A LookupPolicy object describes characteristics that can be applied to a lookup operation. In particular, it is used to specify the ordering and which filtering should be performed when looking up host addresses. The default platform-wide lookup policy is constructed by consulting System Properties which affect how IPv4 and IPv6 addresses are returned.
Since: 18 Field Summary
Modifier and Type
Field
Description
static final int
IPV4
Characteristic value signifying if IPv4 addresses need to be queried during lookup.
static final int
IPV4_FIRST
Characteristic value signifying if IPv4 addresses should be returned first by InetAddressResolver.
static final int
IPV6
Characteristic value signifying if IPv6 addresses need to be queried during lookup.
static final int
IPV6_FIRST
Characteristic value signifying if IPv6 addresses should be returned first by InetAddressResolver.
Method Summary
Modifier and Type
Method
Description
int
characteristics()
Returns the set of characteristics of this lookup policy.
static InetAddressResolver.LookupPolicy
of(int characteristics)
This factory method creates a LookupPolicy instance with the given characteristics value.
Methods declared in class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Field Details IPV4 @Native public static final int IPV4 Characteristic value signifying if IPv4 addresses need to be queried during lookup. See Also: Constant Field Values IPV6 @Native public static final int IPV6 Characteristic value signifying if IPv6 addresses need to be queried during lookup. See Also: Constant Field Values IPV4_FIRST @Native public static final int IPV4_FIRST Characteristic value signifying if IPv4 addresses should be returned first by InetAddressResolver. See Also: Constant Field Values IPV6_FIRST @Native public static final int IPV6_FIRST Characteristic value signifying if IPv6 addresses should be returned first by InetAddressResolver. See Also: Constant Field Values Method Details of public static InetAddressResolver.LookupPolicy of(int characteristics) This factory method creates a LookupPolicy instance with the given characteristics value. The characteristics value is an integer bit mask which defines parameters of a forward lookup operation. These parameters define at least:
the family type of the returned addresses the order in which a resolver implementation should return its results To request addresses of specific family types the following bit masks can be combined:
IPV4: to request IPv4 addresses
IPV6: to request IPv6 addresses It is an error if neither IPV4 or IPV6 are set. To request a specific ordering of the results:
IPV4_FIRST: return IPv4 addresses before any IPv6 address
IPV6_FIRST: return IPv6 addresses before any IPv4 address If neither IPV4_FIRST or IPV6_FIRST are set it implies "system" order of addresses. It is an error to request both IPV4_FIRST and IPV6_FIRST. Parameters:
characteristics - a value which represents the set of lookup characteristics Returns: an instance of InetAddressResolver.LookupPolicy
Throws:
IllegalArgumentException - if an illegal characteristics bit mask is provided See Also: InetAddressResolver.lookupByName(String, LookupPolicy) characteristics public int characteristics() Returns the set of characteristics of this lookup policy. Returns: a characteristics value See Also: InetAddressResolver.lookupByName(String, LookupPolicy)
|
sparseVector-class Sparse Vector Classes Description Sparse Vector Classes: The virtual mother class "sparseVector" has the five actual daughter classes "dsparseVector", "isparseVector", "lsparseVector", "nsparseVector", and "zsparseVector", where we've mainly implemented methods for the d*, l* and n* ones. Slots
length:
class "numeric" - the length of the sparse vector. Note that "numeric" can be considerably larger than the maximal "integer", .Machine$integer.max, on purpose.
i:
class "numeric" - the (1-based) indices of the non-zero entries. Must not be NA and strictly sorted increasingly. Note that "integer" is “part of” "numeric", and can (and often will) be used for non-huge sparseVectors.
x:
(for all but "nsparseVector"): the non-zero entries. This is of class "numeric" for class "dsparseVector", "logical" for class "lsparseVector", etc. Note that "nsparseVector"s have no x slot. Further, mainly for ease of method definitions, we've defined the class union (see setClassUnion) of all sparse vector classes which have an x slot, as class "xsparseVector". Methods length
signature(x = "sparseVector"): simply extracts the length slot. show
signature(object = "sparseVector"): The show method for sparse vectors prints “structural” zeroes as "." using the non-exported prSpVector function which allows further customization such as replacing "." by " " (blank). Note that options(max.print) will influence how many entries of large sparse vectors are [email protected]. as.vector
signature(x = "sparseVector", mode = "character") coerces sparse vectors to “regular”, i.e., atomic vectors. This is the same as as(x, "vector"). as
..: see coerce below coerce
signature(from = "sparseVector", to = "sparseMatrix"), and coerce
signature(from = "sparseMatrix", to = "sparseVector"), etc: coercions to and from sparse matrices (sparseMatrix) are provided and work analogously as in standard R, i.e., a vector is coerced to a 1-column matrix. dim<-
signature(x = "sparseVector", value = "integer") coerces a sparse vector to a sparse Matrix, i.e., an object inheriting from sparseMatrix, of the appropriate dimension. head
signature(x = "sparseVector"): as with R's (package util) head, head(x,n) (for n >= 1) is equivalent to x[1:n], but here can be much more efficient, see the example. tail
signature(x = "sparseVector"): analogous to head, see above. toeplitz
signature(x = "sparseVector"): as toeplitz(x), produce the n \times n Toeplitz matrix from x, where n = length(x). rep
signature(x = "sparseVector") repeat x, with the same argument list (x, times, length.out, each,
...) as the default method for rep(). which
signature(x = "nsparseVector") and which
signature(x = "lsparseVector") return the indices of the non-zero entries (which is trivial for sparse vectors). Ops
signature(e1 = "sparseVector", e2 = "*"): define arithmetic, compare and logic operations, (see Ops). Summary
signature(x = "sparseVector"): define all the Summary methods. [
signature(x = "atomicVector", i = ...): not only can you subset (aka “index into”) sparseVectors x[i] using sparseVectors i, but we also support efficient subsetting of traditional vectors x by logical sparse vectors (i.e., i of class "nsparseVector" or "lsparseVector"). is.na, is.finite, is.infinite
(x = "sparseVector"), and is.na, is.finite, is.infinite
(x = "nsparseVector"): return logical or "nsparseVector" of the same length as x, indicating if/where x is NA (or NaN), finite or infinite, entirely analogously to the corresponding base R functions. c.sparseVector() is an S3 method for all "sparseVector"s, but automatic dispatch only happens for the first argument, so it is useful also as regular R function, see the examples. See Also sparseVector() for friendly construction of sparse vectors (apart from as(*, "sparseVector")). Examples
getClass("sparseVector")
getClass("dsparseVector")
getClass("xsparseVector")# those with an 'x' slot
sx <- c(0,0,3, 3.2, 0,0,0,-3:1,0,0,2,0,0,5,0,0)
(ss <- as(sx, "sparseVector"))
ix <- as.integer(round(sx))
(is <- as(ix, "sparseVector")) ## an "isparseVector" (!)
(ns <- sparseVector(i= c(7, 3, 2), length = 10)) # "nsparseVector"
## rep() works too:
(ri <- rep(is, length.out= 25))
## Using `dim<-` as in base R :
r <- ss
dim(r) <- c(4,5) # becomes a sparse Matrix:
r
## or coercion (as as.matrix() in base R):
as(ss, "Matrix")
stopifnot(all(ss == print(as(ss, "CsparseMatrix"))))
## currently has "non-structural" FALSE -- printing as ":"
(lis <- is & FALSE)
(nn <- is[is == 0]) # all "structural" FALSE
## NA-case
sN <- sx; sN[4] <- NA
(svN <- as(sN, "sparseVector"))
v <- as(c(0,0,3, 3.2, rep(0,9),-3,0,-1, rep(0,20),5,0),
"sparseVector")
v <- rep(rep(v, 50), 5000)
set.seed(1); v[sample(v@i, 1e6)] <- 0
str(v)
system.time(for(i in 1:4) hv <- head(v, 1e6))
## user system elapsed
## 0.033 0.000 0.032
system.time(for(i in 1:4) h2 <- v[1:1e6])
## user system elapsed
## 1.317 0.000 1.319
stopifnot(identical(hv, h2),
identical(is | FALSE, is != 0),
validObject(svN), validObject(lis), as.logical(is.na(svN[4])),
identical(is^2 > 0, is & TRUE),
all(!lis), !any(lis), length(nn@i) == 0, !any(nn), all(!nn),
sum(lis) == 0, !prod(lis), range(lis) == c(0,0))
## create and use the t(.) method:
t(x20 <- sparseVector(c(9,3:1), i=c(1:2,4,7), length=20))
(T20 <- toeplitz(x20))
stopifnot(is(T20, "symmetricMatrix"), is(T20, "sparseMatrix"),
identical(unname(as.matrix(T20)),
toeplitz(as.vector(x20))))
## c() method for "sparseVector" - also available as regular function
(c1 <- c(x20, 0,0,0, -10*x20))
(c2 <- c(ns, is, FALSE))
(c3 <- c(ns, !ns, TRUE, NA, FALSE))
(c4 <- c(ns, rev(ns)))
## here, c() would produce a list {not dispatching to c.sparseVector()}
(c5 <- c.sparseVector(0,0, x20))
## checking (consistency)
.v <- as.vector
.s <- function(v) as(v, "sparseVector")
stopifnot(
all.equal(c1, .s(c(.v(x20), 0,0,0, -10*.v(x20))), tol=0),
all.equal(c2, .s(c(.v(ns), .v(is), FALSE)), tol=0),
all.equal(c3, .s(c(.v(ns), !.v(ns), TRUE, NA, FALSE)), tol=0),
all.equal(c4, .s(c(.v(ns), rev(.v(ns)))), tol=0),
all.equal(c5, .s(c(0,0, .v(x20))), tol=0)
)
Copyright ( |
QPrinterInfo Class The QPrinterInfo class gives access to information about existing printers. More...
Header:
#include <QPrinterInfo>
qmake:
QT += printsupport
Since:
Qt 4.4
List of all members, including inherited members Obsolete members Public Functions
QPrinterInfo()
QPrinterInfo(const QPrinterInfo &other)
QPrinterInfo(const QPrinter &printer)
~QPrinterInfo()
QPrinter8b7c:f320:99b9:690f:4595:cd17:293a:c069uplexMode
defaultDuplexMode() const
QPageSize
defaultPageSize() const
QString
description() const
bool
isDefault() const
bool
isNull() const
bool
isRemote() const
QString
location() const
QString
makeAndModel() const
QPageSize
maximumPhysicalPageSize() const
QPageSize
minimumPhysicalPageSize() const
QString
printerName() const
QPrinter8b7c:f320:99b9:690f:4595:cd17:293a:c069PrinterState
state() const
QList<QPrinter8b7c:f320:99b9:690f:4595:cd17:293a:c069uplexMode>
supportedDuplexModes() const
QList<QPageSize>
supportedPageSizes() const
QList<int>
supportedResolutions() const
bool
supportsCustomPageSizes() const
QPrinterInfo &
operator=(const QPrinterInfo &other)
Static Public Members
QStringList
availablePrinterNames()
QList<QPrinterInfo>
availablePrinters()
QPrinterInfo
defaultPrinter()
QString
defaultPrinterName()
QPrinterInfo
printerInfo(const QString &printerName)
Detailed Description The QPrinterInfo class gives access to information about existing printers. Use the static functions to generate a list of QPrinterInfo objects. Each QPrinterInfo object in the list represents a single printer and can be queried for name, supported paper sizes, and whether or not it is the default printer. Member Function Documentation
QPrinterInfo8b7c:f320:99b9:690f:4595:cd17:293a:c069QPrinterInfo() Constructs an empty QPrinterInfo object. See also isNull().
QPrinterInfo8b7c:f320:99b9:690f:4595:cd17:293a:c069QPrinterInfo(const QPrinterInfo &other) Constructs a copy of other.
QPrinterInfo8b7c:f320:99b9:690f:4595:cd17:293a:c069QPrinterInfo(const QPrinter &printer) Constructs a QPrinterInfo object from printer.
QPrinterInfo8b7c:f320:99b9:690f:4595:cd17:293a:c069~QPrinterInfo() Destroys the QPrinterInfo object. References to the values in the object become invalid.
[static] QStringList QPrinterInfo8b7c:f320:99b9:690f:4595:cd17:293a:c069vailablePrinterNames() Returns a list of all the available Printer Names on this system. It is recommended to use this instead of availablePrinters() as it will be faster on most systems. Note that the list may become outdated if changes are made on the local system or remote print server. Only instantiate required QPrinterInfo instances when needed, and always check for validity before calling. This function was introduced in Qt 5.3.
[static] QList<QPrinterInfo> QPrinterInfo8b7c:f320:99b9:690f:4595:cd17:293a:c069vailablePrinters() Returns a list of QPrinterInfo objects for all the available printers on this system. It is NOT recommended to use this as creating each printer instance may take a long time, especially if there are remote networked printers, and retained instances may become outdated if changes are made on the local system or remote print server. Use availablePrinterNames() instead and only instantiate printer instances as you need them.
QPrinter8b7c:f320:99b9:690f:4595:cd17:293a:c069uplexMode QPrinterInfo8b7c:f320:99b9:690f:4595:cd17:293a:c069ultDuplexMode() const Returns the default duplex mode of this printer. This function was introduced in Qt 5.4.
QPageSize QPrinterInfo8b7c:f320:99b9:690f:4595:cd17:293a:c069ultPageSize() const Returns the current default Page Size for this printer. This function was introduced in Qt 5.3.
[static] QPrinterInfo QPrinterInfo8b7c:f320:99b9:690f:4595:cd17:293a:c069ultPrinter() Returns the default printer on the system. The return value should be checked using isNull() before being used, in case there is no default printer. On some systems it is possible for there to be available printers but none of them set to be the default printer. See also isNull(), isDefault(), and availablePrinters().
[static] QString QPrinterInfo8b7c:f320:99b9:690f:4595:cd17:293a:c069ultPrinterName() Returns the current default printer name. This function was introduced in Qt 5.3.
QString QPrinterInfo8b7c:f320:99b9:690f:4595:cd17:293a:c069scription() const Returns the human-readable description of the printer. This function was introduced in Qt 5.0. See also QPrinterInfo8b7c:f320:99b9:690f:4595:cd17:293a:c069printerName().
bool QPrinterInfo8b7c:f320:99b9:690f:4595:cd17:293a:c069isDefault() const Returns whether this printer is currently the default printer.
bool QPrinterInfo8b7c:f320:99b9:690f:4595:cd17:293a:c069isNull() const Returns whether this QPrinterInfo object holds a printer definition. An empty QPrinterInfo object could result for example from calling defaultPrinter() when there are no printers on the system.
bool QPrinterInfo8b7c:f320:99b9:690f:4595:cd17:293a:c069isRemote() const Returns whether this printer is a remote network printer. This function was introduced in Qt 5.3.
QString QPrinterInfo8b7c:f320:99b9:690f:4595:cd17:293a:c069location() const Returns the human-readable location of the printer. This function was introduced in Qt 5.0.
QString QPrinterInfo8b7c:f320:99b9:690f:4595:cd17:293a:c069makeAndModel() const Returns the human-readable make and model of the printer. This function was introduced in Qt 5.0.
QPageSize QPrinterInfo8b7c:f320:99b9:690f:4595:cd17:293a:c069maximumPhysicalPageSize() const Returns the maximum physical page size supported by this printer. This function was introduced in Qt 5.3. See also minimumPhysicalPageSize().
QPageSize QPrinterInfo8b7c:f320:99b9:690f:4595:cd17:293a:c069minimumPhysicalPageSize() const Returns the minimum physical page size supported by this printer. This function was introduced in Qt 5.3. See also maximumPhysicalPageSize().
[static] QPrinterInfo QPrinterInfo8b7c:f320:99b9:690f:4595:cd17:293a:c069printerInfo(const QString &printerName) Returns the printer printerName. The return value should be checked using isNull() before being used, in case the named printer does not exist. This function was introduced in Qt 5.0. See also isNull().
QString QPrinterInfo8b7c:f320:99b9:690f:4595:cd17:293a:c069printerName() const Returns the name of the printer. This is a unique id to identify the printer and may not be human-readable. See also QPrinterInfo8b7c:f320:99b9:690f:4595:cd17:293a:c069scription() and QPrinter8b7c:f320:99b9:690f:4595:cd17:293a:c069setPrinterName().
QPrinter8b7c:f320:99b9:690f:4595:cd17:293a:c069PrinterState QPrinterInfo8b7c:f320:99b9:690f:4595:cd17:293a:c069state() const Returns the current state of this printer. This state may not always be accurate, depending on the platform, printer driver, or printer itself. This function was introduced in Qt 5.3.
QList<QPrinter8b7c:f320:99b9:690f:4595:cd17:293a:c069uplexMode> QPrinterInfo8b7c:f320:99b9:690f:4595:cd17:293a:c069supportedDuplexModes() const Returns a list of duplex modes supported by this printer. This function was introduced in Qt 5.4.
QList<QPageSize> QPrinterInfo8b7c:f320:99b9:690f:4595:cd17:293a:c069supportedPageSizes() const Returns a list of Page Sizes supported by this printer. This function was introduced in Qt 5.3.
QList<int> QPrinterInfo8b7c:f320:99b9:690f:4595:cd17:293a:c069supportedResolutions() const Returns a list of resolutions supported by this printer. This function was introduced in Qt 5.3.
bool QPrinterInfo8b7c:f320:99b9:690f:4595:cd17:293a:c069supportsCustomPageSizes() const Returns whether this printer supports custom page sizes. This function was introduced in Qt 5.3.
QPrinterInfo &QPrinterInfo8b7c:f320:99b9:690f:4595:cd17:293a:c069operator=(const QPrinterInfo &other) Sets the QPrinterInfo object to be equal to other.
|
protected property AjaxRespons8b7c:f320:99b9:690f:4595:cd17:293a:c069$commands The array of ajax commands. Type: array File
core/lib/Drupal/Core/Ajax/AjaxResponse.php, line 24 Class
AjaxResponse JSON response object for AJAX requests. Namespace Drupal\Core\Ajax Code protected $commands = array();
|
Stored Routines Stored procedures and stored functions.
Title
Description
Stored Procedures
Routine invoked with a CALL statement.
Stored Functions
Defined functions for use with SQL statements.
Stored Routine Statements
SQL statements related to creating and using stored routines.
Binary Logging of Stored Routines
Stored routines require extra consideration when binary logging.
Stored Routine Limitations
SQL statements not permitted in stored programs.
Stored Routine Privileges
Privileges associated with stored functions and stored procedures.
Content reproduced on this site is the property of its respective owners, and this content is not reviewed in advance by MariaDB. The views, information and opinions expressed by this content do not necessarily represent those of MariaDB or any other party.
|
CONNECT Table Types The main feature of CONNECT is to give MariaDB the ability to handle tables from many sources, native files, other DBMS’s tables, or special “virtual” tables. Moreover, for all tables physically represented by data files, CONNECT recognizes many different file formats, described below but not limited in the future to this list, because more can be easily added to it on demand (OEM tables).
Note: You can download a PDF version of the CONNECT documentation (1.7.0003).
Title
Description
CONNECT Table Types Overview
CONNECT can handle many table formats.
Inward and Outward Tables
The two broad categories of CONNECT tables.
CONNECT Table Types - Data Files
CONNECT plain DOS or UNIX data files.
CONNECT Zipped File Tables
When the table file or files are compressed in one or several zip files.
CONNECT DOS and FIX Table Types
CONNECT tables based on text files
CONNECT DBF Table Type
CONNECT dBASE III or IV tables.
CONNECT BIN Table Type
CONNECT binary files in which each row is a logical record of fixed length
CONNECT VEC Table Type
CONNECT binary files organized in vectors
CONNECT CSV and FMT Table Types
Variable length CONNECT data files.
CONNECT - NoSQL Table Types
Based on files that do not match the relational format but often represent hierarchical data.
CONNECT - Files Retrieved Using Rest Queries
JSON, XML and CSV data files can be retrieved as results from REST queries.
CONNECT JSON Table Type
JSON (JavaScript Object Notation) is a widely-used lightweight data-interchange format.
CONNECT XML Table Type
CONNECT XML files
CONNECT INI Table Type
CONNECT INI Windows configuration or initialization files.
CONNECT - External Table Types
Access tables belonging to the current or another server.
CONNECT ODBC Table Type: Accessing Tables From Another DBMS
CONNECT Table Types - ODBC Table Type: Accessing Tables from other DBMS
CONNECT JDBC Table Type: Accessing Tables from Another DBMS
Using JDBC to access other tables.
CONNECT MONGO Table Type: Accessing Collections from MongoDB
Used to directly access MongoDB collections as tables.
CONNECT MYSQL Table Type: Accessing MySQL/MariaDB Tables
Accessing a MySQL or MariaDB table or view
CONNECT PROXY Table Type
Tables that access and read the data of another table or view
CONNECT XCOL Table Type
Based on another table/view, used when object tables have a column that contains a list of values
CONNECT OCCUR Table Type
Extension to the PROXY type when referring to a table/view having several c...
CONNECT PIVOT Table Type
Transform the result of another table into another table along “pivot” and "fact" columns.
CONNECT TBL Table Type: Table List
Define a table as a list of tables of any engine and type.
CONNECT - Using the TBL and MYSQL Table Types Together
Used together, the TBL and MYSQL types lift all the limitations of the FEDERATED and MERGE engines
CONNECT Table Types - Special "Virtual" Tables
VIR, WMI and MAC special table types
CONNECT Table Types - VIR
VIR virtual type for CONNECT
CONNECT Table Types - OEM: Implemented in an External LIB
CONNECT OEM table types are implemented in an external library.
CONNECT Table Types - Catalog Tables
Catalog tables return information about another table or data source
Content reproduced on this site is the property of its respective owners, and this content is not reviewed in advance by MariaDB. The views, information and opinions expressed by this content do not necessarily represent those of MariaDB or any other party.
|
apply_filters( 'auth_cookie', string $cookie, int $user_id, int $expiration, string $scheme, string $token ) Filters the authentication cookie. Parameters $cookie string Authentication cookie. $user_id int User ID. $expiration int The time the cookie expires as a UNIX timestamp. $scheme string Cookie scheme used. Accepts 'auth', 'secure_auth', or 'logged_in'. $token string User's session token used. Source File: wp-includes/pluggable.php. View all references return apply_filters( 'auth_cookie', $cookie, $user_id, $expiration, $scheme, $token );
Related Used By Used By Description wp_generate_auth_cookie() wp-includes/pluggable.php Generates authentication cookie contents.
Changelog Version Description 4.0.0 The $token parameter was added. 2.5.0 Introduced.
|
function field_view_value field_view_value($entity_type, $entity, $field_name, $item, $display = array(), $langcode = NULL) Returns a renderable array for a single field value. Parameters $entity_type: The type of $entity; e.g., 'node' or 'user'. $entity: The entity containing the field to display. Must at least contain the id key and the field data to display. $field_name: The name of the field to display. $item: The field value to display, as found in $entity->field_name[$langcode][$delta]. $display: Can be either the name of a view mode, or an array of display settings. See field_view_field() for more information. $langcode: (Optional) The language of the value in $item. If not provided, the current language will be assumed. Return value A renderable array for the field value. Related topics Field API Attach custom data fields to Drupal entities. File
modules/field/field.module, line 796 Attach custom data fields to Drupal entities. Code function field_view_value($entity_type, $entity, $field_name, $item, $display = array(), $langcode = NULL) {
$output = array();
if ($field = field_info_field($field_name)) {
// Determine the langcode that will be used by language fallback.
$langcode = field_language($entity_type, $entity, $field_name, $langcode);
// Push the item as the single value for the field, and defer to
// field_view_field() to build the render array for the whole field.
$clone = clone $entity;
$clone->{$field_name}[$langcode] = array($item);
$elements = field_view_field($entity_type, $clone, $field_name, $display, $langcode);
// Extract the part of the render array we need.
$output = isset($elements[0]) ? $elements[0] : array();
if (isset($elements['#access'])) {
$output['#access'] = $elements['#access'];
}
}
return $output;
}
|
dart:html
volumeChangeEvent constant EventStreamProvider<Event> volumeChangeEvent = const EventStreamProvider<Event>('volumechange')
|
FindCxxTest Find CxxTest Find the CxxTest suite and declare a helper macro for creating unit tests and integrating them with CTest. For more details on CxxTest see http://cxxtest.tigris.org INPUT Variables CXXTEST_USE_PYTHON [deprecated since 1.3]
Only used in the case both Python & Perl
are detected on the system to control
which CxxTest code generator is used.
Valid only for CxxTest version 3.
NOTE: In older versions of this Find Module,
this variable controlled if the Python test
generator was used instead of the Perl one,
regardless of which scripting language the
user had installed.
CXXTEST_TESTGEN_ARGS (since CMake 2.8.3)
Specify a list of options to pass to the CxxTest code
generator. If not defined, --error-printer is
passed.
OUTPUT Variables CXXTEST_FOUND
True if the CxxTest framework was found
CXXTEST_INCLUDE_DIRS
Where to find the CxxTest include directory
CXXTEST_PERL_TESTGEN_EXECUTABLE
The perl-based test generator
CXXTEST_PYTHON_TESTGEN_EXECUTABLE
The python-based test generator
CXXTEST_TESTGEN_EXECUTABLE (since CMake 2.8.3)
The test generator that is actually used (chosen using user preferences
and interpreters found in the system)
CXXTEST_TESTGEN_INTERPRETER (since CMake 2.8.3)
The full path to the Perl or Python executable on the system, on
platforms where the script cannot be executed using its shebang line.
MACROS for optional use by CMake users: CXXTEST_ADD_TEST(<test_name> <gen_source_file> <input_files_to_testgen...>)
Creates a CxxTest runner and adds it to the CTest testing suite
Parameters:
test_name The name of the test
gen_source_file The generated source filename to be
generated by CxxTest
input_files_to_testgen The list of header files containing the
CxxTest8b7c:f320:99b9:690f:4595:cd17:293a:c069TestSuite's to be included in
this runner
#==============
Example Usage:
find_package(CxxTest)
if(CXXTEST_FOUND)
include_directories(${CXXTEST_INCLUDE_DIR})
enable_testing()
CXXTEST_ADD_TEST(unittest_foo foo_test.cc
${CMAKE_CURRENT_SOURCE_DIR}/foo_test.h)
target_link_libraries(unittest_foo foo) # as needed
endif()
This will (if CxxTest is found):
1. Invoke the testgen executable to autogenerate foo_test.cc in the
binary tree from "foo_test.h" in the current source directory.
2. Create an executable and test called unittest_foo.
#=============
Example foo_test.h:
#include <cxxtest/TestSuite.h>
class MyTestSuite : public CxxTest8b7c:f320:99b9:690f:4595:cd17:293a:c069TestSuite
{
public:
void testAddition( void )
{
TS_ASSERT( 1 + 1 > 1 );
TS_ASSERT_EQUALS( 1 + 1, 2 );
}
};
|
st8b7c:f320:99b9:690f:4595:cd17:293a:c069filesystem8b7c:f320:99b9:690f:4595:cd17:293a:c069opy_symlink Defined in header <filesystem> void copy_symlink( const st8b7c:f320:99b9:690f:4595:cd17:293a:c069filesystem8b7c:f320:99b9:690f:4595:cd17:293a:c069path& from,
const st8b7c:f320:99b9:690f:4595:cd17:293a:c069filesystem8b7c:f320:99b9:690f:4595:cd17:293a:c069path& to);
(1) (since C++17) void copy_symlink( const st8b7c:f320:99b9:690f:4595:cd17:293a:c069filesystem8b7c:f320:99b9:690f:4595:cd17:293a:c069path& from,
const st8b7c:f320:99b9:690f:4595:cd17:293a:c069filesystem8b7c:f320:99b9:690f:4595:cd17:293a:c069path& to,
st8b7c:f320:99b9:690f:4595:cd17:293a:c069error_code& ec ) noexcept;
(2) (since C++17) Copies a symlink to another location.
1) Effectively calls f(read_symlink(from), to) where f is create_symlink or create_directory_symlink depending on whether from resolves to a file or directory.
2) Effectively calls f(read_symlink(from, ec), to, ec) where f is create_symlink or create_directory_symlink depending on whether from resolves to a file or directory. Parameters from - path to a symbolic link to copy
to - destination path of the new symlink
ec - out-parameter for error reporting in the non-throwing overload
Return value (none).
Exceptions The overload that does not take a st8b7c:f320:99b9:690f:4595:cd17:293a:c069error_code& parameter throws filesystem8b7c:f320:99b9:690f:4595:cd17:293a:c069ilesystem_error on underlying OS API errors, constructed with from as the first path argument, to as the second path argument, and the OS error code as the error code argument. The overload taking a st8b7c:f320:99b9:690f:4595:cd17:293a:c069error_code& parameter sets it to the OS API error code if an OS API call fails, and executes ec.clear() if no errors occur. Any overload not marked noexcept may throw st8b7c:f320:99b9:690f:4595:cd17:293a:c069bad_alloc if memory allocation fails.
See also copy
(C++17) copies files or directories (function)
copy_file
(C++17) copies file contents (function)
create_symlinkcreate_directory_symlink
(C++17)(C++17) creates a symbolic link (function)
read_symlink
(C++17) obtains the target of a symbolic link (function)
|
Requests_IPv8b7c:f320:99b9:690f:4595:cd17:293a:c069split_v6_v4( string $ip ): string[] Splits an IPv6 address into the IPv6 and IPv4 representation parts Description RFC 4291 allows you to represent the last two parts of an IPv6 address using the standard IPv4 representation Example: 0:0:0:0:0:0:+1-351-490-6818 0:0:0:0:0:FFFF:+1-351-490-6818 Parameters $ip string Required An IPv6 address Return string[] [0] contains the IPv6 represented part, and [1] the IPv4 represented part Source File: wp-includes/Requests/IPv6.php. View all references protected static function split_v6_v4($ip) {
if (strpos($ip, '.') !== false) {
$pos = strrpos($ip, ':');
$ipv6_part = substr($ip, 0, $pos);
$ipv4_part = substr($ip, $pos + 1);
return array($ipv6_part, $ipv4_part);
}
else {
return array($ip, '');
}
}
Related Used By Used By Description Requests_IPv8b7c:f320:99b9:690f:4595:cd17:293a:c069check_ipv6() wp-includes/Requests/IPv6.php Checks an IPv6 address Requests_IPv8b7c:f320:99b9:690f:4595:cd17:293a:c069compress() wp-includes/Requests/IPv6.php Compresses an IPv6 address
|
AccessListener class AccessListener implements ListenerInterface AccessListener enforces access control rules. Methods __construct(TokenStorageInterface $tokenStorage, AccessDecisionManagerInterface $accessDecisionManager, AccessMapInterface $map, AuthenticationManagerInterface $authManager)
handle(GetResponseEvent $event) Handles access authorization.
Details
__construct(TokenStorageInterface $tokenStorage, AccessDecisionManagerInterface $accessDecisionManager, AccessMapInterface $map, AuthenticationManagerInterface $authManager)
Parameters TokenStorageInterface $tokenStorage AccessDecisionManagerInterface $accessDecisionManager AccessMapInterface $map AuthenticationManagerInterface $authManager
handle(GetResponseEvent $event)
Handles access authorization. Parameters GetResponseEvent $event Exceptions AccessDeniedException AuthenticationCredentialsNotFoundException
|
apply_filters( 'get_role_list', string[] $role_list, WP_User $user_object ) Filters the returned array of translated role names for a user. Parameters $role_list string[] An array of translated user role names keyed by role. $user_object WP_User A WP_User object. Source File: wp-admin/includes/class-wp-users-list-table.php. View all references return apply_filters( 'get_role_list', $role_list, $user_object );
Related Used By Used By Description WP_Users_List_Tabl8b7c:f320:99b9:690f:4595:cd17:293a:c069get_role_list() wp-admin/includes/class-wp-users-list-table.php Returns an array of translated user role names for a given user object.
Changelog Version Description 4.4.0 Introduced.
|
System.Console.Terminfo.Keys
Maintainer
[email protected]
Stability
experimental
Portability
portable (FFI)
Safe Haskell
Safe
Language
Haskell2010
Contents
The keypad
Arrow keys
Miscellaneous
Description
The string capabilities in this module are the character sequences corresponding to user input such as arrow keys and function keys.
The keypad
The following commands turn the keypad on/off (smkx and rmkx). They have no effect if those capabilities are not defined. For portability between terminals, the keypad should be explicitly turned on before accepting user key input.
keypadOn 8b7c:f320:99b9:690f:4595:cd17:293a:c069 TermStr s => Capability s Source
keypadOff 8b7c:f320:99b9:690f:4595:cd17:293a:c069 TermStr s => Capability s Source
Arrow keys
keyUp 8b7c:f320:99b9:690f:4595:cd17:293a:c069 Capability String Source
keyDown 8b7c:f320:99b9:690f:4595:cd17:293a:c069 Capability String Source
keyLeft 8b7c:f320:99b9:690f:4595:cd17:293a:c069 Capability String Source
keyRight 8b7c:f320:99b9:690f:4595:cd17:293a:c069 Capability String Source
Miscellaneous
functionKey 8b7c:f320:99b9:690f:4595:cd17:293a:c069 Int -> Capability String Source
Look up the control sequence for a given function sequence. For example, functionKey 12 retrieves the kf12 capability.
keyBackspace 8b7c:f320:99b9:690f:4595:cd17:293a:c069 Capability String Source
keyDeleteChar 8b7c:f320:99b9:690f:4595:cd17:293a:c069 Capability String Source
keyHome 8b7c:f320:99b9:690f:4595:cd17:293a:c069 Capability String Source
keyEnd 8b7c:f320:99b9:690f:4595:cd17:293a:c069 Capability String Source
keyPageUp 8b7c:f320:99b9:690f:4595:cd17:293a:c069 Capability String Source
keyPageDown 8b7c:f320:99b9:690f:4595:cd17:293a:c069 Capability String Source
keyEnter 8b7c:f320:99b9:690f:4595:cd17:293a:c069 Capability String Source
|
Class ScrollPane.AccessibleAWTScrollPane
java.lang.Object
javax.accessibility.AccessibleContext
java.awt.Component.AccessibleAWTComponent
java.awt.Container.AccessibleAWTContainer java.awt.ScrollPane.AccessibleAWTScrollPane All Implemented Interfaces:
Serializable, AccessibleComponent
Enclosing class: ScrollPane protected class ScrollPane.AccessibleAWTScrollPane extends Container.AccessibleAWTContainer This class implements accessibility support for the ScrollPane class. It provides an implementation of the Java Accessibility API appropriate to scroll pane user-interface elements. Since: 1.3 See Also: Serialized Form Nested Class Summary Nested classes/interfaces declared in class java.awt.Container.AccessibleAWTContainer
Container.AccessibleAWTContainer.AccessibleContainerHandler
Nested classes/interfaces declared in class java.awt.Component.AccessibleAWTComponent
Component.AccessibleAWTComponent.AccessibleAWTComponentHandler, Component.AccessibleAWTComponent.AccessibleAWTFocusHandler
Field Summary Fields declared in class java.awt.Container.AccessibleAWTContainer
accessibleContainerHandler
Fields declared in class java.awt.Component.AccessibleAWTComponent
accessibleAWTComponentHandler, accessibleAWTFocusHandler
Fields declared in class javax.accessibility.AccessibleContext
ACCESSIBLE_ACTION_PROPERTY, ACCESSIBLE_ACTIVE_DESCENDANT_PROPERTY, ACCESSIBLE_CARET_PROPERTY, ACCESSIBLE_CHILD_PROPERTY, ACCESSIBLE_COMPONENT_BOUNDS_CHANGED, ACCESSIBLE_DESCRIPTION_PROPERTY, ACCESSIBLE_HYPERTEXT_OFFSET, ACCESSIBLE_INVALIDATE_CHILDREN, ACCESSIBLE_NAME_PROPERTY, ACCESSIBLE_SELECTION_PROPERTY, ACCESSIBLE_STATE_PROPERTY, ACCESSIBLE_TABLE_CAPTION_CHANGED, ACCESSIBLE_TABLE_COLUMN_DESCRIPTION_CHANGED, ACCESSIBLE_TABLE_COLUMN_HEADER_CHANGED, ACCESSIBLE_TABLE_MODEL_CHANGED, ACCESSIBLE_TABLE_ROW_DESCRIPTION_CHANGED, ACCESSIBLE_TABLE_ROW_HEADER_CHANGED, ACCESSIBLE_TABLE_SUMMARY_CHANGED, ACCESSIBLE_TEXT_ATTRIBUTES_CHANGED, ACCESSIBLE_TEXT_PROPERTY, ACCESSIBLE_VALUE_PROPERTY, ACCESSIBLE_VISIBLE_DATA_PROPERTY, accessibleDescription, accessibleName, accessibleParent
Constructor Summary AccessibleAWTScrollPane()
Modifier
Constructor
Description
protected
Constructs an AccessibleAWTScrollPane.
Method Summary
Modifier and Type
Method
Description
AccessibleRole
getAccessibleRole()
Get the role of this object.
Methods declared in class java.awt.Container.AccessibleAWTContainer
addPropertyChangeListener, getAccessibleAt, getAccessibleChild, getAccessibleChildrenCount, removePropertyChangeListener
Methods declared in class java.awt.Component.AccessibleAWTComponent
addFocusListener, contains, getAccessibleComponent, getAccessibleDescription, getAccessibleIndexInParent, getAccessibleName, getAccessibleParent, getAccessibleStateSet, getBackground, getBounds, getCursor, getFont, getFontMetrics, getForeground, getLocale, getLocation, getLocationOnScreen, getSize, isEnabled, isFocusTraversable, isShowing, isVisible, removeFocusListener, requestFocus, setBackground, setBounds, setCursor, setEnabled, setFont, setForeground, setLocation, setSize, setVisible
Methods declared in class javax.accessibility.AccessibleContext
firePropertyChange, getAccessibleAction, getAccessibleEditableText, getAccessibleIcon, getAccessibleRelationSet, getAccessibleSelection, getAccessibleTable, getAccessibleText, getAccessibleValue, setAccessibleDescription, setAccessibleName, setAccessibleParent
Methods declared in class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Constructor Details AccessibleAWTScrollPane protected AccessibleAWTScrollPane() Constructs an AccessibleAWTScrollPane. Method Details getAccessibleRole public AccessibleRole getAccessibleRole() Get the role of this object. Overrides:
getAccessibleRole in class Component.AccessibleAWTComponent
Returns: an instance of AccessibleRole describing the role of the object See Also: AccessibleRole
|
Catch
package haxe.macro
import haxe.macro.Expr
Available on all platforms
Represents a catch in the AST.
See also:
https://haxe.org/manual/expression-try-catch.html
Fields
optionaltype:Null<ComplexType>The type of the catch.name:StringThe name of the catch variable.expr:ExprThe expression of the catch.
|
12.9. GiST and GIN Index Types There are two kinds of indexes that can be used to speed up full text searches. Note that indexes are not mandatory for full text searching, but in cases where a column is searched on a regular basis, an index is usually desirable. CREATE INDEX name ON table USING gist(column); Creates a GiST (Generalized Search Tree)-based index. The column can be of tsvector or tsquery type. CREATE INDEX name ON table USING gin(column); Creates a GIN (Generalized Inverted Index)-based index. The column must be of tsvector type. There are substantial performance differences between the two index types, so it is important to understand their characteristics. A GiST index is lossy, meaning that the index may produce false matches, and it is necessary to check the actual table row to eliminate such false matches. (PostgreSQL does this automatically when needed.) GiST indexes are lossy because each document is represented in the index by a fixed-length signature. The signature is generated by hashing each word into a single bit in an n-bit string, with all these bits OR-ed together to produce an n-bit document signature. When two words hash to the same bit position there will be a false match. If all words in the query have matches (real or false) then the table row must be retrieved to see if the match is correct. Lossiness causes performance degradation due to unnecessary fetches of table records that turn out to be false matches. Since random access to table records is slow, this limits the usefulness of GiST indexes. The likelihood of false matches depends on several factors, in particular the number of unique words, so using dictionaries to reduce this number is recommended. GIN indexes are not lossy for standard queries, but their performance depends logarithmically on the number of unique words. (However, GIN indexes store only the words (lexemes) of tsvector values, and not their weight labels. Thus a table row recheck is needed when using a query that involves weights.) In choosing which index type to use, GiST or GIN, consider these performance differences: GIN index lookups are about three times faster than GiST GIN indexes take about three times longer to build than GiST GIN indexes are moderately slower to update than GiST indexes, but about 10 times slower if fast-update support was disabled (see Section 58.4.1 for details) GIN indexes are two-to-three times larger than GiST indexes As a rule of thumb, GIN indexes are best for static data because lookups are faster. For dynamic data, GiST indexes are faster to update. Specifically, GiST indexes are very good for dynamic data and fast if the number of unique words (lexemes) is under 100,000, while GIN indexes will handle 100,000+ lexemes better but are slower to update. Note that GIN index build time can often be improved by increasing maintenance_work_mem, while GiST index build time is not sensitive to that parameter. Partitioning of big collections and the proper use of GiST and GIN indexes allows the implementation of very fast searches with online update. Partitioning can be done at the database level using table inheritance, or by distributing documents over servers and collecting search results using the dblink module. The latter is possible because ranking functions use only local information. Prev Next Testing and Debugging Text Search Up psql Support
|
function locale_translation_get_status locale_translation_get_status($projects = NULL, $langcodes = NULL) Gets the current translation status. @todo What is 'translation status'? File
core/modules/locale/locale.module, line 882 Enables the translation of the user interface to languages other than English. Code function locale_translation_get_status($projects = NULL, $langcodes = NULL) {
$result = array();
$status = \Drupal8b7c:f320:99b9:690f:4595:cd17:293a:c069state()->get('locale.translation_status');
module_load_include('translation.inc', 'locale');
$projects = $projects ? $projects : array_keys(locale_translation_get_projects());
$langcodes = $langcodes ? $langcodes : array_keys(locale_translatable_language_list());
// Get the translation status of each project-language combination. If no
// status was stored, a new translation source is created.
foreach ($projects as $project) {
foreach ($langcodes as $langcode) {
if (isset($status[$project][$langcode])) {
$result[$project][$langcode] = $status[$project][$langcode];
}
else {
$sources = locale_translation_build_sources(array($project), array($langcode));
if (isset($sources[$project][$langcode])) {
$result[$project][$langcode] = $sources[$project][$langcode];
}
}
}
}
return $result;
}
|
NotIdenticalToValidator class NotIdenticalToValidator extends AbstractComparisonValidator Validates values aren't identical (!==). Constants PRETTY_DATE Whether to format {@link \DateTime} objects as RFC-3339 dates ("Y-m-d H:i:s"). OBJECT_TO_STRING Whether to cast objects with a "__toString()" method to strings. Methods initialize(ExecutionContextInterface $context) Initializes the constraint validator. from ConstraintValidator validate(mixed $value, Constraint $constraint) Checks if the passed value is valid. from AbstractComparisonValidator Details
initialize(ExecutionContextInterface $context)
Initializes the constraint validator. Parameters ExecutionContextInterface $context The current validation context
validate(mixed $value, Constraint $constraint)
Checks if the passed value is valid. Parameters mixed $value The value that should be validated Constraint $constraint The constraint for the validation
|
gitprotocol-common Name gitprotocol-common - Things common to various protocols Synopsis <over-the-wire-protocol> Description This document sets defines things common to various over-the-wire protocols and file formats used in Git. Abnf notation ABNF notation as described by RFC 5234 is used within the protocol documents, except the following replacement core rules are used: HEXDIG = DIGIT / "a" / "b" / "c" / "d" / "e" / "f" We also define the following common rules: NUL = %x00
zero-id = 40*"0"
obj-id = 40*(HEXDIGIT)
refname = "HEAD"
refname /= "refs/" <see discussion below> A refname is a hierarchical octet string beginning with "refs/" and not violating the git-check-ref-format command’s validation rules. More specifically, they: They can include slash / for hierarchical (directory) grouping, but no slash-separated component can begin with a dot .. They must contain at least one /. This enforces the presence of a category like heads/, tags/ etc. but the actual names are not restricted. They cannot have two consecutive dots .. anywhere. They cannot have ASCII control characters (i.e. bytes whose values are lower than \040, or \177 DEL), space, tilde ~, caret ^, colon :, question-mark ?, asterisk *, or open bracket [ anywhere. They cannot end with a slash / or a dot .. They cannot end with the sequence .lock. They cannot contain a sequence @{. They cannot contain a \\. Pkt-line format Much (but not all) of the payload is described around pkt-lines. A pkt-line is a variable length binary string. The first four bytes of the line, the pkt-len, indicates the total length of the line, in hexadecimal. The pkt-len includes the 4 bytes used to contain the length’s hexadecimal representation. A pkt-line MAY contain binary data, so implementors MUST ensure pkt-line parsing/formatting routines are 8-bit clean. A non-binary line SHOULD BE terminated by an LF, which if present MUST be included in the total length. Receivers MUST treat pkt-lines with non-binary data the same whether or not they contain the trailing LF (stripping the LF if present, and not complaining when it is missing). The maximum length of a pkt-line’s data component is 65516 bytes. Implementations MUST NOT send pkt-line whose length exceeds 65520 (65516 bytes of payload + 4 bytes of length data). Implementations SHOULD NOT send an empty pkt-line ("0004"). A pkt-line with a length field of 0 ("0000"), called a flush-pkt, is a special case and MUST be handled differently than an empty pkt-line ("0004"). pkt-line = data-pkt / flush-pkt
data-pkt = pkt-len pkt-payload
pkt-len = 4*(HEXDIG)
pkt-payload = (pkt-len - 4)*(OCTET)
flush-pkt = "0000" Examples (as C-style strings): pkt-line actual value
---------------------------------
"0006a\n" "a\n"
"0005a" "a"
"000bfoobar\n" "foobar\n"
"0004" ""
|
docker update Description Update configuration of one or more containers Usage docker update [OPTIONS] CONTAINER [CONTAINER...]
Options Name, shorthand Default Description --blkio-weight Block IO (relative weight), between 10 and 1000, or 0 to disable (default 0) --cpu-period Limit CPU CFS (Completely Fair Scheduler) period --cpu-quota Limit CPU CFS (Completely Fair Scheduler) quota --cpu-rt-period
API 1.25+Limit the CPU real-time period in microseconds --cpu-rt-runtime
API 1.25+Limit the CPU real-time runtime in microseconds --cpu-shares , -c CPU shares (relative weight) --cpus
API 1.29+Number of CPUs --cpuset-cpus CPUs in which to allow execution (0-3, 0,1) --cpuset-mems MEMs in which to allow execution (0-3, 0,1) --kernel-memory Kernel memory limit --memory , -m Memory limit --memory-reservation Memory soft limit --memory-swap Swap limit equal to memory plus swap: ‘-1’ to enable unlimited swap --pids-limit
API 1.40+Tune container pids limit (set -1 for unlimited) --restart Restart policy to apply when a container exits Parent command Command Description docker The base command for the Docker CLI. Extended description The docker update command dynamically updates container configuration. You can use this command to prevent containers from consuming too many resources from their Docker host. With a single command, you can place limits on a single container or on many. To specify more than one container, provide space-separated list of container names or IDs. With the exception of the --kernel-memory option, you can specify these options on a running or a stopped container. On kernel version older than 4.6, you can only update --kernel-memory on a stopped container or on a running container with kernel memory initialized. Warning: The docker update and docker container update commands are not supported for Windows containers. Examples The following sections illustrate ways to use this command. Update a container’s cpu-shares To limit a container’s cpu-shares to 512, first identify the container name or ID. You can use docker ps to find these values. You can also use the ID returned from the docker run command. Then, do the following: $ docker update --cpu-shares 512 abebf7571666
Update a container with cpu-shares and memory To update multiple resource configurations for multiple containers: $ docker update --cpu-shares 512 -m 300M abebf7571666 hopeful_morse
Update a container’s kernel memory constraints You can update a container’s kernel memory limit using the --kernel-memory option. On kernel version older than 4.6, this option can be updated on a running container only if the container was started with --kernel-memory. If the container was started without --kernel-memory you need to stop the container before updating kernel memory. For example, if you started a container with this command: $ docker run -dit --name test --kernel-memory 50M ubuntu bash
You can update kernel memory while the container is running: $ docker update --kernel-memory 80M test
If you started a container without kernel memory initialized: $ docker run -dit --name test2 --memory 300M ubuntu bash
Update kernel memory of running container test2 will fail. You need to stop the container before updating the --kernel-memory setting. The next time you start it, the container uses the new value. Kernel version newer than (include) 4.6 does not have this limitation, you can use --kernel-memory the same way as other options. Update a container’s restart policy You can change a container’s restart policy on a running container. The new restart policy takes effect instantly after you run docker update on a container. To update restart policy for one or more containers: $ docker update --restart=on-failure:3 abebf7571666 hopeful_morse
Note that if the container is started with “--rm” flag, you cannot update the restart policy for it. The AutoRemove and RestartPolicy are mutually exclusive for the container.
|
Abbrev Table Properties Like abbrevs, abbrev tables have properties, some of which influence the way they work. You can provide them as arguments to define-abbrev-table, and manipulate them with the functions: Function: abbrev-table-put table prop val
Set the property prop of abbrev table table to value val.
Function: abbrev-table-get table prop
Return the property prop of abbrev table table, or nil if table has no such property.
The following properties have special meaning: :enable-function
This is like the :enable-function abbrev property except that it applies to all abbrevs in the table. It is used before even trying to find the abbrev before point, so it can dynamically modify the abbrev table. :case-fixed
This is like the :case-fixed abbrev property except that it applies to all abbrevs in the table. :regexp
If non-nil, this property is a regular expression that indicates how to extract the name of the abbrev before point, before looking it up in the table. When the regular expression matches before point, the abbrev name is expected to be in submatch 1. If this property is nil, the default is to use backward-word and forward-word to find the name. This property allows the use of abbrevs whose name contains characters of non-word syntax. :parents
This property holds a list of tables from which to inherit other abbrevs. :abbrev-table-modiff
This property holds a counter incremented each time a new abbrev is added to the table.
Copyright |
public function CacheFactoryInter8b7c:f320:99b9:690f:4595:cd17:293a:c069get public CacheFactoryInter8b7c:f320:99b9:690f:4595:cd17:293a:c069get($bin) Gets a cache backend class for a given cache bin. Parameters string $bin: The cache bin for which a cache backend object should be returned. Return value \Drupal\Core\Cache\CacheBackendInterface The cache backend object associated with the specified bin. File
core/lib/Drupal/Core/Cache/CacheFactoryInterface.php, line 19 Class
CacheFactoryInterface An interface defining cache factory classes. Namespace Drupal\Core\Cache Code public function get($bin);
|
public function FormStateInter8b7c:f320:99b9:690f:4595:cd17:293a:c069setBuildInfo public FormStateInter8b7c:f320:99b9:690f:4595:cd17:293a:c069setBuildInfo(array $build_info) Sets the build info for the form. Parameters array $build_info: An array of build info. Return value $this See also \Drupal\Core\Form\FormStat8b7c:f320:99b9:690f:4595:cd17:293a:c069$build_info File
core/lib/Drupal/Core/Form/FormStateInterface.php, line 232 Class
FormStateInterface Provides an interface for an object containing the current state of a form. Namespace Drupal\Core\Form Code public function setBuildInfo(array $build_info);
|
Plural enum Plurality cases used for translating plurals to different languages. See also
NgPlural
NgPluralCase
Internationalization (i18n) Guide enum Plural {
Zero: 0
One: 1
Two: 2
Few: 3
Many: 4
Other: 5
} Members Member Description Zero: 0 One: 1 Two: 2 Few: 3 Many: 4 Other: 5
|
grid.raster Render a raster object Description Render a raster object (bitmap image) at the given location, size, and orientation. Usage
grid.raster(image,
x = unit(0.5, "npc"), y = unit(0.5, "npc"),
width = NULL, height = NULL,
just = "centre", hjust = NULL, vjust = NULL,
interpolate = TRUE, default.units = "npc",
name = NULL, gp = gpar(), vp = NULL)
rasterGrob(image,
x = unit(0.5, "npc"), y = unit(0.5, "npc"),
width = NULL, height = NULL,
just = "centre", hjust = NULL, vjust = NULL,
interpolate = TRUE, default.units = "npc",
name = NULL, gp = gpar(), vp = NULL)
Arguments
image Any R object that can be coerced to a raster object.
x A numeric vector or unit object specifying x-location.
y A numeric vector or unit object specifying y-location.
width A numeric vector or unit object specifying width.
height A numeric vector or unit object specifying height.
just The justification of the rectangle relative to its (x, y) location. If there are two values, the first value specifies horizontal justification and the second value specifies vertical justification. Possible string values are: "left", "right", "centre", "center", "bottom", and "top". For numeric values, 0 means left alignment and 1 means right alignment.
hjust A numeric vector specifying horizontal justification. If specified, overrides the just setting.
vjust A numeric vector specifying vertical justification. If specified, overrides the just setting.
default.units A string indicating the default units to use if x, y, width, or height are only given as numeric vectors.
name A character identifier.
gp An object of class "gpar", typically the output from a call to the function gpar. This is basically a list of graphical parameter settings.
vp A Grid viewport object (or NULL).
interpolate A logical value indicating whether to linearly interpolate the image (the alternative is to use nearest-neighbour interpolation, which gives a more blocky result).
Details Neither width nor height needs to be specified, in which case, the aspect ratio of the image is preserved. If both width and height are specified, it is likely that the image will be distorted. Not all graphics devices are capable of rendering raster images and some may not be able to produce rotated images (i.e., if a raster object is rendered within a rotated viewport). See also the comments under rasterImage. All graphical parameter settings in gp will be ignored, including alpha. Value A rastergrob grob. Author(s) Paul Murrell See Also as.raster. dev.capabilities to see if it is supported. Examples
redGradient <- matrix(hcl(0, 80, seq(50, 80, 10)),
nrow=4, ncol=5)
# interpolated
grid.newpage()
grid.raster(redGradient)
# blocky
grid.newpage()
grid.raster(redGradient, interpolate=FALSE)
# blocky and stretched
grid.newpage()
grid.raster(redGradient, interpolate=FALSE, height=unit(1, "npc"))
# The same raster drawn several times
grid.newpage()
grid.raster(0, x=1:3/4, y=1:3/4, width=.1, interpolate=FALSE)
Copyright ( |
filecmp — File and Directory Comparisons Source code: Lib/filecmp.py The filecmp module defines functions to compare files and directories, with various optional time/correctness trade-offs. For comparing files, see also the difflib module. The filecmp module defines the following functions:
filecmp.cmp(f1, f2, shallow=True)
Compare the files named f1 and f2, returning True if they seem equal, False otherwise. If shallow is true, files with identical os.stat() signatures are taken to be equal. Otherwise, the contents of the files are compared. Note that no external programs are called from this function, giving it portability and efficiency. This function uses a cache for past comparisons and the results, with cache entries invalidated if the os.stat() information for the file changes. The entire cache may be cleared using clear_cache().
filecmp.cmpfiles(dir1, dir2, common, shallow=True)
Compare the files in the two directories dir1 and dir2 whose names are given by common. Returns three lists of file names: match, mismatch, errors. match contains the list of files that match, mismatch contains the names of those that don’t, and errors lists the names of files which could not be compared. Files are listed in errors if they don’t exist in one of the directories, the user lacks permission to read them or if the comparison could not be done for some other reason. The shallow parameter has the same meaning and default value as for filecmp.cmp(). For example, cmpfiles('a', 'b', ['c', 'd/e']) will compare a/c with b/c and a/d/e with b/d/e. 'c' and 'd/e' will each be in one of the three returned lists.
filecmp.clear_cache()
Clear the filecmp cache. This may be useful if a file is compared so quickly after it is modified that it is within the mtime resolution of the underlying filesystem. New in version 3.4.
1. The dircmp class
class filecmp.dircmp(a, b, ignore=None, hide=None)
Construct a new directory comparison object, to compare the directories a and b. ignore is a list of names to ignore, and defaults to filecmp.DEFAULT_IGNORES. hide is a list of names to hide, and defaults to [os.curdir, os.pardir]. The dircmp class compares files by doing shallow comparisons as described for filecmp.cmp(). The dircmp class provides the following methods:
report()
Print (to sys.stdout) a comparison between a and b.
report_partial_closure()
Print a comparison between a and b and common immediate subdirectories.
report_full_closure()
Print a comparison between a and b and common subdirectories (recursively).
The dircmp class offers a number of interesting attributes that may be used to get various bits of information about the directory trees being compared. Note that via __getattr__() hooks, all attributes are computed lazily, so there is no speed penalty if only those attributes which are lightweight to compute are used.
left
The directory a.
right
The directory b.
left_list
Files and subdirectories in a, filtered by hide and ignore.
right_list
Files and subdirectories in b, filtered by hide and ignore.
common
Files and subdirectories in both a and b.
left_only
Files and subdirectories only in a.
right_only
Files and subdirectories only in b.
common_dirs
Subdirectories in both a and b.
common_files
Files in both a and b.
common_funny
Names in both a and b, such that the type differs between the directories, or names for which os.stat() reports an error.
same_files
Files which are identical in both a and b, using the class’s file comparison operator.
diff_files
Files which are in both a and b, whose contents differ according to the class’s file comparison operator.
funny_files
Files which are in both a and b, but could not be compared.
subdirs
A dictionary mapping names in common_dirs to dircmp objects.
filecmp.DEFAULT_IGNORES
New in version 3.4. List of directories ignored by dircmp by default.
Here is a simplified example of using the subdirs attribute to search recursively through two directories to show common different files: >>> from filecmp import dircmp
>>> def print_diff_files(dcmp):
... for name in dcmp.diff_files:
... print("diff_file %s found in %s and %s" % (name, dcmp.left,
... dcmp.right))
... for sub_dcmp in dcmp.subdirs.values():
... print_diff_files(sub_dcmp)
...
>>> dcmp = dircmp('dir1', 'dir2')
>>> print_diff_files(dcmp)
|
quartz macOS Quartz Device Description quartz starts a graphics device driver for the macOS system. It supports plotting both to the screen (the default) and to various graphics file formats. Usage
quartz(title, width, height, pointsize, family, antialias, type,
file = NULL, bg, canvas, dpi)
quartz.options(..., reset = FALSE)
quartz.save(file, type = "png", device = dev.cur(), dpi = 100, ...)
Arguments
title title for the Quartz window (applies to on-screen output only), default "Quartz %d". A C-style format for an integer will be substituted by the device number (see the file argument to postscript for further details).
width the width of the plotting area in inches. Default 7.
height the height of the plotting area in inches. Default 7.
pointsize the default pointsize to be used. Default 12.
family this is the family name of the font that will be used by the device. Default "Arial". This will be the base name of a font as shown in Font Book.
antialias whether to use antialiasing. Default TRUE.
type the type of output to use. See ‘Details’ for more information. Default "native".
file an optional target for the graphics device. The default, NULL, selects a default name where one is needed. See ‘Details’ for more information.
bg the initial background colour to use for the device. Default "transparent". An opaque colour such as "white" will normally be required on off-screen types that support transparency such as "png" and "tiff".
canvas canvas colour to use for an on-screen device. Default "white", and will be forced to be an opaque colour.
dpi resolution of the output. The default (NA_real_) for an on-screen display defaults to the resolution of the main screen, and to 72 dpi otherwise. See ‘Details’.
... Any of the arguments to quartz except file.
reset logical: should the defaults be reset to their defaults?
device device number to copy from.
Details The defaults for all but one of the arguments of quartz are set by quartz.options: the ‘Arguments’ section gives the ‘factory-fresh’ defaults. The Quartz graphics device supports a variety of output types. On-screen output types are "" or "native" or "Cocoa". Off-screen output types produce output files and utilize the file argument. type = "pdf" gives PDF output. The following bitmap formats may be supported (depending on the OS version): "png", "jpeg", "jpg", "jpeg2000", "tif", "tiff", "gif", "psd" (Adobe Photoshop), "bmp" (Windows bitmap), "sgi" and "pict". The file argument is used for off-screen drawing. The actual file is only created when the device is closed (e.g., using dev.off()). For the bitmap devices, the page number is substituted if a C integer format is included in the character string, e.g. Rplot%03d.png. (The result must be less than PATH_MAX characters long, and may be truncated if not. See postscript for further details.) If a file argument is not supplied, the default is Rplots.pdf or Rplot%03d.type. Tilde expansion (see path.expand) is done. If a device-independent R graphics font family is specified (e.g., via par(family =) in the graphics package), the Quartz device makes use of the Quartz font database (see quartzFonts) to convert the R graphics font family to a Quartz-specific font family description. The default conversions are (MonoType TrueType versions of) Helvetica for sans, Times-Roman for serif and Courier for mono. On-screen devices are launched with a semi-transparent canvas. Once a new plot is created, the canvas is first painted with the canvas colour and then the current background colour (which can be transparent or semi-transparent). Off-screen devices have no canvas colour, and so start with a transparent background where possible (e.g., type = "png" and type = "tiff") – otherwise it appears that a solid white canvas is assumed in the Quartz code. PNG and TIFF files are saved with a dark grey matte which will show up in some viewers, including Preview. title can be used for on-screen output. It must be a single character string with an optional integer printf-style format that will be substituted by the device number. It is also optionally used (without a format) to give a title to a PDF file. Calling quartz() sets .Device to "quartz" for on-screen devices and to "quartz_off_screen" otherwise. The font family chosen needs to cover the characters to be used: characters not in the font are rendered as empty oblongs. For non-Western-European languages something other than the default of "Arial" is likely to be needed—one choice for Chinese is "MingLiU". quartz.save is a modified version of dev.copy2pdf to copy the plot from the current screen device to a quartz device, by default to a PNG file. Conventions This section describes the implementation of the conventions for graphics devices set out in the ‘R Internals’ manual.
The default device size is 7 inches square.
Font sizes are in big points.
The default font family is Arial.
Line widths are a multiple of 1/96 inch with no minimum set by R.
Circle radii are real-valued with no minimum set by R.
Colours are specified as sRGB.
Note For a long time the default font family was documented as "Helvetica" after it had been changed to "Arial" to work around a deficiency in macOS 10.4. It may be changed back in future. A fairly common Mac problem is no text appearing on plots due to corrupted or duplicated fonts on your system. You may be able to confirm this by using another font family, e.g. family = "serif". Open the Font Book application (in Applications) and check the fonts that you are using. See Also quartzFonts, Devices. png for way to access the bitmap types of this device via R's standard bitmap devices. Examples ## Not run:
## Only on a Mac,
## put something like this is your .Rprofile to customize the defaults
setHook(packageEvent("grDevices", "onLoad"),
function(...) grDevices8b7c:f320:99b9:690f:4595:cd17:293a:c069quartz.options(width = 8, height = 6,
pointsize = 10))
## End(Not run)
Copyright ( |
docker cp Copy files/folders between a container and the local filesystem Usage $ docker cp [OPTIONS] CONTAINER:SRC_PATH DEST_PATH|-
docker cp [OPTIONS] SRC_PATH|- CONTAINER:DEST_PATH
Refer to the options section for an overview of available OPTIONS for this command. Description The docker cp utility copies the contents of SRC_PATH to the DEST_PATH. You can copy from the container’s file system to the local machine or the reverse, from the local filesystem to the container. If - is specified for either the SRC_PATH or DEST_PATH, you can also stream a tar archive from STDIN or to STDOUT. The CONTAINER can be a running or stopped container. The SRC_PATH or DEST_PATH can be a file or directory. The docker cp command assumes container paths are relative to the container’s / (root) directory. This means supplying the initial forward slash is optional; The command sees compassionate_darwin:/tmp/foo/myfile.txt and compassionate_darwin:tmp/foo/myfile.txt as identical. Local machine paths can be an absolute or relative value. The command interprets a local machine’s relative paths as relative to the current working directory where docker cp is run. The cp command behaves like the Unix cp -a command in that directories are copied recursively with permissions preserved if possible. Ownership is set to the user and primary group at the destination. For example, files copied to a container are created with UID:GID of the root user. Files copied to the local machine are created with the UID:GID of the user which invoked the docker cp command. However, if you specify the -a option, docker cp sets the ownership to the user and primary group at the source. If you specify the -L option, docker cp follows any symbolic link in the SRC_PATH. docker cp does not create parent directories for DEST_PATH if they do not exist. Assuming a path separator of /, a first argument of SRC_PATH and second argument of DEST_PATH, the behavior is as follows:
SRC_PATH specifies a file
DEST_PATH does not exist the file is saved to a file created at DEST_PATH
DEST_PATH does not exist and ends with / Error condition: the destination directory must exist.
DEST_PATH exists and is a file the destination is overwritten with the source file’s contents
DEST_PATH exists and is a directory the file is copied into this directory using the basename from SRC_PATH
SRC_PATH specifies a directory
DEST_PATH does not exist
DEST_PATH is created as a directory and the contents of the source directory are copied into this directory
DEST_PATH exists and is a file Error condition: cannot copy a directory to a file
DEST_PATH exists and is a directory
SRC_PATH does not end with /. (that is: slash followed by dot) the source directory is copied into this directory
SRC_PATH does end with /. (that is: slash followed by dot) the content of the source directory is copied into this directory The command requires SRC_PATH and DEST_PATH to exist according to the above rules. If SRC_PATH is local and is a symbolic link, the symbolic link, not the target, is copied by default. To copy the link target and not the link, specify the -L option. A colon (:) is used as a delimiter between CONTAINER and its path. You can also use : when specifying paths to a SRC_PATH or DEST_PATH on a local machine, for example file:name.txt. If you use a : in a local machine path, you must be explicit with a relative or absolute path, for example: `/path/to/file:name.txt` or `./file:name.txt`
For example uses of this command, refer to the examples section below. Options Name, shorthand Default Description
--archive , -a
Archive mode (copy all uid/gid information)
--follow-link , -L
Always follow symbol link in SRC_PATH Examples Copy a local file into container $ docker cp ./some_file CONTAINER:/work
Copy files from container to local path $ docker cp CONTAINER:/var/logs/ /tmp/app_logs
Copy a file from container to stdout. Please note cp command produces a tar stream $ docker cp CONTAINER:/var/logs/app.log - | tar x -O | grep "ERROR"
Corner cases It is not possible to copy certain system files such as resources under /proc, /sys, /dev, tmpfs, and mounts created by the user in the container. However, you can still copy such files by manually running tar in docker exec. Both of the following examples do the same thing in different ways (consider SRC_PATH and DEST_PATH are directories): $ docker exec CONTAINER tar Ccf $(dirname SRC_PATH) - $(basename SRC_PATH) | tar Cxf DEST_PATH -
$ tar Ccf $(dirname SRC_PATH) - $(basename SRC_PATH) | docker exec -i CONTAINER tar Cxf DEST_PATH -
Using - as the SRC_PATH streams the contents of STDIN as a tar archive. The command extracts the content of the tar to the DEST_PATH in container’s filesystem. In this case, DEST_PATH must specify a directory. Using - as the DEST_PATH streams the contents of the resource as a tar archive to STDOUT.
|
netapp_eseries.santricity.netapp_e_auditlog – NetApp E-Series manage audit-log configuration Note This plugin is part of the netapp_eseries.santricity collection (version 1.1.0). To install it use: ansible-galaxy collection install netapp_eseries.santricity. To use it in a playbook, specify: netapp_eseries.santricity.netapp_e_auditlog. New in version 2.7: of netapp_eseries.santricity Synopsis Parameters Notes Examples Return Values Synopsis This module allows an e-series storage system owner to set audit-log configuration parameters. Parameters Parameter Choices/Defaults Comments api_password string / required The password to authenticate with the SANtricity Web Services Proxy or Embedded Web Services API. api_url string / required The url to the SANtricity Web Services Proxy or Embedded Web Services API. Example https://prod-1.wahoo.acme.com/devmgr/v2 api_username string / required The username to authenticate with the SANtricity Web Services Proxy or Embedded Web Services API. force boolean
Choices:
no ← yes Forces the audit-log configuration to delete log history when log messages fullness cause immediate warning or full condition. Warning! This will cause any existing audit-log messages to be deleted. This is only applicable for full_policy=preventSystemAccess. full_policy string
Choices:
overWrite ← preventSystemAccess Specifies what audit-log should do once the number of entries approach the record limit. log_level string
Choices: all
writeOnly ← Filters the log messages according to the specified log level selection. log_path string A local path to a file to be used for debug logging. max_records integer Default:50000 The maximum number log messages audit-log will retain. Max records must be between and including 100 and 50000. ssid string Default:1 The ID of the array to manage. This value must be unique for each array. threshold integer Default:90 This is the memory full percent threshold that audit-log will start issuing warning messages. Percent range must be between and including 60 and 90. validate_certs boolean
Choices: no
yes ← Should https certificates be validated? Notes Note Check mode is supported. This module is currently only supported with the Embedded Web Services API v3.0 and higher. The E-Series Ansible modules require either an instance of the Web Services Proxy (WSP), to be available to manage the storage-system, or an E-Series storage-system that supports the Embedded Web Services API. Embedded Web Services is currently available on the E2800, E5700, EF570, and newer hardware models.
netapp_eseries.santricity.netapp_e_storage_system may be utilized for configuring the systems managed by a WSP instance. Examples - name: Define audit-log to prevent system access if records exceed 50000 with warnings occurring at 60% capacity.
netapp_e_auditlog:
api_url: "https://{{ netapp_e_api_host }}/devmgr/v2"
api_username: "{{ netapp_e_api_username }}"
api_password: "{{ netapp_e_api_password }}"
ssid: "{{ netapp_e_ssid }}"
validate_certs: no
max_records: 50000
log_level: all
full_policy: preventSystemAccess
threshold: 60
log_path: /path/to/log_file.log
- name: Define audit-log utilize the default values.
netapp_e_auditlog:
api_url: "https://{{ netapp_e_api_host }}/devmgr/v2"
api_username: "{{ netapp_e_api_username }}"
api_password: "{{ netapp_e_api_password }}"
ssid: "{{ netapp_e_ssid }}"
- name: Force audit-log configuration when full or warning conditions occur while enacting preventSystemAccess policy.
netapp_e_auditlog:
api_url: "https://{{ netapp_e_api_host }}/devmgr/v2"
api_username: "{{ netapp_e_api_username }}"
api_password: "{{ netapp_e_api_password }}"
ssid: "{{ netapp_e_ssid }}"
max_records: 5000
log_level: all
full_policy: preventSystemAccess
threshold: 60
force: yes
Return Values Common return values are documented here, the following are the fields unique to this module: Key Returned Description msg string on success Success message Sample: The settings have been updated. Authors Nathan Swartz (@ndswartz)
© 2012–2018 Michael DeHaan |
Phar8b7c:f320:99b9:690f:4595:cd17:293a:c069startBuffering (PHP 5 >= 5.3.0, PHP 7, PHP 8, PECL phar >= 1.0.0)
Phar8b7c:f320:99b9:690f:4595:cd17:293a:c069startBuffering — Start buffering Phar write operations, do not modify the Phar object on disk Description public Phar8b7c:f320:99b9:690f:4595:cd17:293a:c069startBuffering(): void Although technically unnecessary, the Phar8b7c:f320:99b9:690f:4595:cd17:293a:c069startBuffering() method can provide a significant performance boost when creating or modifying a Phar archive with a large number of files. Ordinarily, every time a file within a Phar archive is created or modified in any way, the entire Phar archive will be recreated with the changes. In this way, the archive will be up-to-date with the activity performed on it. However, this can be unnecessary when simply creating a new Phar archive, when it would make more sense to write the entire archive [email protected]. Similarly, it is often necessary to make a series of changes and to ensure that they all are possible before making any changes on disk, similar to the relational database concept of transactions. the Phar8b7c:f320:99b9:690f:4595:cd17:293a:c069startBuffering()/Phar8b7c:f320:99b9:690f:4595:cd17:293a:c069stopBuffering() pair of methods is provided for this purpose. Phar write buffering is per-archive, buffering active for the foo.phar Phar archive does not affect changes to the bar.phar Phar archive. Parameters This function has no parameters. Return Values No value is returned. Examples
Example #1 A Phar8b7c:f320:99b9:690f:4595:cd17:293a:c069startBuffering() example <?php
// make sure it doesn't exist
@unlink('brandnewphar.phar');
try {
$p = new Phar(dirname(__FILE__) . '/brandnewphar.phar', 0, 'brandnewphar.phar');
} catch (Exception $e) {
echo 'Could not create phar:', $e;
}
echo 'The new phar has ' . $p->count() . " entries\n";
$p->startBuffering();
$p['file.txt'] = 'hi';
$p['file2.txt'] = 'there';
$p['file2.txt']->setCompressedGZ();
$p['file3.txt'] = 'babyface';
$p['file3.txt']->setMetadata(42);
$p->setStub("<?php
function __autoload($class)
{
include 'phar://myphar.phar/' . str_replace('_', '/', $class) . '.php';
}
Phar8b7c:f320:99b9:690f:4595:cd17:293a:c069mapPhar('myphar.phar');
include 'phar://myphar.phar/startup.php';
__HALT_COMPILER();");
$p->stopBuffering();
?> See Also
Phar8b7c:f320:99b9:690f:4595:cd17:293a:c069stopBuffering() - Stop buffering write requests to the Phar archive, and save changes to disk Phar8b7c:f320:99b9:690f:4595:cd17:293a:c069isBuffering() - Used to determine whether Phar write operations are being buffered, or are flushing directly to disk
|
Function st8b7c:f320:99b9:690f:4595:cd17:293a:c069intrinsics8b7c:f320:99b9:690f:4595:cd17:293a:c069xp2f32
pub unsafe extern "rust-intrinsic" fn exp2f32(x: f32) -> f32
🔬This is a nightly-only experimental API. (core_intrinsics)
Returns 2 raised to the power of an f32. The stabilized version of this intrinsic is 8b7c:f320:99b9:690f:4595:cd17:293a:c069exp2
|
isStret
kotlin-stdlib / kotlinx.cinterop / ObjCMethod / isStret
Platform and version requirements: Native (1.3)
val isStret: Boolean
|
protected property QueryAggregat8b7c:f320:99b9:690f:4595:cd17:293a:c069$sqlExpressions Stores the sql expressions used to build the sql query. An array of expressions. Type: array File
core/lib/Drupal/Core/Entity/Query/Sql/QueryAggregate.php, line 18 Class
QueryAggregate The SQL storage entity query aggregate class. Namespace Drupal\Core\Entity\Query\Sql Code protected $sqlExpressions = array();
|
community.vmware.vmware_vm_storage_policy – Create vSphere storage policies Note This plugin is part of the community.vmware collection (version 1.6.0). To install it use: ansible-galaxy collection install community.vmware. To use it in a playbook, specify: community.vmware.vmware_vm_storage_policy. New in version 1.0.0: of community.vmware Synopsis Requirements Parameters Notes Examples Return Values Synopsis A vSphere storage policy defines metadata that describes storage requirements for virtual machines and storage capabilities of storage providers. Currently, only tag-based storage policy creation is supported. Requirements The below requirements are needed on the host that executes this module. python >= 2.7 PyVmomi Parameters Parameter Choices/Defaults Comments description string Description of the storage policy to create or update. This parameter is ignored when state=absent. hostname string The hostname or IP address of the vSphere vCenter or ESXi server. If the value is not specified in the task, the value of environment variable VMWARE_HOST will be used instead. Environment variable support added in Ansible 2.6. name string / required Name of the storage policy to create, update, or delete. password string The password of the vSphere vCenter or ESXi server. If the value is not specified in the task, the value of environment variable VMWARE_PASSWORD will be used instead. Environment variable support added in Ansible 2.6.
aliases: pass, pwd port integer Default:443 The port number of the vSphere vCenter or ESXi server. If the value is not specified in the task, the value of environment variable VMWARE_PORT will be used instead. Environment variable support added in Ansible 2.6. proxy_host string Address of a proxy that will receive all HTTPS requests and relay them. The format is a hostname or a IP. If the value is not specified in the task, the value of environment variable VMWARE_PROXY_HOST will be used instead. This feature depends on a version of pyvmomi greater than v30.634-47-8322.12 proxy_port integer Port of the HTTP proxy that will receive all HTTPS requests and relay them. If the value is not specified in the task, the value of environment variable VMWARE_PROXY_PORT will be used instead. state string
Choices: absent
present ← State of storage policy. If set to present, the storage policy is created. If set to absent, the storage policy is deleted. tag_affinity boolean
Choices: no
yes ← If set to true, the storage policy enforces that virtual machines require the existence of a tag for datastore placement. If set to false, the storage policy enforces that virtual machines require the absence of a tag for datastore placement. This parameter is ignored when state=absent. tag_category string Name of the pre-existing tag category to assign to the storage policy. This parameter is ignored when state=absent. This parameter is required when state=present. tag_name string Name of the pre-existing tag to assign to the storage policy. This parameter is ignored when state=absent. This parameter is required when state=present. username string The username of the vSphere vCenter or ESXi server. If the value is not specified in the task, the value of environment variable VMWARE_USER will be used instead. Environment variable support added in Ansible 2.6.
aliases: admin, user validate_certs boolean
Choices: no
yes ← Allows connection when SSL certificates are not valid. Set to false when certificates are not trusted. If the value is not specified in the task, the value of environment variable VMWARE_VALIDATE_CERTS will be used instead. Environment variable support added in Ansible 2.6. If set to true, please make sure Python >= 2.7.9 is installed on the given machine. Notes Note Tested on vSphere 6.5 Examples - name: Create or update a vSphere tag-based storage policy
community.vmware.vmware_vm_storage_policy:
hostname: '{{ vcenter_hostname }}'
username: '{{ vcenter_username }}'
password: '{{ vcenter_password }}'
name: "vSphere storage policy"
description: "vSphere storage performance policy"
tag_category: "performance_tier"
tag_name: "gold"
tag_affinity: true
state: "present"
delegate_to: localhost
- name: Remove a vSphere tag-based storage policy
community.vmware.vmware_vm_storage_policy:
hostname: '{{ vcenter_hostname }}'
username: '{{ vcenter_username }}'
password: '{{ vcenter_password }}'
name: "vSphere storage policy"
state: "absent"
delegate_to: localhost
Return Values Common return values are documented here, the following are the fields unique to this module: Key Returned Description vmware_vm_storage_policy dictionary success dictionary of information for the storage policy Sample: {'vmware_vm_storage_policy': {'description': 'Storage policy for gold-tier storage', 'id': 'aa6d5a82-1c88-45da-85d3-3d74b91a5bad', 'name': 'gold'}} Authors Dustin Scott (@scottd018)
© 2012–2018 Michael DeHaan |
ECLIPSE_EXTRA_NATURES List of natures to add to the generated Eclipse project file. Eclipse projects specify language plugins by using natures. This property should be set to the unique identifier for a nature (which looks like a Java package name).
|
CurrencyType class CurrencyType extends AbstractType implements ChoiceLoaderInterface Methods buildForm(FormBuilderInterface $builder, array $options) Builds the form. from AbstractType buildView(FormView $view, FormInterface $form, array $options) Builds the form view. from AbstractType finishView(FormView $view, FormInterface $form, array $options) Finishes the form view. from AbstractType configureOptions(OptionsResolver $resolver) Configures the options for this type.
string getBlockPrefix() Returns the prefix of the template block name for this type.
string|null getParent() Returns the name of the parent type.
ChoiceListInterface loadChoiceList(null|callable $value = null) Loads a list of choices.
array loadChoicesForValues(array $values, null|callable $value = null) Loads the choices corresponding to the given values.
string[] loadValuesForChoices(array $choices, null|callable $value = null) Loads the values corresponding to the given choices.
Details
buildForm(FormBuilderInterface $builder, array $options)
Builds the form. This method is called for each type in the hierarchy starting from the top most type. Type extensions can further modify the form. Parameters FormBuilderInterface $builder The form builder array $options The options
buildView(FormView $view, FormInterface $form, array $options)
Builds the form view. This method is called for each type in the hierarchy starting from the top most type. Type extensions can further modify the view. A view of a form is built before the views of the child forms are built. This means that you cannot access child views in this method. If you need to do so, move your logic to {@link finishView()} instead. Parameters FormView $view The view FormInterface $form The form array $options The options
finishView(FormView $view, FormInterface $form, array $options)
Finishes the form view. This method gets called for each type in the hierarchy starting from the top most type. Type extensions can further modify the view. When this method is called, views of the form's children have already been built and finished and can be accessed. You should only implement such logic in this method that actually accesses child views. For everything else you are recommended to implement {@link buildView()} instead. Parameters FormView $view The view FormInterface $form The form array $options The options
configureOptions(OptionsResolver $resolver)
Configures the options for this type. Parameters OptionsResolver $resolver The resolver for the options string
getBlockPrefix()
Returns the prefix of the template block name for this type. The block prefix defaults to the underscored short class name with the "Type" suffix removed (e.g. "UserProfileType" => "user_profile"). Return Value string The prefix of the template block name string|null
getParent()
Returns the name of the parent type. Return Value string|null The name of the parent type if any, null otherwise ChoiceListInterface
loadChoiceList(null|callable $value = null)
Loads a list of choices. Optionally, a callable can be passed for generating the choice values. The callable receives the choice as first and the array key as the second argument. Parameters null|callable $value The callable which generates the values from choices Return Value ChoiceListInterface The loaded choice list array
loadChoicesForValues(array $values, null|callable $value = null)
Loads the choices corresponding to the given values. The choices are returned with the same keys and in the same order as the corresponding values in the given array. Optionally, a callable can be passed for generating the choice values. The callable receives the choice as first and the array key as the second argument. Parameters array $values An array of choice values. Non-existing values in this array are ignored null|callable $value The callable generating the choice values Return Value array An array of choices string[]
loadValuesForChoices(array $choices, null|callable $value = null)
Loads the values corresponding to the given choices. The values are returned with the same keys and in the same order as the corresponding choices in the given array. Optionally, a callable can be passed for generating the choice values. The callable receives the choice as first and the array key as the second argument. Parameters array $choices An array of choices. Non-existing choices in this array are ignored null|callable $value The callable generating the choice values Return Value string[] An array of choice values
|
dart:html
duration property num duration Source @DomName('HTMLMediaElement.duration')
@DocsEditable()
num get duration =>
_blink.BlinkHTMLMediaElement.instance.duration_Getter_(this);
|
ControllerDispatcher class ControllerDispatcher implements ControllerDispatcher (View source) Traits RouteDependencyResolverTrait Properties protected Container $container The container instance. Methods array resolveClassMethodDependencies(array $parameters, object $instance, string $method) Resolve the object method's type-hinted dependencies. from RouteDependencyResolverTrait array resolveMethodDependencies(array $parameters, ReflectionFunctionAbstract $reflector) Resolve the given method's type-hinted dependencies. from RouteDependencyResolverTrait mixed transformDependency(ReflectionParameter $parameter, array $parameters) Attempt to transform the given parameter into a class instance. from RouteDependencyResolverTrait bool alreadyInParameters(string $class, array $parameters) Determine if an object of the given class is in a list of parameters. from RouteDependencyResolverTrait void spliceIntoParameters(array $parameters, string $offset, mixed $value) Splice the given value into the parameter list. from RouteDependencyResolverTrait void __construct(Container $container) Create a new controller dispatcher instance. mixed dispatch(Route $route, mixed $controller, string $method) Dispatch a request to a given controller and method. array getMiddleware(Controller $controller, string $method) Get the middleware for the controller instance. static bool methodExcludedByOptions(string $method, array $options) Determine if the given options exclude a particular method. Details protected array
resolveClassMethodDependencies(array $parameters, object $instance, string $method)
Resolve the object method's type-hinted dependencies. Parameters array $parameters object $instance string $method Return Value array array
resolveMethodDependencies(array $parameters, ReflectionFunctionAbstract $reflector)
Resolve the given method's type-hinted dependencies. Parameters array $parameters ReflectionFunctionAbstract $reflector Return Value array protected mixed
transformDependency(ReflectionParameter $parameter, array $parameters)
Attempt to transform the given parameter into a class instance. Parameters ReflectionParameter $parameter array $parameters Return Value mixed protected bool
alreadyInParameters(string $class, array $parameters)
Determine if an object of the given class is in a list of parameters. Parameters string $class array $parameters Return Value bool protected void
spliceIntoParameters(array $parameters, string $offset, mixed $value)
Splice the given value into the parameter list. Parameters array $parameters string $offset mixed $value Return Value void void
__construct(Container $container)
Create a new controller dispatcher instance. Parameters Container $container Return Value void mixed
dispatch(Route $route, mixed $controller, string $method)
Dispatch a request to a given controller and method. Parameters Route $route mixed $controller string $method Return Value mixed array
getMiddleware(Controller $controller, string $method)
Get the middleware for the controller instance. Parameters Controller $controller string $method Return Value array static protected bool
methodExcludedByOptions(string $method, array $options)
Determine if the given options exclude a particular method. Parameters string $method array $options Return Value bool
|
pandas Ecosystem Increasingly, packages are being built on top of pandas to address specific needs in data preparation, analysis and visualization. This is encouraging because it means pandas is not only helping users to handle their data tasks but also that it provides a better starting point for developers to build powerful and more focused data tools. The creation of libraries that complement pandas’ functionality also allows pandas development to remain focused around it’s original requirements. This is an in-exhaustive list of projects that build on pandas in order to provide tools in the PyData space. We’d like to make it easier for users to find these project, if you know of other substantial projects that you feel should be on this list, please let us know. Statistics and Machine Learning Statsmodels Statsmodels is the prominent Python “statistics and econometrics library” and it has a long-standing special relationship with pandas. Statsmodels provides powerful statistics, econometrics, analysis and modeling functionality that is out of pandas’ scope. Statsmodels leverages pandas objects as the underlying data container for computation. sklearn-pandas Use pandas DataFrames in your scikit-learn ML pipeline. Featuretools Featuretools is a Python library for automated feature engineering built on top of pandas. It excels at transforming temporal and relational datasets into feature matrices for machine learning using reusable feature engineering “primitives”. Users can contribute their own primitives in Python and share them with the rest of the community. Visualization Bokeh Bokeh is a Python interactive visualization library for large datasets that natively uses the latest web technologies. Its goal is to provide elegant, concise construction of novel graphics in the style of Protovis/D3, while delivering high-performance interactivity over large data to thin clients. seaborn Seaborn is a Python visualization library based on matplotlib. It provides a high-level, dataset-oriented interface for creating attractive statistical graphics. The plotting functions in seaborn understand pandas objects and leverage pandas grouping operations internally to support concise specification of complex visualizations. Seaborn also goes beyond matplotlib and pandas with the option to perform statistical estimation while plotting, aggregating across observations and visualizing the fit of statistical models to emphasize patterns in a dataset. yhat/ggplot Hadley Wickham’s ggplot2 is a foundational exploratory visualization package for the R language. Based on “The Grammar of Graphics” it provides a powerful, declarative and extremely general way to generate bespoke plots of any kind of data. It’s really quite incredible. Various implementations to other languages are available, but a faithful implementation for Python users has long been missing. Although still young (as of Jan-2014), the yhat/ggplot project has been progressing quickly in that direction. Vincent The Vincent project leverages Vega (that in turn, leverages d3) to create plots. Although functional, as of Summer 2016 the Vincent project has not been updated in over two years and is unlikely to receive further updates. IPython Vega Like Vincent, the IPython Vega project leverages Vega to create plots, but primarily targets the IPython Notebook environment. Plotly Plotly’s Python API enables interactive figures and web shareability. Maps, 2D, 3D, and live-streaming graphs are rendered with WebGL and D3.js. The library supports plotting directly from a pandas DataFrame and cloud-based collaboration. Users of matplotlib, ggplot for Python, and Seaborn can convert figures into interactive web-based plots. Plots can be drawn in IPython Notebooks , edited with R or MATLAB, modified in a GUI, or embedded in apps and dashboards. Plotly is free for unlimited sharing, and has cloud, offline, or on-premise accounts for private use. QtPandas Spun off from the main pandas library, the qtpandas library enables DataFrame visualization and manipulation in PyQt4 and PySide applications. IDE IPython IPython is an interactive command shell and distributed computing environment. IPython Notebook is a web application for creating IPython notebooks. An IPython notebook is a JSON document containing an ordered list of input/output cells which can contain code, text, mathematics, plots and rich media. IPython notebooks can be converted to a number of open standard output formats (HTML, HTML presentation slides, LaTeX, PDF, ReStructuredText, Markdown, Python) through ‘Download As’ in the web interface and ipython nbconvert in a shell. Pandas DataFrames implement _repr_html_ methods which are utilized by IPython Notebook for displaying (abbreviated) HTML tables. (Note: HTML tables may or may not be compatible with non-HTML IPython output formats.) quantopian/qgrid qgrid is “an interactive grid for sorting and filtering DataFrames in IPython Notebook” built with SlickGrid. Spyder Spyder is a cross-platform Qt-based open-source Python IDE with editing, testing, debugging, and introspection features. Spyder can now introspect and display Pandas DataFrames and show both “column wise min/max and global min/max coloring.” API pandas-datareader pandas-datareader is a remote data access library for pandas (PyPI:pandas-datareader). It is based on functionality that was located in pandas.io.data and pandas.io.wb but was split off in v0.19. See more in the pandas-datareader docs: The following data feeds are available: Yahoo! Finance Google Finance FRED Fama/French World Bank OECD Eurostat EDGAR Index quandl/Python Quandl API for Python wraps the Quandl REST API to return Pandas DataFrames with timeseries indexes. pydatastream PyDatastream is a Python interface to the Thomson Dataworks Enterprise (DWE/Datastream) SOAP API to return indexed Pandas DataFrames or Panels with financial data. This package requires valid credentials for this API (non free). pandaSDMX pandaSDMX is a library to retrieve and acquire statistical data and metadata disseminated in SDMX 2.1, an ISO-standard widely used by institutions such as statistics offices, central banks, and international organisations. pandaSDMX can expose datasets and related structural metadata including dataflows, code-lists, and datastructure definitions as pandas Series or multi-indexed DataFrames. fredapi fredapi is a Python interface to the Federal Reserve Economic Data (FRED) provided by the Federal Reserve Bank of St. Louis. It works with both the FRED database and ALFRED database that contains point-in-time data (i.e. historic data revisions). fredapi provides a wrapper in Python to the FRED HTTP API, and also provides several convenient methods for parsing and analyzing point-in-time data from ALFRED. fredapi makes use of pandas and returns data in a Series or DataFrame. This module requires a FRED API key that you can obtain for free on the FRED website. Domain Specific Geopandas Geopandas extends pandas data objects to include geographic information which support geometric operations. If your work entails maps and geographical coordinates, and you love pandas, you should take a close [email protected]. xarray xarray brings the labeled data power of pandas to the physical sciences by providing N-dimensional variants of the core pandas data structures. It aims to provide a pandas-like and pandas-compatible toolkit for analytics on multi- dimensional arrays, rather than the tabular data for which pandas excels. Out-of-core Dask Dask is a flexible parallel computing library for analytics. Dask provides a familiar DataFrame interface for out-of-core, parallel and distributed computing. Dask-ML Dask-ML enables parallel and distributed machine learning using Dask alongside existing machine learning libraries like Scikit-Learn, XGBoost, and TensorFlow. Blaze Blaze provides a standard API for doing computations with various in-memory and on-disk backends: NumPy, Pandas, SQLAlchemy, MongoDB, PyTables, PySpark. Odo Odo provides a uniform API for moving data between different formats. It uses pandas own read_csv for CSV IO and leverages many existing packages such as PyTables, h5py, and pymongo to move data between non pandas formats. Its graph based approach is also extensible by end users for custom formats that may be too specific for the core of odo. Data validation Engarde Engarde is a lightweight library used to explicitly state your assumptions abour your datasets and check that they’re actually true. Extension Data Types Pandas provides an interface for defining extension types to extend NumPy’s type system. The following libraries implement that interface to provide types not found in NumPy or pandas, which work well with pandas’ data containers. cyberpandas Cyberpandas provides an extension type for storing arrays of IP Addresses. These arrays can be stored inside pandas’ Series and DataFrame. Accessors A directory of projects providing extension accessors. This is for users to discover new accessors and for library authors to coordinate on the namespace.
Library Accessor Classes
cyberpandas ip Series
pdvega vgplot
Series, DataFrame
|
get_stylesheet_uri(): string Retrieves stylesheet URI for the active theme. Description The stylesheet file name is ‘style.css’ which is appended to the stylesheet directory URI path.See get_stylesheet_directory_uri() . Return string URI to active theme's stylesheet. More Information Returns URL of current theme stylesheet. Source File: wp-includes/theme.php. View all references function get_stylesheet_uri() {
$stylesheet_dir_uri = get_stylesheet_directory_uri();
$stylesheet_uri = $stylesheet_dir_uri . '/style.css';
/**
* Filters the URI of the active theme stylesheet.
*
* @since 1.5.0
*
* @param string $stylesheet_uri Stylesheet URI for the active theme/child theme.
* @param string $stylesheet_dir_uri Stylesheet directory URI for the active theme/child theme.
*/
return apply_filters( 'stylesheet_uri', $stylesheet_uri, $stylesheet_dir_uri );
}
Hooks apply_filters( 'stylesheet_uri', string $stylesheet_uri, string $stylesheet_dir_uri )
Filters the URI of the active theme stylesheet. Related Uses Uses Description get_stylesheet_directory_uri() wp-includes/theme.php Retrieves stylesheet directory URI for the active theme. apply_filters() wp-includes/plugin.php Calls the callback functions that have been added to a filter hook.
Used By Used By Description get_bloginfo() wp-includes/general-template.php Retrieves information about the current site.
Changelog Version Description 1.5.0 Introduced.
|
notExp2 Alternative to log parameterization for variance components Description notLog2 and notExp2 are alternatives to log and exp or notLog and notExp for re-parameterization of variance parameters. They are used by the pdTens and pdIdnot classes which in turn implement smooths for gamm. The functions are typically used to ensure that smoothing parameters are positive, but the notExp2 is not monotonic: rather it cycles between ‘effective zero’ and ‘effective infinity’ as its argument changes. The notLog2 is the inverse function of the notExp2 only over an interval centered on zero. Parameterizations using these functions ensure that estimated smoothing parameters remain positive, but also help to ensure that the likelihood is never indefinite: once a working parameter pushes a smoothing parameter below ‘effetive zero’ or above ‘effective infinity’ the cyclic nature of the notExp2 causes the likelihood to decrease, where otherwise it might simply have flattened. This parameterization is really just a numerical trick, in order to get lme to fit gamm models, without failing due to indefiniteness. Note in particular that asymptotic results on the likelihood/REML criterion are not invalidated by the trick, unless parameter estimates end up close to the effective zero or effective infinity: but if this is the case then the asymptotics would also have been invalid for a conventional monotonic parameterization. This reparameterization was made necessary by some modifications to the underlying optimization method in lme introduced in nlme 3.1-62. It is possible that future releases will return to the notExp parameterization. Note that you can reset ‘effective zero’ and ‘effective infinity’: see below. Usage
notExp2(x,d=.Options$mgcv.vc.logrange,b=1/d)
notLog2(x,d=.Options$mgcv.vc.logrange,b=1/d)
Arguments
x Argument array of real numbers (notExp) or positive real numbers (notLog).
d the range of notExp2 runs from exp(-d) to exp(d). To change the range used by gamm reset mgcv.vc.logrange using options.
b determines the period of the cycle of notExp2.
Value An array of function values evaluated at the supplied argument values. Author(s) Simon N. Wood [email protected] References https://www.maths.ed.ac.uk/~swood34/ See Also pdTens, pdIdnot, gamm Examples
## Illustrate the notExp2 function:
require(mgcv)
x <- seq(-50,50,length=1000)
op <- par(mfrow=c(2,2))
plot(x,notExp2(x),type="l")
lines(x,exp(x),col=2)
plot(x,log(notExp2(x)),type="l")
lines(x,log(exp(x)),col=2) # redundancy intended
x <- x/4
plot(x,notExp2(x),type="l")
lines(x,exp(x),col=2)
plot(x,log(notExp2(x)),type="l")
lines(x,log(exp(x)),col=2) # redundancy intended
par(op)
Copyright ( |
junipernetworks.junos.junos_linkagg – (deprecated, removed after 2022-06-01) Manage link aggregation groups on Juniper JUNOS network devices Note This plugin is part of the junipernetworks.junos collection (version 1.2.1). To install it use: ansible-galaxy collection install junipernetworks.junos. To use it in a playbook, specify: junipernetworks.junos.junos_linkagg. New in version 1.0.0: of junipernetworks.junos DEPRECATED Synopsis Requirements Parameters Notes Examples Return Values Status DEPRECATED Removed in
major release after 2022-06-01 Why
Updated modules released with more functionality Alternative
Use junipernetworks.junos.junos_lag_interfaces instead. Synopsis This module provides declarative management of link aggregation groups on Juniper JUNOS network devices. Note This module has a corresponding action plugin. Requirements The below requirements are needed on the host that executes this module. ncclient (>=v0.5.2) Parameters Parameter Choices/Defaults Comments active boolean
Choices: no
yes ← Specifies whether or not the configuration is active or deactivated aggregate list / elements=dictionary List of link aggregation definitions. active boolean
Choices: no yes Specifies whether or not the configuration is active or deactivated description string Description of Interface. device_count integer Number of aggregated ethernet devices that can be configured. Acceptable integer value is between 1 and 128. members list / elements=string List of members interfaces of the link aggregation group. The value can be single interface or list of interfaces. min_links integer Minimum members that should be up before bringing up the link aggregation group. mode string
Choices: on off active passive Mode of the link aggregation group. A value of on will enable LACP in passive mode. active configures the link to actively information about the state of the link, or it can be configured in passive mode ie. send link state information only when received them from another link. A value of off will disable LACP. name string / required Name of the link aggregation group. state string
Choices: present absent up down State of the link aggregation group. description string Description of Interface. device_count integer Number of aggregated ethernet devices that can be configured. Acceptable integer value is between 1 and 128. members list / elements=string List of members interfaces of the link aggregation group. The value can be single interface or list of interfaces. min_links integer Minimum members that should be up before bringing up the link aggregation group. mode string
Choices:
on ← off active passive Mode of the link aggregation group. A value of on will enable LACP in passive mode. active configures the link to actively information about the state of the link, or it can be configured in passive mode ie. send link state information only when received them from another link. A value of off will disable LACP. name string Name of the link aggregation group. provider dictionary Deprecated Starting with Ansible 2.5 we recommend using connection: network_cli or connection: netconf. For more information please see the Junos OS Platform Options guide. A dict object containing connection details. host string Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport. password string Specifies the password to use to authenticate the connection to the remote device. This value is used to authenticate the SSH session. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead. port integer Specifies the port to use when building the connection to the remote device. The port value will default to the well known SSH port of 22 (for transport=cli) or port 830 (for transport=netconf) device. ssh_keyfile path Specifies the SSH key to use to authenticate the connection to the remote device. This value is the path to the key used to authenticate the SSH session. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_SSH_KEYFILE will be used instead. timeout integer Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error. transport string
Choices: cli
netconf ← Configures the transport connection to use when connecting to the remote device. username string Configures the username to use to authenticate the connection to the remote device. This value is used to authenticate the SSH session. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead. state string
Choices:
present ← absent up down State of the link aggregation group. Notes Note This module requires the netconf system service be enabled on the remote device being managed. Tested against vSRX JUNOS version 15.1X49-D15.4, vqfx-10000 JUNOS Version 15.1X53-D60.4. Recommended connection is netconf. See the Junos OS Platform Options. This module also works with local connections for legacy playbooks. For information on using CLI and netconf see the Junos OS Platform Options guide
For more information on using Ansible to manage network devices see the Ansible Network Guide
For more information on using Ansible to manage Juniper network devices see https://www.ansible.com/ansible-juniper. Examples - name: configure link aggregation
junipernetworks.junos.junos_linkagg:
name: ae11
members:
- ge-0/0/5
- ge-0/0/6
- ge-0/0/7
lacp: active
device_count: 4
state: present
- name: delete link aggregation
junipernetworks.junos.junos_linkagg:
name: ae11
members:
- ge-0/0/5
- ge-0/0/6
- ge-0/0/7
lacp: active
device_count: 4
state: delete
- name: deactivate link aggregation
junipernetworks.junos.junos_linkagg:
name: ae11
members:
- ge-0/0/5
- ge-0/0/6
- ge-0/0/7
lacp: active
device_count: 4
state: present
active: false
- name: Activate link aggregation
junipernetworks.junos.junos_linkagg:
name: ae11
members:
- ge-0/0/5
- ge-0/0/6
- ge-0/0/7
lacp: active
device_count: 4
state: present
active: true
- name: Disable link aggregation
junipernetworks.junos.junos_linkagg:
name: ae11
state: down
- name: Enable link aggregation
junipernetworks.junos.junos_linkagg:
name: ae11
state: up
Return Values Common return values are documented here, the following are the fields unique to this module: Key Returned Description diff string when configuration is changed and diff option is enabled. Configuration difference before and after applying change. Sample: [edit interfaces] + ge-0/0/6 { + ether-options { + 802.3ad ae0; + } + } [edit interfaces ge-0/0/7] + ether-options { + 802.3ad ae0; + } [edit interfaces] + ae0 { + description "configured by junos_linkagg"; + aggregated-ether-options { + lacp { + active; + } + } + } Status This module will be removed in a major release after 2022-06-01. [deprecated]
For more information see DEPRECATED. Authors Ganesh Nalawade (@ganeshrn)
© 2012–2018 Michael DeHaan |
[Java] Interface Supplier<T> @Incubating
public interface Supplier<T> Backport of Java8 Supplier. INTERNAL USE ONLY. Methods Summary
Methods
Type Params Return Type Name and description public T
get()
Method Detail public T get()
|
function DrupalDatabaseCach8b7c:f320:99b9:690f:4595:cd17:293a:c069isValidBin DrupalDatabaseCach8b7c:f320:99b9:690f:4595:cd17:293a:c069isValidBin() Checks if $this->bin represents a valid cache table. This check is required to ensure that non-cache tables are not truncated accidentally when calling cache_clear_all(). Return value boolean File
includes/cache.inc, line 568 Functions and interfaces for cache handling. Class
DrupalDatabaseCache Defines a default cache implementation. Code function isValidBin() {
if ($this->bin == 'cache' || substr($this->bin, 0, 6) == 'cache_') {
// Skip schema check for bins with standard table names.
return TRUE;
}
// These fields are required for any cache table.
$fields = array('cid', 'data', 'expire', 'created', 'serialized');
// Load the table schema.
$schema = drupal_get_schema($this->bin);
// Confirm that all fields are present.
return isset($schema['fields']) && !array_diff($fields, array_keys($schema['fields']));
}
|
3 Getting Started This section describes examples of how to use the Public Key API. Keys and certificates used in the following sections are generated only for testing the Public Key application. Some shell printouts in the following examples are abbreviated for increased readability. 3.1 PEM Files Public-key data (keys, certificates, and so on) can be stored in Privacy Enhanced Mail (PEM) format. The PEM files have the following structure:
<text>
-----BEGIN <SOMETHING>-----
<Attribute> : <Value>
<Base64 encoded DER data>
-----END <SOMETHING>-----
<text> A file can contain several BEGIN/END blocks. Text lines between blocks are ignored. Attributes, if present, are ignored except for Proc-Type and DEK-Info, which are used when DER data is encrypted. DSA Private Key A DSA private key can look as follows: Note
File handling is not done by the Public Key application.
1> {ok, PemBin} = file:read_file("dsa.pem").
{ok,<<"-----BEGIN DSA PRIVATE KEY-----\nMIIBuw"...>>} The following PEM file has only one entry, a private DSA key: 2> [DSAEntry] = public_key:pem_decode(PemBin).
[{'DSAPrivateKey',<<48,130,1,187,2,1,0,2,129,129,0,183,
179,230,217,37,99,144,157,21,228,204,
162,207,61,246,...>>,
not_encrypted}] 3> Key = public_key:pem_entry_decode(DSAEntry).
#'DSAPrivateKey'{version = 0,
p = 12900045185019966618...6593,
q = 1216700114794736143432235288305776850295620488937,
g = 10442040227452349332...47213,
y = 87256807980030509074...403143,
x = 510968529856012146351317363807366575075645839654} RSA Private Key with Password An RSA private key encrypted with a password can look as follows: 1> {ok, PemBin} = file:read_file("rsa.pem").
{ok,<<"Bag Attribut"...>>} The following PEM file has only one entry, a private RSA key: 2>[RSAEntry] = public_key:pem_decode(PemBin).
[{'RSAPrivateKey',<<224,108,117,203,152,40,15,77,128,126,
221,195,154,249,85,208,202,251,109,
119,120,57,29,89,19,9,...>>,
{"DES-EDE3-CBC",<<"kÙeø¼pµL">>}}] In this following example, the password is "abcd1234": 3> Key = public_key:pem_entry_decode(RSAEntry, "abcd1234").
#'RSAPrivateKey'{version = 'two-prime',
modulus = 1112355156729921663373...2737107,
publicExponent = 65537,
privateExponent = 58064406231183...726-352-3581,
prime1 = 11034766614656598484098...726-352-3581,
prime2 = 10080459293561036618240...77738643771,
exponent1 = 77928819327425934607...22152984217,
exponent2 = 4321939721698605733...20588523793,
coefficient = 924840412626098444...41820968343,
otherPrimeInfos = asn1_NOVALUE} X509 Certificates The following is an example of X509 certificates: 1> {ok, PemBin} = file:read_file("cacerts.pem").
{ok,<<"-----BEGIN CERTIFICATE-----\nMIIC7jCCAl"...>>} The following file includes two certificates: 2> [CertEntry1, CertEntry2] = public_key:pem_decode(PemBin).
[{'Certificate',<<48,130,2,238,48,130,2,87,160,3,2,1,2,2,
9,0,230,145,97,214,191,2,120,150,48,13,
...>>,
not_encrypted},
{'Certificate',<<48,130,3,200,48,130,3,49,160,3,2,1,2,2,1,
1,48,13,6,9,42,134,72,134,247,...>>>,
not_encrypted}] Certificates can be decoded as usual: 2> Cert = public_key:pem_entry_decode(CertEntry1).
#'Certificate'{
tbsCertificate =
#'TBSCertificate'{
version = v3,serialNumber = 16614168075301976214,
signature =
#'AlgorithmIdentifier'{
algorithm = {1,2,840,113549,1,1,5},
parameters = <<5,0>>},
issuer =
{rdnSequence,
[[#'AttributeTypeAndValue'{
type = {2,5,4,3},
value = <<19,8,101,114,108,97,110,103,67,65>>}],
[#'AttributeTypeAndValue'{
type = {2,5,4,11},
value = <<19,10,69,114,108,97,110,103,32,79,84,80>>}],
[#'AttributeTypeAndValue'{
type = {2,5,4,10},
value = <<19,11,69,114,105,99,115,115,111,110,32,65,66>>}],
[#'AttributeTypeAndValue'{
type = {2,5,4,7},
value = <<19,9,83,116,111,99,107,104,111,108,109>>}],
[#'AttributeTypeAndValue'{
type = {2,5,4,6},
value = <<19,2,83,69>>}],
[#'AttributeTypeAndValue'{
type = {1,2,840,113549,1,9,1},
value = <<22,22,112,101,116,101,114,64,101,114,...>>}]]},
validity =
#'Validity'{
notBefore = {utcTime,"080109082929Z"},
notAfter = {utcTime,"080208082929Z"}},
subject =
{rdnSequence,
[[#'AttributeTypeAndValue'{
type = {2,5,4,3},
value = <<19,8,101,114,108,97,110,103,67,65>>}],
[#'AttributeTypeAndValue'{
type = {2,5,4,11},
value = <<19,10,69,114,108,97,110,103,32,79,84,80>>}],
[#'AttributeTypeAndValue'{
type = {2,5,4,10},
value = <<19,11,69,114,105,99,115,115,111,110,32,...>>}],
[#'AttributeTypeAndValue'{
type = {2,5,4,7},
value = <<19,9,83,116,111,99,107,104,111,108,...>>}],
[#'AttributeTypeAndValue'{
type = {2,5,4,6},
value = <<19,2,83,69>>}],
[#'AttributeTypeAndValue'{
type = {1,2,840,113549,1,9,1},
value = <<22,22,112,101,116,101,114,64,...>>}]]},
subjectPublicKeyInfo =
#'SubjectPublicKeyInfo'{
algorithm =
#'AlgorithmIdentifier'{
algorithm = {1,2,840,113549,1,1,1},
parameters = <<5,0>>},
subjectPublicKey =
{0,<<48,129,137,2,129,129,0,203,209,187,77,73,231,90,...>>}},
issuerUniqueID = asn1_NOVALUE,
subjectUniqueID = asn1_NOVALUE,
extensions =
[#'Extension'{
extnID = {2,5,29,19},
critical = true,
extnValue = [48,3,1,1,255]},
#'Extension'{
extnID = {2,5,29,15},
critical = false,
extnValue = [3,2,1,6]},
#'Extension'{
extnID = {2,5,29,14},
critical = false,
extnValue = [4,20,27,217,65,152,6,30,142|...]},
#'Extension'{
extnID = {2,5,29,17},
critical = false,
extnValue = [48,24,129,22,112,101,116,101|...]}]},
signatureAlgorithm =
#'AlgorithmIdentifier'{
algorithm = {1,2,840,113549,1,1,5},
parameters = <<5,0>>},
signature =
<<163,186,7,163,216,152,63,47,154,234,139,73,154,96,120,
165,2,52,196,195,109,167,192,...>>} Parts of certificates can be decoded with public_key:der_decode/2, using the ASN.1 type of that part. However, an application-specific certificate extension requires application-specific ASN.1 decode/encode-functions. In the recent example, the first value of rdnSequence is of ASN.1 type 'X520CommonName'. ({2,5,4,3} = ?id-at-commonName): public_key:der_decode('X520CommonName', <<19,8,101,114,108,97,110,103,67,65>>).
{printableString,"erlangCA"} However, certificates can also be decoded using pkix_decode_cert/2, which can customize and recursively decode standard parts of a certificate: 3>{_, DerCert, _} = CertEntry1. 4> public_key:pkix_decode_cert(DerCert, otp).
#'OTPCertificate'{
tbsCertificate =
#'OTPTBSCertificate'{
version = v3,serialNumber = 16614168075301976214,
signature =
#'SignatureAlgorithm'{
algorithm = {1,2,840,113549,1,1,5},
parameters = 'NULL'},
issuer =
{rdnSequence,
[[#'AttributeTypeAndValue'{
type = {2,5,4,3},
value = {printableString,"erlangCA"}}],
[#'AttributeTypeAndValue'{
type = {2,5,4,11},
value = {printableString,"Erlang OTP"}}],
[#'AttributeTypeAndValue'{
type = {2,5,4,10},
value = {printableString,"Ericsson AB"}}],
[#'AttributeTypeAndValue'{
type = {2,5,4,7},
value = {printableString,"Stockholm"}}],
[#'AttributeTypeAndValue'{type = {2,5,4,6},value = "SE"}],
[#'AttributeTypeAndValue'{
type = {1,2,840,113549,1,9,1},
value = "[email protected]"}]]},
validity =
#'Validity'{
notBefore = {utcTime,"080109082929Z"},
notAfter = {utcTime,"080208082929Z"}},
subject =
{rdnSequence,
[[#'AttributeTypeAndValue'{
type = {2,5,4,3},
value = {printableString,"erlangCA"}}],
[#'AttributeTypeAndValue'{
type = {2,5,4,11},
value = {printableString,"Erlang OTP"}}],
[#'AttributeTypeAndValue'{
type = {2,5,4,10},
value = {printableString,"Ericsson AB"}}],
[#'AttributeTypeAndValue'{
type = {2,5,4,7},
value = {printableString,"Stockholm"}}],
[#'AttributeTypeAndValue'{type = {2,5,4,6},value = "SE"}],
[#'AttributeTypeAndValue'{
type = {1,2,840,113549,1,9,1},
value = "[email protected]"}]]},
subjectPublicKeyInfo =
#'OTPSubjectPublicKeyInfo'{
algorithm =
#'PublicKeyAlgorithm'{
algorithm = {1,2,840,113549,1,1,1},
parameters = 'NULL'},
subjectPublicKey =
#'RSAPublicKey'{
modulus =
1431267547247997...37419,
publicExponent = 65537}},
issuerUniqueID = asn1_NOVALUE,
subjectUniqueID = asn1_NOVALUE,
extensions =
[#'Extension'{
extnID = {2,5,29,19},
critical = true,
extnValue =
#'BasicConstraints'{
cA = true,pathLenConstraint = asn1_NOVALUE}},
#'Extension'{
extnID = {2,5,29,15},
critical = false,
extnValue = [keyCertSign,cRLSign]},
#'Extension'{
extnID = {2,5,29,14},
critical = false,
extnValue = [27,217,65,152,6,30,142,132,245|...]},
#'Extension'{
extnID = {2,5,29,17},
critical = false,
extnValue = [{rfc822Name,"[email protected]"}]}]},
signatureAlgorithm =
#'SignatureAlgorithm'{
algorithm = {1,2,840,113549,1,1,5},
parameters = 'NULL'},
signature =
<<163,186,7,163,216,152,63,47,154,234,139,73,154,96,120,
165,2,52,196,195,109,167,192,...>>} This call is equivalent to public_key:pem_entry_decode(CertEntry1): 5> public_key:pkix_decode_cert(DerCert, plain).
#'Certificate'{ ...} Encoding Public-Key Data to PEM Format If you have public-key data and want to create a PEM file this can be done by calling functions public_key:pem_entry_encode/2 and pem_encode/1 and saving the result to a file. For example, assume that you have PubKey = 'RSAPublicKey'{}. Then you can create a PEM-"RSA PUBLIC KEY" file (ASN.1 type 'RSAPublicKey') or a PEM-"PUBLIC KEY" file ('SubjectPublicKeyInfo' ASN.1 type). The second element of the PEM-entry is the ASN.1 DER encoded key data: 1> PemEntry = public_key:pem_entry_encode('RSAPublicKey', RSAPubKey).
{'RSAPublicKey', <<48,72,...>>, not_encrypted}
2> PemBin = public_key:pem_encode([PemEntry]).
<<"-----BEGIN RSA PUBLIC KEY-----\nMEgC...>>
3> file:write_file("rsa_pub_key.pem", PemBin).
ok or: 1> PemEntry = public_key:pem_entry_encode('SubjectPublicKeyInfo', RSAPubKey).
{'SubjectPublicKeyInfo', <<48,92...>>, not_encrypted}
2> PemBin = public_key:pem_encode([PemEntry]).
<<"-----BEGIN PUBLIC KEY-----\nMFw...>>
3> file:write_file("pub_key.pem", PemBin).
ok 3.2 RSA Public-Key Cryptography Suppose you have the following private key and a corresponding public key: PrivateKey = #'RSAPrivateKey{}' and the plaintext Msg = binary() PublicKey = #'RSAPublicKey'{} Then you can proceed as follows: Encrypt with the private key: RsaEncrypted = public_key:encrypt_private(Msg, PrivateKey),
Msg = public_key:decrypt_public(RsaEncrypted, PublicKey), Encrypt with the public key: RsaEncrypted = public_key:encrypt_public(Msg, PublicKey),
Msg = public_key:decrypt_private(RsaEncrypted, PrivateKey), Note
You normally do only one of the encrypt or decrypt operations, and the peer does the other. This normaly used in legacy applications as a primitive digital signature.
3.3 Digital Signatures Suppose you have the following private key and a corresponding public key: PrivateKey = #'RSAPrivateKey{}' or #'DSAPrivateKey'{} and the plaintext Msg = binary() PublicKey = #'RSAPublicKey'{} or {integer(), #'DssParams'{}} Then you can proceed as follows: Signature = public_key:sign(Msg, sha, PrivateKey),
true = public_key:verify(Msg, sha, Signature, PublicKey), Note
You normally do only one of the sign or verify operations, and the peer does the other.
It can be appropriate to calculate the message digest before calling sign or verify, and then use none as second argument: Digest = crypto:sha(Msg),
Signature = public_key:sign(Digest, none, PrivateKey),
true = public_key:verify(Digest, none, Signature, PublicKey), 3.4 SSH Files SSH typically uses PEM files for private keys but has its own file format for storing public keys. The public_key application can be used to parse the content of SSH public-key files. RFC 4716 SSH Public-Key Files RFC 4716 SSH files looks confusingly like PEM files, but there are some differences: 1> {ok, SshBin} = file:read_file("ssh2_rsa_pub").
{ok, <<"---- BEGIN SSH2 PUBLIC KEY ----\nAAAA"...>>} This is equivalent to calling public_key:ssh_decode(SshBin, rfc4716_public_key): 2> public_key:ssh_decode(SshBin, public_key).
[{#'RSAPublicKey'{modulus = 794430685...91663,
publicExponent = 35}, []}] OpenSSH Public-Key Format OpenSSH public-key format looks as follows: 1> {ok, SshBin} = file:read_file("openssh_dsa_pub").
{ok,<<"ssh-dss AAAAB3Nza"...>>} This is equivalent to calling public_key:ssh_decode(SshBin, openssh_public_key): 2> public_key:ssh_decode(SshBin, public_key).
[{{15642692...694280725,
#'Dss-Parms'{p = 17291273936...696123221,
q = 1255626590179665817295475654204371833735706001853,
g = 10454211196...480338645}},
[{comment,"dhopson@VMUbuntu-DSH"}]}] Known Hosts - OpenSSH Format Known hosts - OpenSSH format looks as follows: 1> {ok, SshBin} = file:read_file("known_hosts").
{ok,<<"hostname.domain.com,726-352-3581 ssh-rsa AAAAB...>>} Returns a list of public keys and their related attributes. Each pair of key and attribute corresponds to one entry in the known hosts file: 2> public_key:ssh_decode(SshBin, known_hosts).
[{#'RSAPublicKey'{modulus = 1498979460408...72721699,
publicExponent = 35},
[{hostnames,["hostname.domain.com","726-352-3581"]}]},
{#'RSAPublicKey'{modulus = 14989794604088...2721699,
publicExponent = 35},
[{comment,"[email protected]"},
{hostnames,["|1|BWO5qDxk/cFH0wa05JLdHn+j6xQ=|rXQvIxh5cDD3C43k5DPDamawVNA="]}]}] Authorized Keys - OpenSSH Format Authorized keys - OpenSSH format looks as follows: 1> {ok, SshBin} = file:read_file("auth_keys").
{ok, <<"command=\"dump /home\",no-pty,no-port-forwarding ssh-rsa AAA...>>} Returns a list of public keys and their related attributes. Each pair of key and attribute corresponds to one entry in the authorized key file: 2> public_key:ssh_decode(SshBin, auth_keys).
[{#'RSAPublicKey'{modulus = 794430685...691663,
publicExponent = 35},
[{comment,"dhopson@VMUbuntu-DSH"},
{options,["command=\"dump/home\"","no-pty",
"no-port-forwarding"]}]},
{{1564269258491...607694280725,
#'Dss-Parms'{p = 17291273936185...763696123221,
q = 1255626590179665817295475654204371833735706001853,
g = 10454211195705...60511039590076780999046480338645}},
[{comment,"dhopson@VMUbuntu-DSH"}]}] Creating an SSH File from Public-Key Data If you got a public key PubKey and a related list of attributes Attributes as returned by ssh_decode/2, you can create a new SSH file, for example: N> SshBin = public_key:ssh_encode([{PubKey, Attributes}], openssh_public_key),
<<"ssh-rsa "...>>
N+1> file:write_file("id_rsa.pub", SshBin).
ok
|
EncryptionServiceProvider class EncryptionServiceProvider extends ServiceProvider (View source) Properties protected Application $app The application instance. from ServiceProvider protected bool $defer Indicates if loading of the provider is deferred. from ServiceProvider static array $publishes The paths that should be published. from ServiceProvider static array $publishGroups The paths that should be published by group. from ServiceProvider Methods void __construct(Application $app) Create a new service provider instance. from ServiceProvider void mergeConfigFrom(string $path, string $key) Merge the given configuration with the existing configuration. from ServiceProvider void loadRoutesFrom(string $path) Load the given routes file if routes are not already cached. from ServiceProvider void loadViewsFrom(string|array $path, string $namespace) Register a view file namespace. from ServiceProvider void loadTranslationsFrom(string $path, string $namespace) Register a translation file namespace. from ServiceProvider void loadJsonTranslationsFrom(string $path) Register a JSON translation file path. from ServiceProvider void loadMigrationsFrom(array|string $paths) Register a database migration path. from ServiceProvider void publishes(array $paths, string $group = null) Register paths to be published by the publish command. from ServiceProvider void ensurePublishArrayInitialized(string $class) Ensure the publish array for the service provider is initialized. from ServiceProvider void addPublishGroup(string $group, array $paths) Add a publish group / tag to the service provider. from ServiceProvider static array pathsToPublish(string $provider = null, string $group = null) Get the paths to publish. from ServiceProvider static array pathsForProviderOrGroup(string|null $provider, string|null $group) Get the paths for the provider or group (or both). from ServiceProvider static array pathsForProviderAndGroup(string $provider, string $group) Get the paths for the provider and group. from ServiceProvider static array publishableProviders() Get the service providers available for publishing. from ServiceProvider static array publishableGroups() Get the groups available for publishing. from ServiceProvider void commands(array|mixed $commands) Register the package's custom Artisan commands. from ServiceProvider array provides() Get the services provided by the provider. from ServiceProvider array when() Get the events that trigger this service provider to register. from ServiceProvider bool isDeferred() Determine if the provider is deferred. from ServiceProvider void register() Register the service provider. string key(array $config) Extract the encryption key from the given configuration. Details void
__construct(Application $app)
Create a new service provider instance. Parameters Application $app Return Value void protected void
mergeConfigFrom(string $path, string $key)
Merge the given configuration with the existing configuration. Parameters string $path string $key Return Value void protected void
loadRoutesFrom(string $path)
Load the given routes file if routes are not already cached. Parameters string $path Return Value void protected void
loadViewsFrom(string|array $path, string $namespace)
Register a view file namespace. Parameters string|array $path string $namespace Return Value void protected void
loadTranslationsFrom(string $path, string $namespace)
Register a translation file namespace. Parameters string $path string $namespace Return Value void protected void
loadJsonTranslationsFrom(string $path)
Register a JSON translation file path. Parameters string $path Return Value void protected void
loadMigrationsFrom(array|string $paths)
Register a database migration path. Parameters array|string $paths Return Value void protected void
publishes(array $paths, string $group = null)
Register paths to be published by the publish command. Parameters array $paths string $group Return Value void protected void
ensurePublishArrayInitialized(string $class)
Ensure the publish array for the service provider is initialized. Parameters string $class Return Value void protected void
addPublishGroup(string $group, array $paths)
Add a publish group / tag to the service provider. Parameters string $group array $paths Return Value void static array
pathsToPublish(string $provider = null, string $group = null)
Get the paths to publish. Parameters string $provider string $group Return Value array static protected array
pathsForProviderOrGroup(string|null $provider, string|null $group)
Get the paths for the provider or group (or both). Parameters string|null $provider string|null $group Return Value array static protected array
pathsForProviderAndGroup(string $provider, string $group)
Get the paths for the provider and group. Parameters string $provider string $group Return Value array static array
publishableProviders()
Get the service providers available for publishing. Return Value array static array
publishableGroups()
Get the groups available for publishing. Return Value array void
commands(array|mixed $commands)
Register the package's custom Artisan commands. Parameters array|mixed $commands Return Value void array
provides()
Get the services provided by the provider. Return Value array array
when()
Get the events that trigger this service provider to register. Return Value array bool
isDeferred()
Determine if the provider is deferred. Return Value bool void
register()
Register the service provider. Return Value void protected string
key(array $config)
Extract the encryption key from the given configuration. Parameters array $config Return Value string
|
function filter_modules_enabled filter_modules_enabled($modules) Implements hook_modules_enabled(). File
modules/filter/filter.module, line 390 Framework for handling the filtering of content. Code function filter_modules_enabled($modules) {
// Reset the static cache of module-provided filters, in case any of the
// newly enabled modules defines a new filter or alters existing ones.
drupal_static_reset('filter_get_filters');
}
|
Image interface class providing an interface to fill a RGB or Grayscale image buffer. More... #include <pcl/io/image.h>
Public Types
enum
Encoding { BAYER_GRBG, YUV422, RGB }
using
Ptr = shared_ptr< Image >
using
ConstPtr = shared_ptr< const Image >
using
Clock = st8b7c:f320:99b9:690f:4595:cd17:293a:c069chrono8b7c:f320:99b9:690f:4595:cd17:293a:c069high_resolution_clock
using
Timestamp = st8b7c:f320:99b9:690f:4595:cd17:293a:c069chrono8b7c:f320:99b9:690f:4595:cd17:293a:c069high_resolution_clock8b7c:f320:99b9:690f:4595:cd17:293a:c069time_point
Public Member Functions
Image (FrameWrapper8b7c:f320:99b9:690f:4595:cd17:293a:c069Ptr image_metadata)
Image (FrameWrapper8b7c:f320:99b9:690f:4595:cd17:293a:c069Ptr image_metadata, Timestamp time)
virtual
~Image ()
virtual Destructor that never throws an exception. More...
virtual bool
isResizingSupported (unsigned input_width, unsigned input_height, unsigned output_width, unsigned output_height) const =0
virtual void
fillRGB (unsigned width, unsigned height, unsigned char *rgb_buffer, unsigned rgb_line_step=0) const =0
fills a user given buffer with the RGB values, with an optional nearest-neighbor down sampling and an optional subregion More...
virtual Encoding
getEncoding () const =0
returns the encoding of the native data. More...
virtual void
fillRaw (unsigned char *rgb_buffer) const
fills a user given buffer with the raw values. More...
virtual void
fillGrayscale (unsigned width, unsigned height, unsigned char *gray_buffer, unsigned gray_line_step=0) const =0
fills a user given buffer with the gray values, with an optional nearest-neighbor down sampling and an optional subregion More...
unsigned
getWidth () const
unsigned
getHeight () const
unsigned
getFrameID () const
st8b7c:f320:99b9:690f:4595:cd17:293a:c069uint64_t
getTimestamp () const
Timestamp
getSystemTimestamp () const
const void *
getData ()
int
getDataSize () const
unsigned
getStep () const
Protected Attributes
FrameWrapper8b7c:f320:99b9:690f:4595:cd17:293a:c069Ptr
wrapper_
Timestamp
timestamp_
Detailed Description
Image interface class providing an interface to fill a RGB or Grayscale image buffer.
Parameters
[in]
image_metadata
Definition at line 56 of file image.h.
Member Typedef Documentation Clock using pcl8b7c:f320:99b9:690f:4595:cd17:293a:c069io8b7c:f320:99b9:690f:4595:cd17:293a:c069Imag8b7c:f320:99b9:690f:4595:cd17:293a:c069Clock = st8b7c:f320:99b9:690f:4595:cd17:293a:c069chrono8b7c:f320:99b9:690f:4595:cd17:293a:c069high_resolution_clock
Definition at line 62 of file image.h. ConstPtr using pcl8b7c:f320:99b9:690f:4595:cd17:293a:c069io8b7c:f320:99b9:690f:4595:cd17:293a:c069Imag8b7c:f320:99b9:690f:4595:cd17:293a:c069ConstPtr = shared_ptr<const Image>
Definition at line 60 of file image.h. Ptr using pcl8b7c:f320:99b9:690f:4595:cd17:293a:c069io8b7c:f320:99b9:690f:4595:cd17:293a:c069Imag8b7c:f320:99b9:690f:4595:cd17:293a:c069Ptr = shared_ptr<Image>
Definition at line 59 of file image.h. Timestamp using pcl8b7c:f320:99b9:690f:4595:cd17:293a:c069io8b7c:f320:99b9:690f:4595:cd17:293a:c069Imag8b7c:f320:99b9:690f:4595:cd17:293a:c069Timestamp = st8b7c:f320:99b9:690f:4595:cd17:293a:c069chrono8b7c:f320:99b9:690f:4595:cd17:293a:c069high_resolution_clock8b7c:f320:99b9:690f:4595:cd17:293a:c069time_point
Definition at line 63 of file image.h. Member Enumeration Documentation Encoding enum pcl8b7c:f320:99b9:690f:4595:cd17:293a:c069io8b7c:f320:99b9:690f:4595:cd17:293a:c069Imag8b7c:f320:99b9:690f:4595:cd17:293a:c069Encoding
Enumerator
BAYER_GRBG
YUV422
RGB
Definition at line 65 of file image.h. Constructor & Destructor Documentation Image() [1/2]
pcl8b7c:f320:99b9:690f:4595:cd17:293a:c069io8b7c:f320:99b9:690f:4595:cd17:293a:c069Imag8b7c:f320:99b9:690f:4595:cd17:293a:c069Image (
FrameWrapper8b7c:f320:99b9:690f:4595:cd17:293a:c069Ptr image_metadata
) inline
Definition at line 72 of file image.h. Image() [2/2]
pcl8b7c:f320:99b9:690f:4595:cd17:293a:c069io8b7c:f320:99b9:690f:4595:cd17:293a:c069Imag8b7c:f320:99b9:690f:4595:cd17:293a:c069Image (
FrameWrapper8b7c:f320:99b9:690f:4595:cd17:293a:c069Ptr
image_metadata,
Timestamp
time )
inline
Definition at line 77 of file image.h. ~Image() virtual pcl8b7c:f320:99b9:690f:4595:cd17:293a:c069io8b7c:f320:99b9:690f:4595:cd17:293a:c069Imag8b7c:f320:99b9:690f:4595:cd17:293a:c069~Image (
) inlinevirtual
virtual Destructor that never throws an exception. Definition at line 85 of file image.h. Member Function Documentation fillGrayscale() virtual void pcl8b7c:f320:99b9:690f:4595:cd17:293a:c069io8b7c:f320:99b9:690f:4595:cd17:293a:c069Imag8b7c:f320:99b9:690f:4595:cd17:293a:c069fillGrayscale ( unsigned
width, unsigned
height, unsigned char *
gray_buffer, unsigned
gray_line_step = 0 )
const pure virtual
fills a user given buffer with the gray values, with an optional nearest-neighbor down sampling and an optional subregion
Parameters
[in]
width
desired width of output image.
[in]
height
desired height of output image.
[in,out]
gray_buffer
the output gray buffer.
[in]
gray_line_step
optional line step in bytes to allow the output in a rectangular subregion of the output buffer.
Implemented in pcl8b7c:f320:99b9:690f:4595:cd17:293a:c069io8b7c:f320:99b9:690f:4595:cd17:293a:c069ImageRGB24, and pcl8b7c:f320:99b9:690f:4595:cd17:293a:c069io8b7c:f320:99b9:690f:4595:cd17:293a:c069ImageYUV422. fillRaw() virtual void pcl8b7c:f320:99b9:690f:4595:cd17:293a:c069io8b7c:f320:99b9:690f:4595:cd17:293a:c069Imag8b7c:f320:99b9:690f:4595:cd17:293a:c069fillRaw ( unsigned char * rgb_buffer
) const inlinevirtual
fills a user given buffer with the raw values.
Parameters
[in,out]
rgb_buffer
Definition at line 121 of file image.h. fillRGB() virtual void pcl8b7c:f320:99b9:690f:4595:cd17:293a:c069io8b7c:f320:99b9:690f:4595:cd17:293a:c069Imag8b7c:f320:99b9:690f:4595:cd17:293a:c069fillRGB ( unsigned
width, unsigned
height, unsigned char *
rgb_buffer, unsigned
rgb_line_step = 0 )
const pure virtual
fills a user given buffer with the RGB values, with an optional nearest-neighbor down sampling and an optional subregion
Parameters
[in]
width
desired width of output image.
[in]
height
desired height of output image.
[in,out]
rgb_buffer
the output RGB buffer.
[in]
rgb_line_step
optional line step in bytes to allow the output in a rectangular subregion of the output buffer.
Implemented in pcl8b7c:f320:99b9:690f:4595:cd17:293a:c069io8b7c:f320:99b9:690f:4595:cd17:293a:c069ImageRGB24, and pcl8b7c:f320:99b9:690f:4595:cd17:293a:c069io8b7c:f320:99b9:690f:4595:cd17:293a:c069ImageYUV422. getData() const void* pcl8b7c:f320:99b9:690f:4595:cd17:293a:c069io8b7c:f320:99b9:690f:4595:cd17:293a:c069Imag8b7c:f320:99b9:690f:4595:cd17:293a:c069getData (
) inline
Definition at line 188 of file image.h. getDataSize() int pcl8b7c:f320:99b9:690f:4595:cd17:293a:c069io8b7c:f320:99b9:690f:4595:cd17:293a:c069Imag8b7c:f320:99b9:690f:4595:cd17:293a:c069getDataSize (
) const inline
Definition at line 195 of file image.h. getEncoding() virtual Encoding pcl8b7c:f320:99b9:690f:4595:cd17:293a:c069io8b7c:f320:99b9:690f:4595:cd17:293a:c069Imag8b7c:f320:99b9:690f:4595:cd17:293a:c069getEncoding (
) const pure virtual
returns the encoding of the native data.
Returns
encoding
Implemented in pcl8b7c:f320:99b9:690f:4595:cd17:293a:c069io8b7c:f320:99b9:690f:4595:cd17:293a:c069ImageRGB24, and pcl8b7c:f320:99b9:690f:4595:cd17:293a:c069io8b7c:f320:99b9:690f:4595:cd17:293a:c069ImageYUV422. getFrameID() unsigned pcl8b7c:f320:99b9:690f:4595:cd17:293a:c069io8b7c:f320:99b9:690f:4595:cd17:293a:c069Imag8b7c:f320:99b9:690f:4595:cd17:293a:c069getFrameID (
) const inline
Returns
frame id of the image.
Note
frame ids are ascending, but not necessarily synchronized with other streams
Definition at line 160 of file image.h. getHeight() unsigned pcl8b7c:f320:99b9:690f:4595:cd17:293a:c069io8b7c:f320:99b9:690f:4595:cd17:293a:c069Imag8b7c:f320:99b9:690f:4595:cd17:293a:c069getHeight (
) const inline
Returns
height of the image
Definition at line 150 of file image.h. getStep() unsigned pcl8b7c:f320:99b9:690f:4595:cd17:293a:c069io8b7c:f320:99b9:690f:4595:cd17:293a:c069Imag8b7c:f320:99b9:690f:4595:cd17:293a:c069getStep (
) const inline
Definition at line 202 of file image.h. getSystemTimestamp()
Timestamp pcl8b7c:f320:99b9:690f:4595:cd17:293a:c069io8b7c:f320:99b9:690f:4595:cd17:293a:c069Imag8b7c:f320:99b9:690f:4595:cd17:293a:c069getSystemTimestamp (
) const inline
Returns
the timestamp of the image
Note
the time value is synchronized with the system time.
Definition at line 181 of file image.h. getTimestamp() st8b7c:f320:99b9:690f:4595:cd17:293a:c069uint64_t pcl8b7c:f320:99b9:690f:4595:cd17:293a:c069io8b7c:f320:99b9:690f:4595:cd17:293a:c069Imag8b7c:f320:99b9:690f:4595:cd17:293a:c069getTimestamp (
) const inline
Returns
the timestamp of the image
Note
the time value is not synchronized with the system time
Definition at line 170 of file image.h. getWidth() unsigned pcl8b7c:f320:99b9:690f:4595:cd17:293a:c069io8b7c:f320:99b9:690f:4595:cd17:293a:c069Imag8b7c:f320:99b9:690f:4595:cd17:293a:c069getWidth (
) const inline
Returns
width of the image
Definition at line 141 of file image.h. isResizingSupported() virtual bool pcl8b7c:f320:99b9:690f:4595:cd17:293a:c069io8b7c:f320:99b9:690f:4595:cd17:293a:c069Imag8b7c:f320:99b9:690f:4595:cd17:293a:c069isResizingSupported ( unsigned
input_width, unsigned
input_height, unsigned
output_width, unsigned
output_height )
const pure virtual
Parameters
[in]
input_width
width of input image
[in]
input_height
height of input image
[in]
output_width
width of desired output image
[in]
output_height
height of desired output image
Returns
whether the resizing is supported or not.
Implemented in pcl8b7c:f320:99b9:690f:4595:cd17:293a:c069io8b7c:f320:99b9:690f:4595:cd17:293a:c069ImageRGB24, and pcl8b7c:f320:99b9:690f:4595:cd17:293a:c069io8b7c:f320:99b9:690f:4595:cd17:293a:c069ImageYUV422. Member Data Documentation timestamp_
Timestamp pcl8b7c:f320:99b9:690f:4595:cd17:293a:c069io8b7c:f320:99b9:690f:4595:cd17:293a:c069Imag8b7c:f320:99b9:690f:4595:cd17:293a:c069timestamp_ protected
Definition at line 209 of file image.h. wrapper_
FrameWrapper8b7c:f320:99b9:690f:4595:cd17:293a:c069Ptr pcl8b7c:f320:99b9:690f:4595:cd17:293a:c069io8b7c:f320:99b9:690f:4595:cd17:293a:c069Imag8b7c:f320:99b9:690f:4595:cd17:293a:c069wrapper_ protected
Definition at line 208 of file image.h. The documentation for this class was generated from the following file: pcl/io/image.h
© 2009–2012, Willow Garage, Inc. |
Illuminate\Contracts\Container Interfaces Container ContextualBindingBuilder Exceptions BindingResolutionException
|
Graphite Documentation Overview FAQ Installing Graphite The Carbon Daemons Configuring Carbon Feeding In Your Data Getting Your Data Into Graphite Administering Carbon Graphite-web’s local_settings.py Configuring The Webapp Administering The Webapp Using The Composer The Render URL API Functions The Dashboard User Interface The Whisper Database The Ceres Database Alternative storage finders Graphite Events Graphite Tag Support Graphite Terminology Tools That Work With Graphite Working on Graphite-web Client APIs Who is using Graphite? Release Notes Indices and tables Index Module Index Search Page
© 2008–2012 Chris Davis |
9.99 EVENT_QUERY — Query whether a coarray event has occurred Description:
EVENT_QUERY assignes the number of events to COUNT which have been posted to the EVENT variable and not yet been removed by calling EVENT WAIT. When STAT is present and the invocation was successful, it is assigned the value 0. If it is present and the invocation has failed, it is assigned a positive value and COUNT is assigned the value -1. Standard:
TS 18508 or later Class:
subroutine Syntax:
CALL EVENT_QUERY (EVENT, COUNT [, STAT]) Arguments:
EVENT
(intent(IN)) Scalar of type EVENT_TYPE, defined in ISO_FORTRAN_ENV; shall not be coindexed.
COUNT
(intent(out))Scalar integer with at least the precision of default integer.
STAT
(optional) Scalar default-kind integer variable.
Example:
program atomic
use iso_fortran_env
implicit none
type(event_type) 8b7c:f320:99b9:690f:4595:cd17:293a:c069 event_value_has_been_set[*]
integer 8b7c:f320:99b9:690f:4595:cd17:293a:c069 cnt
if (this_image() == 1) then
call event_query (event_value_has_been_set, cnt)
if (cnt > 0) write(*,*) "Value has been set"
elseif (this_image() == 2) then
event post (event_value_has_been_set[1])
end if
end program atomic
|
statsmodels.sandbox.distributions.extras.SkewNorm_gen.var
SkewNorm_gen.var(*args, **kwds)
Variance of the distribution.
Parameters:
arg2, arg3,.. (arg1,) – The shape parameter(s) for the distribution (see docstring of the instance object for more information)
loc (array_like, optional) – location parameter (default=0)
scale (array_like, optional) – scale parameter (default=1)
Returns:
var – the variance of the distribution
Return type:
float
© 2009–2012 Statsmodels Developers© 2006–2008 Scipy Developers |
PharDat8b7c:f320:99b9:690f:4595:cd17:293a:c069setDefaultStub (PHP 5 >= 5.3.0, PHP 7, PHP 8, PECL phar >= 2.0.0)
PharDat8b7c:f320:99b9:690f:4595:cd17:293a:c069setDefaultStub — Dummy function (Phar8b7c:f320:99b9:690f:4595:cd17:293a:c069setDefaultStub is not valid for PharData) Description public PharDat8b7c:f320:99b9:690f:4595:cd17:293a:c069setDefaultStub(?string $index = null, ?string $webIndex = null): bool Non-executable tar/zip archives cannot have a stub, so this method simply throws an exception. Parameters
index
Relative path within the phar archive to run if accessed on the command-line webIndex
Relative path within the phar archive to run if accessed through a web browser Return Values Returns true on success or false on failure. Errors/Exceptions Throws PharException on all method calls Changelog Version Description 8.0.0 webIndex is nullable now. See Also
Phar8b7c:f320:99b9:690f:4595:cd17:293a:c069setDefaultStub() - Used to set the PHP loader or bootstrap stub of a Phar archive to the default loader
|
Test Kitchen [edit on GitHub] Use Test Kitchen to automatically test cookbooks across any combination of platforms and test suites: Test suites are defined in a kitchen.yml file. See the configuration documentation for options and syntax information. Supports cookbook testing across many cloud providers and virtualization technologies. Uses a comprehensive set of operating system base images from Chef’s Bento project. The key concepts in Test Kitchen are: A platform is the operating system or target environment on which a cookbook is to be tested A suite is the Chef Infra Client configuration, a Policyfile or run-list, and (optionally) node attributes An instance is the combination of a specific platform and a specific suite, with each instance being assigned an auto-generated name A driver is the lifecycle that implements the actions associated with a specific instance—create the instance, do what is needed to converge on that instance (such as installing Chef Infra Client, uploading cookbooks, starting a Chef Infra Client run, and so on), setup anything else needed for testing, verify one (or more) suites post-converge, and then destroy that instance A provisioner is the component on which the Chef Infra Client code will be run, either using chef-zero or chef-solo via the chef_zero and chef_solo provisioners, respectively Bento Bento is a Chef Software project that produces base testing VirtualBox, Parallels, and VMware boxes for multiple operating systems for use with Test Kitchen. By default, Test Kitchen uses the base images provided by Bento although custom images may also be built using HashiCorp Packer. Drivers Test Kitchen uses a driver plugin architecture to enable Test Kitchen to test instances on cloud providers such as Amazon EC2, Google Compute Engine, and Microsoft Azure. You can also test on multiple local hypervisors, such as VMware, Hyper-V, or VirtualBox. Note Chef Workstation includes many common Test Kitchen drivers. Most drivers have driver-specific configuration settings that must be added to the kitchen.yml file before Test Kitchen will be able to use that platform during cookbook testing. For information about these driver-specific settings, please refer to the driver-specific documentation. Some popular drivers: Driver Plugin Description kitchen-azurerm A driver for Microsoft Azure. kitchen-cloudstack A driver for CloudStack. kitchen-digitalocean A driver for DigitalOcean. This driver ships in Chef Workstation. kitchen-dokken A driver for Docker. This driver ships in Chef Workstation. kitchen-dsc A driver for Windows PowerShell Desired State Configuration (DSC). kitchen-ec2 A driver for Amazon EC2. This driver ships in Chef Workstation. kitchen-google A driver for Google Compute Engine. This driver ships in Chef Workstation kitchen-hyperv A driver for Microsoft Hyper-V Server. This driver ships in Chef Workstation. kitchen-openstack A driver for OpenStack. This driver ships in Chef Workstation. kitchen-rackspace A driver for Rackspace. kitchen-vagrant A driver for HashiCorp Vagrant. This driver ships in Chef Workstation. Validation with InSpec Test Kitchen will create a VM or cloud instance, install Chef Infra Client to that system, and converge Chef Infra Client with your local cookbook. Once this is complete, you will want to perform automated validation against the infrastructure you have built to validate its configuration. Test Kitchen allows you to run InSpec tests against your converged cookbook for easy local validation of your infrastructure. kitchen (executable) kitchen is the command-line tool for Test Kitchen, an integration testing tool maintained by Chef Software. Test Kitchen runs tests against any combination of platforms using any combination of test suites. Each test, however, is done against a specific instance, which is comprised of a single platform and a single set of testing criteria. This allows each test to be run in isolation, ensuring that different behaviors within the same codebase can be tested thoroughly before those changes are committed to production. Note Any Test Kitchen subcommand that does not specify an instance will be applied to all instances. Note For more information about the kitchen command line tool, see kitchen. kitchen.yml Use a kitchen.yml file to define what is required to run Test Kitchen, including drivers, provisioners, platforms, and test suites. Note For more information about the kitchen.yml file, see kitchen.yml. Syntax The basic structure of a kitchen.yml file is as follows: driver:name:driver_nameprovisioner:name:provisioner_nameverifier:name:verifier_nametransport:name:transport_nameplatforms:- name:platform-versiondriver:name:driver_name- name:platform-versionsuites:- name:suite_namerun_list:- recipe[cookbook_nam8b7c:f320:99b9:690f:4595:cd17:293a:c069recipe_name]attributes:{foo:"bar"}excludes:- platform-version- name:suite_namedriver:name:driver_namerun_list:- recipe[cookbook_nam8b7c:f320:99b9:690f:4595:cd17:293a:c069recipe_name]attributes:{foo:"bar"}includes:- platform-version
where: driver_name is the name of a driver that will be used to create platform instances used during cookbook testing. This is the default driver used for all platforms and suites unless a platform or suite specifies a driver to override the default driver for that platform or suite; a driver specified for a suite will override a driver set for a platform provisioner_name specifies how Chef Infra Client will be simulated during testing. chef_zero and chef_solo are the most common provisioners used for testing cookbooks verifier_name specifies which application to use when running tests, such as inspec transport_name specifies which transport to use when executing commands remotely on the test instance. winrm is the default transport on Windows. The ssh transport is the default on all other operating systems. platform-version is the name of a platform on which Test Kitchen will perform cookbook testing, for example, ubuntu-20.04 or centos-7; depending on the platform, additional driver details—for example, instance names and URLs used with cloud platforms like OpenStack or Amazon EC2—may be required platforms may define Chef Infra Server attributes that are common to the collection of test suites suites is a collection of test suites, with each suite_name grouping defining an aspect of a cookbook to be tested. Each suite_name must specify a run-list, for example: run_list:
- recipe[cookbook_nam8b7c:f320:99b9:690f:4595:cd17:293a:c069default]
- recipe[cookbook_nam8b7c:f320:99b9:690f:4595:cd17:293a:c069recipe_name]
Each suite_name grouping may specify attributes as a Hash: { foo: "bar" } A suite_name grouping may use excludes and includes to exclude/include one (or more) platforms. For example: excludes:
- platform-version
- platform-version # for additional platforms
For example, a very simple kitchen.yml file: driver:name:vagrantprovisioner:name:chef_zeroplatforms:- name:ubuntu-20.04- name:centos-8- name:debian-10suites:- name:defaultrun_list:- recipe[apach8b7c:f320:99b9:690f:4595:cd17:293a:c069httpd]excludes:- debian-10
This file uses HashiCorp Vagrant as the driver, which requires no additional configuration because it’s the default driver used by Test Kitchen, chef-zero as the provisioner, and a single (default) test suite that runs on Ubuntu 20.04, and CentOS 7. Work with Proxies The environment variables http_proxy, https_proxy, and ftp_proxy are honored by Test Kitchen for proxies. The client.rb file is read to look for proxy configuration settings. If http_proxy, https_proxy, and ftp_proxy are specified in the client.rb file, Chef Infra Client will configure the ENV variable based on these (and related) settings. For example: http_proxy 'http://proxy.example.org:8080'
http_proxy_user 'myself'
http_proxy_pass 'Password1'
will be set to: ENV['http_proxy'] = 'http://myself:[email protected]:8080'
Test Kitchen also supports http_proxy and https_proxy in the kitchen.yml file. You can set them manually or have them read from your local environment variables: driver:name:vagrantprovisioner:name:chef_zero# Set proxy settings manually, orhttp_proxy:'http://user:password@server:port'https_proxy:'http://user:password@server:port'# Read from local environment variableshttp_proxy:<%= ENV['http_proxy'] %>https_proxy:<%= ENV['https_proxy'] %>
This will not set the proxy environment variables for applications other than Chef. The Vagrant plugin, vagrant-proxyconf, can be used to set the proxy environment variables for applications inside the VM. For more information … For more information about test-driven development and Test Kitchen: kitchen.ci Getting Started with Test Kitchen
|
matplotlib.gridspec.GridSpec
class matplotlib.gridspec.GridSpec(nrows, ncols, left=None, bottom=None, right=None, top=None, wspace=None, hspace=None, width_ratios=None, height_ratios=None)
A class that specifies the geometry of the grid that a subplot will be placed. The location of grid is determined by similar way as the SubplotParams. The number of rows and number of columns of the grid need to be set. Optionally, the subplot layout parameters (e.g., left, right, etc.) can be tuned.
get_subplot_params(fig=None)
return a dictionary of subplot layout parameters. The default parameters are from rcParams unless a figure attribute is set.
locally_modified_subplot_params()
tight_layout(fig, renderer=None, pad=1.08, h_pad=None, w_pad=None, rect=None)
Adjust subplot parameters to give specified padding.
Parameters:
pad : float Padding between the figure edge and the edges of subplots, as a fraction of the font-size. h_pad, w_pad : float, optional Padding (height/width) between edges of adjacent subplots. Defaults to pad_inches. rect : tuple of 4 floats, optional (left, bottom, right, top) rectangle in normalized figure coordinates that the whole subplots area (including labels) will fit into. Default is (0, 0, 1, 1).
update(**kwargs)
Update the current values. If any kwarg is None, default to the current value, if set, otherwise to rc.
Examples using matplotlib.gridspec.GridSpec
Demo Tight Layout
Markevery Demo
Streamplot
Pie Demo2
Demo Gridspec05
Demo Gridspec02
Demo Gridspec03
Demo Gridspec04
Demo Gridspec06
Customizing Location of Subplot Using GridSpec
Tight Layout guide
|
HTTP/2 guide This is the howto guide for the HTTP/2 implementation in Apache httpd. This feature is production-ready and you may expect interfaces and directives to remain consistent releases. The HTTP/2 protocol HTTP/2 is the evolution of the world's most successful application layer protocol, HTTP. It focuses on making more efficient use of network resources. It does not change the fundamentals of HTTP, the semantics. There are still request and responses and headers and all that. So, if you already know HTTP/1, you know 95% about HTTP/2 as well. There has been a lot written about HTTP/2 and how it works. The most normative is, of course, its RFC 7540 (also available in more readable formatting, YMMV). So, there you'll find the nuts and bolts. But, as RFC do, it's not really a good thing to read first. It's better to first understand what a thing wants to do and then read the RFC about how it is done. A much better document to start with is http2 explained by Daniel Stenberg, the author of curl. It is available in an ever growing list of languages, too! Too Long, Didn't read: there are some new terms and gotchas that need to be kept in mind while reading this document: HTTP/2 is a binary protocol, as opposed to HTTP 1.1 that is plain text. The latter is meant to be human readable (for example sniffing network traffic) meanwhile the former is not. More info in the official FAQ question.
h2 is HTTP/2 over TLS (protocol negotiation via ALPN).
h2c is HTTP/2 over TCP. A frame is the smallest unit of communication within an HTTP/2 connection, consisting of a header and a variable-length sequence of octets structured according to the frame type. More info in the official documentation section. A stream is a bidirectional flow of frames within the HTTP/2 connection. The correspondent concept in HTTP 1.1 is a request/response message exchange. More info in the official documentation section. HTTP/2 is able to run multiple streams of data over the same TCP connection, avoiding the classic HTTP 1.1 head of blocking slow request and avoiding to re-instantiate TCP connections for each request/response (KeepAlive patched the problem in HTTP 1.1 but did not fully solve it). HTTP/2 in Apache httpd The HTTP/2 protocol is implemented by its own httpd module, aptly named mod_http2. It implements the complete set of features described by RFC 7540 and supports HTTP/2 over cleartext (http:), as well as secure (https:) connections. The cleartext variant is named 'h2c', the secure one 'h2'. For h2c it allows the direct mode and the Upgrade: via an initial HTTP/1 request. One feature of HTTP/2 that offers new capabilities for web developers is Server Push. See that section on how your web application can make use of it. Build httpd with HTTP/2 support mod_http2 uses the library of nghttp2 as its implementation base. In order to build mod_http2 you need at least version 1.2.1 of libnghttp2 installed on your system. When you ./configure you Apache httpd source tree, you need to give it '--enable-http2' as additional argument to trigger the build of the module. Should your libnghttp2 reside in an unusual place (whatever that is on your operating system), you may announce its location with '--with-nghttp2=<path>' to configure. While that should do the trick for most, they are people who might prefer a statically linked nghttp2 in this module. For those, the option --enable-nghttp2-staticlib-deps exists. It works quite similar to how one statically links openssl to mod_ssl. Speaking of SSL, you need to be aware that most browsers will speak HTTP/2 only on https: URLs, so you need a server with SSL support. But not only that, you will need a SSL library that supports the ALPN extension. If OpenSSL is the library you use, you need at least version 1.0.2. Basic Configuration When you have a httpd built with mod_http2 you need some basic configuration for it becoming active. The first thing, as with every Apache module, is that you need to load it: LoadModule http2_module modules/mod_http2.so The second directive you need to add to your server configuration is Protocols h2 http/1.1 This allows h2, the secure variant, to be the preferred protocol on your server connections. When you want to enable all HTTP/2 variants, you simply write: Protocols h2 h2c http/1.1 Depending on where you put this directive, it affects all connections or just the ones to a certain virtual host. You can nest it, as in: Protocols http/1.1
<VirtualHost ...>
ServerName test.example.org
Protocols h2 http/1.1
</VirtualHost> This allows only HTTP/1 on connections, except SSL connections to test.example.org which offer HTTP/2.
Choose a strong SSLCipherSuite The SSLCipherSuite needs to be configured with a strong TLS cipher suite. The current version of mod_http2 does not enforce any cipher but most clients do so. Pointing a browser to a h2 enabled server with a inappropriate cipher suite will force it to simply refuse and fall back to HTTP 1.1. This is a common mistake that is done while configuring httpd for HTTP/2 the first time, so please keep it in mind to avoid long debugging sessions! If you want to be sure about the cipher suite to choose please avoid the ones listed in the HTTP/2 TLS reject list. The order of protocols mentioned is also relevant. By default, the first one is the most preferred protocol. When a client offers multiple choices, the one most to the left is selected. In Protocols http/1.1 h2 the most preferred protocol is HTTP/1 and it will always be selected unless a client only supports h2. Since we want to talk HTTP/2 to clients that support it, the better order is Protocols h2 h2c http/1.1 There is one more thing to ordering: the client has its own preferences, too. If you want, you can configure your server to select the protocol most preferred by the client: ProtocolsHonorOrder Off makes the order you wrote the Protocols irrelevant and only the client's ordering will decide. A last thing: the protocols you configure are not checked for correctness or spelling. You can mention protocols that do not exist, so there is no need to guard Protocols with any <IfModule> checks. For more advanced tips on configuration, see the modules section about dimensioning and how to manage multiple hosts with the same certificate. MPM Configuration HTTP/2 is supported in all multi-processing modules that come with httpd. However, if you use the prefork mpm, there will be severe restrictions. In prefork, mod_http2 will only process one request at at time per connection. But clients, such as browsers, will send many requests at the same time. If one of these takes long to process (or is a long polling one), the other requests will stall. mod_http2 will not work around this limit by default. The reason is that prefork is today only chosen, if you run processing engines that are not prepared for multi-threading, e.g. will crash with more than one request. If your setup can handle it, configuring event mpm is nowadays the best one (if supported on your platform). If you are really stuck with prefork and want multiple requests, you can tweak the H2MinWorkers to make that possible. If it breaks, however, you own both parts. Clients Almost all modern browsers support HTTP/2, but only over SSL connections: Firefox (v43), Chrome (v45), Safari (since v9), iOS Safari (v9), Opera (v35), Chrome for Android (v49) and Internet Explorer (v11 on Windows10) (source). Other clients, as well as servers, are listed on the Implementations wiki, among them implementations for c, c++, common lisp, dart, erlang, haskell, java, nodejs, php, python, perl, ruby, rust, scala and swift. Several of the non-browser client implementations support HTTP/2 over cleartext, h2c. The most versatile being curl. Useful tools to debug HTTP/2 The first tool to mention is of course curl. Please make sure that your version supports HTTP/2 checking its Features: $ curl -V
curl 7.45.0 (x86_64-apple-darwin15.0.0) libcurl/7.45.0 OpenSSL/1.0.2d zlib/1.2.8 nghttp2/1.3.4
Protocols: dict file ftp ftps gopher http https imap imaps ldap ldaps pop3 [...]
Features: IPv6 Largefile NTLM NTLM_WB SSL libz TLS-SRP HTTP2
Mac OS homebrew notes brew install curl --with-openssl --with-nghttp2 And for really deep inspection wireshark. The nghttp2 package also includes clients, such as:
nghttp - useful to visualize the HTTP/2 frames and get a better idea of the protocol.
h2load - useful to stress-test your server. Chrome offers detailed HTTP/2 logs on its connections via the special net-internals page. There is also an interesting extension for Chrome and Firefox to visualize when your browser is using HTTP/2. Server Push The HTTP/2 protocol allows the server to PUSH responses to a client it never asked for. The tone of the conversation is: "here is a request that you never sent and the response to it will arrive soon..." But there are restrictions: the client can disable this feature and the server may only ever PUSH on a request that came from the client. The intention is to allow the server to send resources to the client that it will most likely need: a css or javascript resource that belongs to a html page the client requested. A set of images that is referenced by a css, etc. The advantage for the client is that it saves the time to send the request which may range from a few milliseconds to half a second, depending on where on the globe both are located. The disadvantage is that the client may get sent things it already has in its cache. Sure, HTTP/2 allows for the early cancellation of such requests, but still there are resources wasted. To summarize: there is no one good strategy on how to make best use of this feature of HTTP/2 and everyone is still experimenting. So, how do you experiment with it in Apache httpd? mod_http2 inspect response header for Link headers in a certain format: Link </xxx.css>;rel=preload, </xxx.js>; rel=preload If the connection supports PUSH, these two resources will be sent to the client. As a web developer, you may set these headers either directly in your application response or you configure the server via <Location /xxx.html>
Header add Link "</xxx.css>;rel=preload"
Header add Link "</xxx.js>;rel=preload"
</Location> If you want to use preload links without triggering a PUSH, you can use the nopush parameter, as in Link </xxx.css>;rel=preload;nopush or you may disable PUSHes for your server entirely with the directive H2Push Off And there is more: The module will keep a diary of what has been PUSHed for each connection (hashes of URLs, basically) and will not PUSH the same resource twice. When the connection closes, this information is discarded. There are people thinking about how a client can tell a server what it already has, so PUSHes for those things can be avoided, but this is all highly experimental right now. Another experimental draft that has been implemented in mod_http2 is the Accept-Push-Policy Header Field where a client can, for each request, define what kind of PUSHes it accepts. PUSH might not always trigger the request/response/performance that one expects or hopes for. There are various studies on this topic to be found on the web that explain benefits and weaknesses and how different features of client and network influence the outcome. For example: just because the server PUSHes a resource does not mean a browser will actually use the data. The major thing that influences the response being PUSHed is the request that was simulated. The request URL for a PUSH is given by the application, but where do the request headers come from? For example, will the PUSH request a accept-language header and if yes with what value? Apache will look at the original request (the one that triggered the PUSH) and copy the following headers over to PUSH requests: user-agent, accept, accept-encoding, accept-language, cache-control. All other headers are ignored. Cookies will also not be copied over. PUSHing resources that require a cookie to be present will not work. This can be a matter of debate. But unless this is more clearly discussed with browser, let's err on the side of caution and not expose cookie where they might ordinarily not be visible. Early Hints An alternative to PUSHing resources is to send Link headers to the client before the response is even ready. This uses the HTTP feature called "Early Hints" and is described in RFC 8297. In order to use this, you need to explicitly enable it on the server via H2EarlyHints on (It is not enabled by default since some older browser tripped on such responses.) If this feature is on, you can use the directive H2PushResource to trigger early hints and resource PUSHes: <Location /xxx.html>
H2PushResource /xxx.css
H2PushResource /xxx.js
</Location> This will send out a "103 Early Hints" response to a client as soon as the server starts processing the request. This may be much early than the time the first response headers have been determined, depending on your web application. If H2Push is enabled, this will also start the PUSH right after the 103 response. If H2Push is disabled however, the 103 response will be send nevertheless to the client.
|
love.graphics.setMeshCullMode
Available since LÖVE 11.0 This function is not supported in earlier versions. Sets whether back-facing triangles in a Mesh are culled.
This is designed for use with low level custom hardware-accelerated 3D rendering via custom vertex attributes on Meshes, custom vertex shaders, and depth testing with a depth buffer.
By default, both front- and back-facing triangles in Meshes are rendered. Function Synopsis love.graphics.setMeshCullMode( mode ) Arguments
CullMode mode The Mesh face culling mode to use (whether to render everything, cull back-facing triangles, or cull front-facing triangles).
Returns Nothing. See Also
love.graphics
love.graphics.getMeshCullMode
love.graphics.setFrontFaceWinding
love.graphics.setDepthMode
Mesh
|
ExpressionCacheWarmer class ExpressionCacheWarmer implements CacheWarmerInterface Methods __construct(iterable $expressions, ExpressionLanguage $expressionLanguage)
bool isOptional() Checks whether this warmer is optional or not.
warmUp(string $cacheDir) Warms up the cache.
Details
__construct(iterable $expressions, ExpressionLanguage $expressionLanguage)
Parameters iterable $expressions ExpressionLanguage $expressionLanguage bool
isOptional()
Checks whether this warmer is optional or not. Optional warmers can be ignored on certain conditions. A warmer should return true if the cache can be generated incrementally and on-demand. Return Value bool true if the warmer is optional, false otherwise
warmUp(string $cacheDir)
Warms up the cache. Parameters string $cacheDir The cache directory
|
EXPLAIN FORMAT=JSON Differences From MySQL EXPLAIN FORMAT=JSON output in MySQL and MariaDB. MariaDB's EXPLAIN JSON output is different from MySQL's. Here's a list of differences. (Currently they come in no particular order). Attached Conditions are Prettier MySQL prints conditions with too many quotes and braces. Also, subqueries are printed in full (despite that you also get a plan for this subquery). You see something like this: "attached_condition": "((`test`.`t1`.`a` < (/* select#2 */ select min(`test`.`t10`.`b`) from `test`.`t10`)) or (`test`.`t1`.`a` > (/* select#3 */ select max(`test`.`t10`.`b`) from `test`.`t10`)))",
"attached_condition": "((`test`.`t20`.`col1` > `test`.`t20`.`col2`) or (`test`.`t20`.`col3` = 4))"
in MariaDB, the same conditions are printed like this: "attached_condition": "((t1.a < (subquery#2)) or (t1.a > (subquery#3)))"
"attached_condition": "((t20.col1 > t20.col2) or (t20.col3 = 4))"
JSON Pretty-printer is Smarter MySQL's JSON pretty-printer is pretty dumb: "possible_keys": [
"a"
],
"key": "a",
"used_key_parts": [
"a"
],
MariaDB's JSON pretty-printer is a bit smarter: "possible_keys": ["a"],
"key": "a",
"key_length": "5",
"used_key_parts": ["a"],
Index Merge Shows used_key_parts For multi-part keys, tabular EXPLAIN shows key_length column and leaves the user to do column-size arithmetic to figure out how many key parts are used. MySQL's EXPLAIN=JSON may show used_key_parts member which shows which key parts are used. For range access, key_length is also provided: "access_type": "range",
"possible_keys": [
"col1"
],
"key": "col1",
"used_key_parts": [
"col1",
"col2"
],
"key_length": "10",
But if you are using index_merge, you will still have to decode key_length: "table": {
"table_name": "t22",
"access_type": "index_merge",
"possible_keys": [
"col1",
"col3"
],
"key": "sort_union(col1,col3)",
"key_length": "10,5",
"rows": 2398,
In MariaDB, you get used_key_parts for all parts of index_merge: "table_name": "t22",
"access_type": "index_merge",
"possible_keys": ["col1", "col3"],
"key_length": "10,5",
"index_merge": {
"sort_union": {
"range": {
"key": "col1",
"used_key_parts": ["col1", "col2"]
},
"range": {
"key": "col3",
"used_key_parts": ["col3"]
}
}
Range Checked for Each Record In MySQL, you need to decode hex index number bitmaps (like in the tabular form): "table": {
"table_name": "t2",
"access_type": "ALL",
"possible_keys": [
"key1",
"key3"
],
"rows": 1000,
"filtered": 100,
"range_checked_for_each_record": "index map: 0x5"
}
In MariaDB, the keys are shown explicitly "range-checked-for-each-record": {
"keys": ["key1", "key3"],
"table": {
"table_name": "t2",
"access_type": "ALL",
"possible_keys": ["key1", "key3"],
"rows": 1000,
"filtered": 100
}
also, the structure of display ("range checked ..." embeds the table access) is closer to query plan's structure. (TODO: should we move "range-checked-for-each-record" inside the "table" ? ) Full Scan on NULL Key Tabular EXPLAIN shows "Full scan on NULL key" in the Extra column. MySQL has made a direct translation to JSON: "table": {
"table_name": "t1",
"access_type": "ref_or_null",
...
...
"rows": 2,
"filtered": 100,
"using_index": true,
"full_scan_on_NULL_key": true,
...
}
This is not appropriate for MariaDB because it would like to have place for ANALYZE to show #loops for each construct. It is also illogical - some attribute at the end says "btw all of the above is not used in some cases". Because of that, MariaDB uses: "full-scan-on-null_key": {
"table": {
"table_name": "t1",
"access_type": "ref_or_null",
"possible_keys": ["a"],
"key": "a",
...
}
Join Buffer Plan is Shown in Greater Detail. MySQL displays "using join buffer" as just another kind of table access. It doesn't separate reading from join buffer and writing to join buffer. "nested_loop": [
{
"table": {
"table_name": "A",
"access_type": "ALL",
"rows": 10,
"filtered": 100,
"attached_condition": "(`test`.`A`.`b` = 3)"
}
},
{
"table": {
"table_name": "B",
"access_type": "ALL",
"rows": 20,
"filtered": 100,
"using_join_buffer": "Block Nested Loop",
"attached_condition": "((`test`.`B`.`b` = 4) and ((`test`.`A`.`a` + `test`.`B`.`a`) < 3))"
}
}
MariaDB shows what is really is going on: "table": {
"table_name": "A",
"access_type": "ALL",
"rows": 10,
"filtered": 100,
"attached_condition": "(A.b = 3)"
},
"block-nl-join": {
"table": {
"table_name": "B",
"access_type": "ALL",
"rows": 10,
"filtered": 100,
"attached_condition": "(B.b = 4)"
},
"buffer_type": "flat",
"buffer_size": "128Kb",
"join_type": "BNL",
"attached_condition": "((A.a + B.a) < 3)"
}
TODO: other differences Content reproduced on this site is the property of its respective owners, and this content is not reviewed in advance by MariaDB. The views, information and opinions expressed by this content do not necessarily represent those of MariaDB or any other party.
|
tf.raw_ops.TextLineDataset Creates a dataset that emits the lines of one or more text files. View aliases Compat aliases for migration
See Migration guide for more details. tf.compat.v1.raw_ops.TextLineDataset
tf.raw_ops.TextLineDataset(
filenames, compression_type, buffer_size, metadata='', name=None
)
Args
filenames A Tensor of type string. A scalar or a vector containing the name(s) of the file(s) to be read.
compression_type A Tensor of type string. A scalar containing either (i) the empty string (no compression), (ii) "ZLIB", or (iii) "GZIP".
buffer_size A Tensor of type int64. A scalar containing the number of bytes to buffer.
metadata An optional string. Defaults to "".
name A name for the operation (optional).
Returns A Tensor of type variant.
|
[Java] Class BinaryExpressionWriter
org.codehaus.groovy.classgen.asm.BinaryExpressionWriter
public abstract class BinaryExpressionWriter
extends Object Base class for writing primitive typed operations Field Summary
Fields
Modifiers Name Description
protected static int[] stdCompareCodes Constructor Summary
Constructors
Constructor and description BinaryExpressionWriter(WriterController controller, MethodCaller arraySet, MethodCaller arrayGet)
Methods Summary
Methods
Type Params Return Type Name and description public boolean
arrayGet(int operation, boolean simulate)
public boolean
arraySet(boolean simulate)
protected abstract void
doubleTwoOperands(org.objectweb.asm.MethodVisitor mv)
protected MethodCaller
getArrayGetCaller()
protected ClassNode
getArrayGetResultType()
protected MethodCaller
getArraySetCaller()
protected abstract int
getBitwiseOperationBytecode(int type)
protected abstract int
getCompareCode()
public WriterController
getController()return writer controller protected abstract ClassNode
getDevisionOpResultType()
protected abstract ClassNode
getNormalOpResultType()
protected abstract int
getShiftOperationBytecode(int type)
protected abstract int
getStandardOperationBytecode(int type)
protected abstract void
removeTwoOperands(org.objectweb.asm.MethodVisitor mv)
public void
setArraySetAndGet(MethodCaller arraySet, MethodCaller arrayGet)
protected boolean
supportsDivision()
public boolean
write(int operation, boolean simulate)
protected boolean
writeBitwiseOp(int type, boolean simulate)writes some the bitwise operations. type is one of BITWISE_OR, BITWISE_AND, BITWISE_XOR protected boolean
writeDivision(boolean simulate)
protected abstract void
writeMinusMinus(org.objectweb.asm.MethodVisitor mv)
protected abstract void
writePlusPlus(org.objectweb.asm.MethodVisitor mv)
public boolean
writePostOrPrefixMethod(int operation, boolean simulate)
protected boolean
writeShiftOp(int type, boolean simulate)Write shifting operations. protected boolean
writeSpaceship(int type, boolean simulate)
protected boolean
writeStdCompare(int type, boolean simulate)writes some int standard operations for compares protected boolean
writeStdOperators(int type, boolean simulate)
Inherited Methods Summary
Inherited Methods
Methods inherited from class Name class Object wait, wait, wait, equals, toString, hashCode, getClass, notify, notifyAll Field Detail protected static final int[] stdCompareCodes
Constructor Detail public BinaryExpressionWriter(WriterController controller, MethodCaller arraySet, MethodCaller arrayGet) Method Detail public boolean arrayGet(int operation, boolean simulate) public boolean arraySet(boolean simulate) protected abstract void doubleTwoOperands(org.objectweb.asm.MethodVisitor mv) protected MethodCaller getArrayGetCaller() protected ClassNode getArrayGetResultType() protected MethodCaller getArraySetCaller() protected abstract int getBitwiseOperationBytecode(int type) protected abstract int getCompareCode() public WriterController getController() return writer controller
Since:
2.5.0
protected abstract ClassNode getDevisionOpResultType() protected abstract ClassNode getNormalOpResultType() protected abstract int getShiftOperationBytecode(int type) protected abstract int getStandardOperationBytecode(int type) protected abstract void removeTwoOperands(org.objectweb.asm.MethodVisitor mv) public void setArraySetAndGet(MethodCaller arraySet, MethodCaller arrayGet) protected boolean supportsDivision() public boolean write(int operation, boolean simulate) protected boolean writeBitwiseOp(int type, boolean simulate) writes some the bitwise operations. type is one of BITWISE_OR, BITWISE_AND, BITWISE_XOR
Parameters:
type - the token type
Returns:
true if a successful bitwise operation write
protected boolean writeDivision(boolean simulate) protected abstract void writeMinusMinus(org.objectweb.asm.MethodVisitor mv) protected abstract void writePlusPlus(org.objectweb.asm.MethodVisitor mv) public boolean writePostOrPrefixMethod(int operation, boolean simulate) protected boolean writeShiftOp(int type, boolean simulate) Write shifting operations. Type is one of LEFT_SHIFT, RIGHT_SHIFT, or RIGHT_SHIFT_UNSIGNED
Parameters:
type - the token type
Returns:
true on a successful shift operation write
protected boolean writeSpaceship(int type, boolean simulate) protected boolean writeStdCompare(int type, boolean simulate) writes some int standard operations for compares
Parameters:
type - the token type
Returns:
true if a successful std operator write
protected boolean writeStdOperators(int type, boolean simulate)
|
CoreExtension class CoreExtension extends AbstractExtension Represents the main form extension, which loads the core functionality. Methods FormTypeInterface getType(string $name) Returns a type by name. from AbstractExtension bool hasType(string $name) Returns whether the given type is supported. from AbstractExtension FormTypeExtensionInterface[] getTypeExtensions(string $name) Returns the extensions for the given type. from AbstractExtension bool hasTypeExtensions(string $name) Returns whether this extension provides type extensions for the given type. from AbstractExtension FormTypeGuesserInterface|null getTypeGuesser() Returns the type guesser provided by this extension. from AbstractExtension __construct(PropertyAccessorInterface $propertyAccessor = null, ChoiceListFactoryInterface $choiceListFactory = null)
Details FormTypeInterface
getType(string $name)
Returns a type by name. Parameters string $name The name of the type Return Value FormTypeInterface The type Exceptions InvalidArgumentException if the given type is not supported by this extension bool
hasType(string $name)
Returns whether the given type is supported. Parameters string $name The name of the type Return Value bool Whether the type is supported by this extension FormTypeExtensionInterface[]
getTypeExtensions(string $name)
Returns the extensions for the given type. Parameters string $name The name of the type Return Value
FormTypeExtensionInterface[] An array of extensions as FormTypeExtensionInterface instances bool
hasTypeExtensions(string $name)
Returns whether this extension provides type extensions for the given type. Parameters string $name The name of the type Return Value bool Whether the given type has extensions FormTypeGuesserInterface|null
getTypeGuesser()
Returns the type guesser provided by this extension. Return Value
FormTypeGuesserInterface|null The type guesser
__construct(PropertyAccessorInterface $propertyAccessor = null, ChoiceListFactoryInterface $choiceListFactory = null)
Parameters PropertyAccessorInterface $propertyAccessor ChoiceListFactoryInterface $choiceListFactory
|
wp_parse_id_list( array|string $list ): int[] Cleans up an array, comma- or space-separated list of IDs. Parameters $list array|string Required List of IDs. Return int[] Sanitized array of IDs. Source File: wp-includes/functions.php. View all references function wp_parse_id_list( $list ) {
$list = wp_parse_list( $list );
return array_unique( array_map( 'absint', $list ) );
}
Related Uses Uses Description wp_parse_list() wp-includes/functions.php Converts a comma- or space-separated list of scalar values to an array.
Used By Used By Description WP_Privacy_Requests_Tabl8b7c:f320:99b9:690f:4595:cd17:293a:c069process_bulk_action() wp-admin/includes/class-wp-privacy-requests-table.php Process bulk actions. WP_Widget_Media_Gallery8b7c:f320:99b9:690f:4595:cd17:293a:c069has_content() wp-includes/widgets/class-wp-widget-media-gallery.php Whether the widget has content to show. WP_Customize_Nav_Menus8b7c:f320:99b9:690f:4595:cd17:293a:c069sanitize_nav_menus_created_posts() wp-includes/class-wp-customize-nav-menus.php Sanitizes post IDs for posts created for nav menu items to be published. WP_Term_Query8b7c:f320:99b9:690f:4595:cd17:293a:c069get_terms() wp-includes/class-wp-term-query.php Retrieves the query results. WP_Term_Query8b7c:f320:99b9:690f:4595:cd17:293a:c069parse_orderby() wp-includes/class-wp-term-query.php Parse and sanitize ‘orderby’ keys passed to the term query. WP_Network_Query8b7c:f320:99b9:690f:4595:cd17:293a:c069get_network_ids() wp-includes/class-wp-network-query.php Used internally to get a list of network IDs matching the query vars. WP_Site_Query8b7c:f320:99b9:690f:4595:cd17:293a:c069get_site_ids() wp-includes/class-wp-site-query.php Used internally to get a list of site IDs matching the query vars. WP_Comment_Query8b7c:f320:99b9:690f:4595:cd17:293a:c069get_comment_ids() wp-includes/class-wp-comment-query.php Used internally to get a list of comment IDs matching the query vars. WP_User_Query8b7c:f320:99b9:690f:4595:cd17:293a:c069parse_orderby() wp-includes/class-wp-user-query.php Parses and sanitizes ‘orderby’ keys passed to the user query. wp_list_categories() wp-includes/category-template.php Displays or retrieves the HTML list of categories. WP_Tax_Query8b7c:f320:99b9:690f:4595:cd17:293a:c069lean_query() wp-includes/class-wp-tax-query.php Validates a single query. WP_Tax_Query8b7c:f320:99b9:690f:4595:cd17:293a:c069transform_query() wp-includes/class-wp-tax-query.php Transforms a single query, from one field to another. WP_User_Query8b7c:f320:99b9:690f:4595:cd17:293a:c069prepare_query() wp-includes/class-wp-user-query.php Prepares the query variables. get_pages() wp-includes/post.php Retrieves an array of pages (or hierarchical post type items). get_posts() wp-includes/post.php Retrieves an array of the latest posts, or posts matching the given criteria. get_bookmarks() wp-includes/bookmark.php Retrieves the list of bookmarks.
Changelog Version Description 5.1.0 Refactored to use wp_parse_list() . 3.0.0 Introduced.
|
streamWrapper8b7c:f320:99b9:690f:4595:cd17:293a:c069stream_open (PHP 4 >= 4.3.2, PHP 5, PHP 7, PHP 8)
streamWrapper8b7c:f320:99b9:690f:4595:cd17:293a:c069stream_open — Opens file or URL Description public streamWrapper8b7c:f320:99b9:690f:4595:cd17:293a:c069stream_open(
string $path,
string $mode,
int $options,
?string &$opened_path
): bool This method is called immediately after the wrapper is initialized (f.e. by fopen() and file_get_contents()). Parameters
path
Specifies the URL that was passed to the original function.
Note:
The URL can be broken apart with parse_url(). Note that only URLs delimited by :// are supported. : and :/ while technically valid URLs, are not. mode
The mode used to open the file, as detailed for fopen().
Note:
Remember to check if the mode is valid for the path requested. options
Holds additional flags set by the streams API. It can hold one or more of the following values OR'd together.
Flag Description STREAM_USE_PATH If path is relative, search for the resource using the include_path. STREAM_REPORT_ERRORS If this flag is set, you are responsible for raising errors using trigger_error() during opening of the stream. If this flag is not set, you should not raise any errors. 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 Values Returns true on success or false on failure. Errors/Exceptions Emits E_WARNING if call to this method fails (i.e. not implemented). Notes
Note:
The streamWrapper8b7c:f320:99b9:690f:4595:cd17:293a:c069$context property is updated if a valid context is passed to the caller function.
See Also
fopen() - Opens file or URL parse_url() - Parse a URL and return its components
|
signup_another_blog( string $blogname = '', string $blog_title = '', WP_Error|string $errors = '' ) Shows a form for returning users to sign up for another site. Parameters $blogname string Optional The new site name Default: '' $blog_title string Optional The new site title. Default: '' $errors WP_Error|string Optional A WP_Error object containing existing errors. Defaults to empty string. Default: '' Source File: wp-signup.php. View all references function signup_another_blog( $blogname = '', $blog_title = '', $errors = '' ) {
$current_user = wp_get_current_user();
if ( ! is_wp_error( $errors ) ) {
$errors = new WP_Error();
}
$signup_defaults = array(
'blogname' => $blogname,
'blog_title' => $blog_title,
'errors' => $errors,
);
/**
* Filters the default site sign-up variables.
*
* @since 3.0.0
*
* @param array $signup_defaults {
* An array of default site sign-up variables.
*
* @type string $blogname The site blogname.
* @type string $blog_title The site title.
* @type WP_Error $errors A WP_Error object possibly containing 'blogname' or 'blog_title' errors.
* }
*/
$filtered_results = apply_filters( 'signup_another_blog_init', $signup_defaults );
$blogname = $filtered_results['blogname'];
$blog_title = $filtered_results['blog_title'];
$errors = $filtered_results['errors'];
/* translators: %s: Network title. */
echo '<h2>' . sprintf( __( 'Get <em>another</em> %s site in seconds' ), get_network()->site_name ) . '</h2>';
if ( $errors->has_errors() ) {
echo '<p>' . __( 'There was a problem, please correct the form below and try again.' ) . '</p>';
}
?>
<p>
<?php
printf(
/* translators: %s: Current user's display name. */
__( 'Welcome back, %s. By filling out the form below, you can <strong>add another site to your account</strong>. There is no limit to the number of sites you can have, so create to your heart’s content, but write responsibly!' ),
$current_user->display_name
);
?>
</p>
<?php
$blogs = get_blogs_of_user( $current_user->ID );
if ( ! empty( $blogs ) ) {
?>
<p><?php _e( 'Sites you are already a member of:' ); ?></p>
<ul>
<?php
foreach ( $blogs as $blog ) {
$home_url = get_home_url( $blog->userblog_id );
echo '<li><a href="' . esc_url( $home_url ) . '">' . $home_url . '</a></li>';
}
?>
</ul>
<?php } ?>
<p><?php _e( 'If you are not going to use a great site domain, leave it for a new user. Now have at it!' ); ?></p>
<form id="setupform" method="post" action="wp-signup.php">
<input type="hidden" name="stage" value="gimmeanotherblog" />
<?php
/**
* Hidden sign-up form fields output when creating another site or user.
*
* @since MU (3.0.0)
*
* @param string $context A string describing the steps of the sign-up process. The value can be
* 'create-another-site', 'validate-user', or 'validate-site'.
*/
do_action( 'signup_hidden_fields', 'create-another-site' );
?>
<?php show_blog_form( $blogname, $blog_title, $errors ); ?>
<p class="submit"><input type="submit" name="submit" class="submit" value="<?php esc_attr_e( 'Create Site' ); ?>" /></p>
</form>
<?php
}
Hooks apply_filters( 'signup_another_blog_init', array $signup_defaults )
Filters the default site sign-up variables. do_action( 'signup_hidden_fields', string $context )
Hidden sign-up form fields output when creating another site or user. Related Uses Uses Description get_network() wp-includes/ms-network.php Retrieves network data given a network ID or network object. show_blog_form() wp-signup.php Generates and displays the Sign-up and Create Site forms. esc_attr_e() wp-includes/l10n.php Displays translated text that has been escaped for safe use in an attribute. wp_get_current_user() wp-includes/pluggable.php Retrieves the current user object. get_home_url() wp-includes/link-template.php Retrieves the URL for a given site where the front end is accessible. get_blogs_of_user() wp-includes/user.php Gets the sites a user belongs to. __() wp-includes/l10n.php Retrieves the translation of $text. _e() wp-includes/l10n.php Displays translated text. esc_url() wp-includes/formatting.php Checks and cleans a URL. apply_filters() wp-includes/plugin.php Calls the callback functions that have been added to a filter hook. do_action() wp-includes/plugin.php Calls the callback functions that have been added to an action hook. is_wp_error() wp-includes/load.php Checks whether the given variable is a WordPress Error. WP_Error8b7c:f320:99b9:690f:4595:cd17:293a:c069__construct() wp-includes/class-wp-error.php Initializes the error.
Used By Used By Description validate_another_blog_signup() wp-signup.php Validates a new site sign-up for an existing user.
Changelog Version Description MU (3.0.0) Introduced.
|
Class HelpCommand Print out command list Namespace: Cake\Console\Command Constants int CODE_ERROR 1 Default error code int CODE_SUCCESS 0 Default success code Property Summary $commands protected Cake\Console\CommandCollection The command collection to get help on. $name protected string The name of this command. Method Summary abort() public Halt the the current process with a StopException. asText() protected Output text. asXml() protected Output as XML buildOptionParser() protected Gets the option parser instance and configures it. defaultName() public static Get the command name. displayHelp() protected Output help content execute() public Main function Prints out the list of commands. executeCommand() public Execute another command with the provided set of arguments. getName() public Get the command name. getOptionParser() public Get the option parser. getRootName() public Get the root command name. getShortestName() protected initialize() public Hook method invoked by CakePHP when a command is about to be executed. outputPaths() protected Output relevant paths if defined run() public Run the command. setCommandCollection() public Set the command collection being used. setName() public Set the name this command uses in the collection. setOutputLevel() protected Set the output level based on the Arguments. Method Detail abort() public abort(int $code = sel8b7c:f320:99b9:690f:4595:cd17:293a:c069CODE_ERROR): void Halt the the current process with a StopException. Parameters int $code optional The exit code to use. Returns void Throws Cake\Console\Exception\StopException asText() protected asText(Cake\Console\ConsoleIo $io, iterable $commands): void Output text. Parameters Cake\Console\ConsoleIo $io The console io iterable $commands The command collection to output. Returns void asXml() protected asXml(Cake\Console\ConsoleIo $io, iterable $commands): void Output as XML Parameters Cake\Console\ConsoleIo $io The console io iterable $commands The command collection to output Returns void buildOptionParser() protected buildOptionParser(Cake\Console\ConsoleOptionParser $parser): Cake\Console\ConsoleOptionParser Gets the option parser instance and configures it. Parameters Cake\Console\ConsoleOptionParser $parser The parser to build Returns Cake\Console\ConsoleOptionParser defaultName() public static defaultName(): string Get the command name. Returns the command name based on class name. For e.g. for a command with class name UpdateTableCommand the default name returned would be 'update_table'. Returns string displayHelp() protected displayHelp(Cake\Console\ConsoleOptionParser $parser, Cake\Console\Arguments $args, Cake\Console\ConsoleIo $io): void Output help content Parameters Cake\Console\ConsoleOptionParser $parser The option parser. Cake\Console\Arguments $args The command arguments. Cake\Console\ConsoleIo $io The console io Returns void execute() public execute(Cake\Console\Arguments $args, Cake\Console\ConsoleIo $io): int Main function Prints out the list of commands. Parameters Cake\Console\Arguments $args The command arguments. Cake\Console\ConsoleIo $io The console io Returns int executeCommand() public executeCommand(stringCake\Console\CommandInterface $command, array $args = [], Cake\Console\ConsoleIo $io = null): int|null Execute another command with the provided set of arguments. If you are using a string command name, that command's dependencies will not be resolved with the application container. Instead you will need to pass the command as an object with all of its dependencies. Parameters stringCake\Console\CommandInterface $command The command class name or command instance. array $args optional The arguments to invoke the command with. Cake\Console\ConsoleIo $io optional The ConsoleIo instance to use for the executed command. Returns int|null getName() public getName(): string Get the command name. Returns string getOptionParser() public getOptionParser(): Cake\Console\ConsoleOptionParser Get the option parser. You can override buildOptionParser() to define your options & arguments. Returns Cake\Console\ConsoleOptionParser Throws RuntimeException When the parser is invalid getRootName() public getRootName(): string Get the root command name. Returns string getShortestName() protected getShortestName(string[] $names): string Parameters string[] $names Names Returns string initialize() public initialize(): void Hook method invoked by CakePHP when a command is about to be executed. Override this method and implement expensive/important setup steps that should not run on every command run. This method will be called before the options and arguments are validated and processed. Returns void outputPaths() protected outputPaths(Cake\Console\ConsoleIo $io): void Output relevant paths if defined Parameters Cake\Console\ConsoleIo $io IO object. Returns void run() public run(array $argv, Cake\Console\ConsoleIo $io): int|null Run the command. Parameters array $argv Cake\Console\ConsoleIo $io Returns int|null setCommandCollection() public setCommandCollection(Cake\Console\CommandCollection $commands): void Set the command collection being used. Parameters Cake\Console\CommandCollection $commands Returns void setName() public setName(string $name): $this Set the name this command uses in the collection. Generally invoked by the CommandCollection when the command is added. Required to have at least one space in the name so that the root command can be calculated. Parameters string $name Returns $this setOutputLevel() protected setOutputLevel(Cake\Console\Arguments $args, Cake\Console\ConsoleIo $io): void Set the output level based on the Arguments. Parameters Cake\Console\Arguments $args The command arguments. Cake\Console\ConsoleIo $io The console io Returns void Property Detail $commands protected The command collection to get help on. Type Cake\Console\CommandCollection $name protected The name of this command. Type string
|
apply_filters( 'is_wide_widget_in_customizer', bool $is_wide, string $widget_id ) Filters whether the given widget is considered “wide”. Parameters $is_wide bool Whether the widget is wide, Default false. $widget_id string Widget ID. Source File: wp-includes/class-wp-customize-widgets.php. View all references return apply_filters( 'is_wide_widget_in_customizer', $is_wide, $widget_id );
Related Used By Used By Description WP_Customize_Widgets8b7c:f320:99b9:690f:4595:cd17:293a:c069is_wide_widget() wp-includes/class-wp-customize-widgets.php Determines whether the widget is considered “wide”.
Changelog Version Description 3.9.0 Introduced.
|
class Fiddl8b7c:f320:99b9:690f:4595:cd17:293a:c069Closur8b7c:f320:99b9:690f:4595:cd17:293a:c069BlockCaller
Parent:
Fiddl8b7c:f320:99b9:690f:4595:cd17:293a:c069Closure
Extends Fiddl8b7c:f320:99b9:690f:4595:cd17:293a:c069Closure to allow for building the closure in a block Public Class Methods new(ctype, args, abi = Fiddl8b7c:f320:99b9:690f:4595:cd17:293a:c069Function8b7c:f320:99b9:690f:4595:cd17:293a:c069ULT, &block) Show source
# File ext/fiddle/lib/fiddle/closure.rb, line 35
def initialize ctype, args, abi = Fiddl8b7c:f320:99b9:690f:4595:cd17:293a:c069Function8b7c:f320:99b9:690f:4595:cd17:293a:c069ULT, &block
super(ctype, args, abi)
@block = block
end Description Construct a new BlockCaller object.
ctype is the C type to be returned
args are passed the callback
abi is the abi of the closure
If there is an error in preparing the ffi_cif or ffi_prep_closure, then a RuntimeError will be raised. Example include Fiddle
cb = Closur8b7c:f320:99b9:690f:4595:cd17:293a:c069BlockCaller.new(TYPE_INT, [TYPE_INT]) do |one|
one
end
func = Function.new(cb, [TYPE_INT], TYPE_INT)
Calls superclass method Fiddl8b7c:f320:99b9:690f:4595:cd17:293a:c069Closur8b7c:f320:99b9:690f:4595:cd17:293a:c069new Public Instance Methods call(*args) Show source
# File ext/fiddle/lib/fiddle/closure.rb, line 44
def call *args
@block.call(*args)
end Calls the constructed BlockCaller, with args For an example see Fiddl8b7c:f320:99b9:690f:4595:cd17:293a:c069Closur8b7c:f320:99b9:690f:4595:cd17:293a:c069BlockCaller.new
Ruby Core © 1993–2017 Yukihiro MatsumotoLicensed under the Ruby License.Ruby Standard Library |
QGeoPath Class The QGeoPath class defines a geographic path. More...
Header:
#include <QGeoPath>
qmake:
QT += positioning
Since:
Qt 5.9
Inherits:
QGeoShape
List of all members, including inherited members Properties
path : QList<QGeoCoordinate>
width : qreal 3 properties inherited from QGeoShape
Public Functions
QGeoPath()
QGeoPath(const QList<QGeoCoordinate> &path, const qreal &width = 0.0)
QGeoPath(const QGeoPath &other)
QGeoPath(const QGeoShape &other)
~QGeoPath()
void
addCoordinate(const QGeoCoordinate &coordinate)
bool
containsCoordinate(const QGeoCoordinate &coordinate) const
QGeoCoordinate
coordinateAt(int index) const
void
insertCoordinate(int index, const QGeoCoordinate &coordinate)
double
length(int indexFrom = 0, int indexTo = -1) const
const QList<QGeoCoordinate> &
path() const
void
removeCoordinate(const QGeoCoordinate &coordinate)
void
removeCoordinate(int index)
void
replaceCoordinate(int index, const QGeoCoordinate &coordinate)
void
setPath(const QList<QGeoCoordinate> &path)
void
setWidth(const qreal &width)
QString
toString() const
void
translate(double degreesLatitude, double degreesLongitude)
QGeoPath
translated(double degreesLatitude, double degreesLongitude) const
qreal
width() const
bool
operator!=(const QGeoPath &other) const
QGeoPath &
operator=(const QGeoPath &other)
bool
operator==(const QGeoPath &other) const
10 public functions inherited from QGeoShape
Detailed Description The QGeoPath class defines a geographic path. The path is defined by an ordered list of QGeoCoordinates. Each two adjacent elements in the path are intended to be connected together by the shortest line segment of constant bearing passing through both elements. This type of connection can cross the dateline in the longitudinal direction, but never crosses the poles. This is relevant for the calculation of the bounding box returned by QGeoShap8b7c:f320:99b9:690f:4595:cd17:293a:c069boundingGeoRectangle() for this shape, which will have the latitude of the top left corner set to the maximum latitude in the path point set. Similarly, the latitude of the bottom right corner will be the minimum latitude in the path point set. This class is a Q_GADGET. It can be directly used from C++ and QML. Property Documentation
path : QList<QGeoCoordinate> This property holds the list of coordinates for the geo path. The path is both invalid and empty if it contains no coordinate. A default constructed QGeoPath is therefore invalid. Access functions:
const QList<QGeoCoordinate> &
path() const
void
setPath(const QList<QGeoCoordinate> &path)
width : qreal
Access functions:
qreal
width() const
void
setWidth(const qreal &width)
Member Function Documentation
QGeoPath8b7c:f320:99b9:690f:4595:cd17:293a:c069QGeoPath() Constructs a new, empty geo path.
QGeoPath8b7c:f320:99b9:690f:4595:cd17:293a:c069QGeoPath(const QList<QGeoCoordinate> &path, const qreal &width = 0.0) Constructs a new geo path from a list of coordinates (path and width).
QGeoPath8b7c:f320:99b9:690f:4595:cd17:293a:c069QGeoPath(const QGeoPath &other) Constructs a new geo path from the contents of other.
QGeoPath8b7c:f320:99b9:690f:4595:cd17:293a:c069QGeoPath(const QGeoShape &other) Constructs a new geo path from the contents of other.
QGeoPath8b7c:f320:99b9:690f:4595:cd17:293a:c069~QGeoPath() Destroys this path.
void QGeoPath8b7c:f320:99b9:690f:4595:cd17:293a:c069oordinate(const QGeoCoordinate &coordinate) Appends coordinate to the path.
bool QGeoPath8b7c:f320:99b9:690f:4595:cd17:293a:c069ontainsCoordinate(const QGeoCoordinate &coordinate) const Returns true if the path contains coordinate as one of the elements.
QGeoCoordinate QGeoPath8b7c:f320:99b9:690f:4595:cd17:293a:c069oordinateAt(int index) const Returns the coordinate at index .
void QGeoPath8b7c:f320:99b9:690f:4595:cd17:293a:c069insertCoordinate(int index, const QGeoCoordinate &coordinate) Inserts coordinate at the specified index.
double QGeoPath8b7c:f320:99b9:690f:4595:cd17:293a:c069length(int indexFrom = 0, int indexTo = -1) const Returns the length of the path, in meters, from the element indexFrom to the element indexTo. The length is intended to be the sum of the shortest distances for each pair of adjacent points.
const QList<QGeoCoordinate> &QGeoPath8b7c:f320:99b9:690f:4595:cd17:293a:c069path() const Returns all the elements. Equivalent to QGeoShap8b7c:f320:99b9:690f:4595:cd17:293a:c069center(). The center coordinate, in case of a QGeoPath, is the center of its bounding box. Note: Getter function for property path.
See also setPath().
void QGeoPath8b7c:f320:99b9:690f:4595:cd17:293a:c069removeCoordinate(const QGeoCoordinate &coordinate) Removes the last occurrence of coordinate from the path.
void QGeoPath8b7c:f320:99b9:690f:4595:cd17:293a:c069removeCoordinate(int index) Removes element at position index from the path.
void QGeoPath8b7c:f320:99b9:690f:4595:cd17:293a:c069replaceCoordinate(int index, const QGeoCoordinate &coordinate) Replaces the path element at the specified index with coordinate.
QString QGeoPath8b7c:f320:99b9:690f:4595:cd17:293a:c069toString() const Returns the geo path properties as a string.
void QGeoPath8b7c:f320:99b9:690f:4595:cd17:293a:c069translate(double degreesLatitude, double degreesLongitude) Translates this geo path by degreesLatitude northwards and degreesLongitude eastwards. Negative values of degreesLatitude and degreesLongitude correspond to southward and westward translation respectively.
QGeoPath QGeoPath8b7c:f320:99b9:690f:4595:cd17:293a:c069translated(double degreesLatitude, double degreesLongitude) const Returns a copy of this geo path translated by degreesLatitude northwards and degreesLongitude eastwards. Negative values of degreesLatitude and degreesLongitude correspond to southward and westward translation respectively. See also translate().
qreal QGeoPath8b7c:f320:99b9:690f:4595:cd17:293a:c069width() const Returns the width of the path, in meters. This information is used in the contains method The default value is 0. Note: Getter function for property width.
See also setWidth().
bool QGeoPath8b7c:f320:99b9:690f:4595:cd17:293a:c069operator!=(const QGeoPath &other) const Returns whether this geo path is not equal to other.
QGeoPath &QGeoPath8b7c:f320:99b9:690f:4595:cd17:293a:c069operator=(const QGeoPath &other) Assigns other to this geo path and returns a reference to this geo path.
bool QGeoPath8b7c:f320:99b9:690f:4595:cd17:293a:c069operator==(const QGeoPath &other) const Returns whether this geo path is equal to other.
|
Migration class Migration (View source) Properties protected string $connection The name of the database connection to use. Methods string getConnection() Get the migration connection name. Details string
getConnection()
Get the migration connection name. Return Value string
|
pandas.core.groupby.DataFrameGroupBy.idxmin
DataFrameGroupBy.idxmin
Return index of first occurrence of minimum over requested axis. NA/null values are excluded.
Parameters:
axis : {0 or ‘index’, 1 or ‘columns’}, default 0 0 or ‘index’ for row-wise, 1 or ‘columns’ for column-wise skipna : boolean, default True Exclude NA/null values. If an entire row/column is NA, the result will be NA.
Returns:
idxmin : Series
Raises:
ValueError If the row/column is empty See also Series.idxmin Notes This method is the DataFrame version of ndarray.argmin.
|
tf.keras.layers.experimental.preprocessing.CenterCrop Crop the central portion of the images to target height and width. Inherits From: Layer View aliases Compat aliases for migration
See Migration guide for more details. tf.compat.v1.keras.layers.experimental.preprocessing.CenterCrop
tf.keras.layers.experimental.preprocessing.CenterCrop(
height, width, name=None, **kwargs
)
Input shape: 4D tensor with shape: (samples, height, width, channels), data_format='channels_last'. Output shape: 4D tensor with shape: (samples, target_height, target_width, channels). If the input height/width is even and the target height/width is odd (or inversely), the input image is left-padded by 1 pixel.
Arguments
height Integer, the height of the output shape.
width Integer, the width of the output shape.
name A string, the name of the layer.
|
Buffer QML Type Defines a buffer to be used for a pass of a CustomMaterial. More...
Import Statement:
import QtQuick3D.Materials 1.14
List of all members, including inherited members Properties
bufferFlags : enumeration
format : enumeration
name : string
sizeMultiplier : real
textureCoordOperation : enumeration
textureFilterOperation : enumeration Detailed Description
Property Documentation bufferFlags : enumeration Specifies the buffer allocation flags.
Constant
Description
Buffer.None
Value not set.
Buffer.SceneLifetime
The buffer is allocated for the whole lifetime of the scene.
format : enumeration Specifies the buffer format.
Constant
Value
Buffer.Unknown Buffer.R8 Buffer.R16 Buffer.R16F Buffer.R32I Buffer.R32UI Buffer.R32F Buffer.RG8 Buffer.RGBA8 Buffer.RGB8 Buffer.SRGB8 Buffer.SRGB8A8 Buffer.RGB565 Buffer.RGBA16F Buffer.RG16F Buffer.RG32F Buffer.RGB32F Buffer.RGBA32F Buffer.R11G11B10 Buffer.RGB9E5 Buffer.Depth16 Buffer.Depth24 Buffer.Depth32 Buffer.Depth24Stencil8 name : string Specifies the name of the buffer sizeMultiplier : real Specifies the size multiplier of the buffer. 1.0 creates buffer with the same size while 0.5 creates buffer with width and height halved. textureCoordOperation : enumeration Specifies the texture coordinate operation for coordinates outside [0, 1] range.
Constant
Description
Buffer.Unknown
Value not set.
Buffer.ClampToEdge
Clamp coordinate to edge.
Buffer.MirroredRepeat
Repeat the coordinate, but flip direction at the beginning and end.
Buffer.Repeat
Repeat the coordinate always from the beginning.
textureFilterOperation : enumeration Specifies the filter operation when a render pass is reading the buffer that is different size as the current output buffer.
Constant
Description
Buffer.Unknown
Value not set.
Buffer.Nearest
Use nearest-neighbor.
Buffer.Linear
Use linear filtering.
|
hpe.nimble.hpe_nimble_performance_policy – Manage the HPE Nimble Storage performance policies Note This plugin is part of the hpe.nimble collection (version 1.1.3). You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list. To install it, use: ansible-galaxy collection install hpe.nimble. To use it in a playbook, specify: hpe.nimble.hpe_nimble_performance_policy. New in version 1.0.0: of hpe.nimble Synopsis Requirements Parameters Notes Examples Synopsis Manage the performance policies on an HPE Nimble Storage group. Requirements The below requirements are needed on the host that executes this module. Ansible 2.9 or later Python 3.6 or later HPE Nimble Storage SDK for Python HPE Nimble Storage arrays running NimbleOS 5.0 or later Parameters Parameter Choices/Defaults Comments app_category string Specifies the application category of the associated volume. block_size integer Block Size in bytes to be used by the volumes created with this specific performance policy. Supported block sizes are 4096 bytes (4 KB), 8192 bytes (8 KB), 16384 bytes(16 KB), and 32768 bytes (32 KB). Block size of a performance policy cannot be changed once the performance policy is created. cache boolean
Choices: no yes Flag denoting if data in the associated volume should be cached. cache_policy string
Choices: disabled normal aggressive no_write aggressive_read_no_write Specifies how data of associated volume should be cached. Normal policy caches data but skips in certain conditions such as sequential I/O. Aggressive policy will accelerate caching of all data belonging to this volume, regardless of sequentiality. change_name string Change name of the existing performance policy. compress boolean
Choices: no yes Flag denoting if data in the associated volume should be compressed. dedupe boolean
Choices: no yes Specifies if dedupe is enabled for volumes created with this performance policy. description string Description of a performance policy. host string / required HPE Nimble Storage IP address. name string / required Name of the performance policy. password string / required HPE Nimble Storage password. space_policy string
Choices: invalid offline non_writable read_only login_only Specifies the state of the volume upon space constraint violation such as volume limit violation or volumes above their volume reserve, if the pool free space is exhausted. Supports two policies, 'offline' and 'non_writable'. state string / required
Choices: present absent create The performance policy operation. username string / required HPE Nimble Storage user name. Notes Note This module does not support check_mode. Examples # if state is create , then create a performance policy if not present. Fails if already present.
# if state is present, then create a performance policy if not present. Succeed if it already exists.
- name: Create performance policy if not present
hpe.nimble.hpe_nimble_performance_policy:
host: "{{ host }}"
username: "{{ username }}"
password: "{{ password }}"
state: "{{ state | default('present') }}"
name: "{{ name }}"
description: "{{ description }}"
block_size: "{{ block_size }}"
compress: "{{ compress }}"
- name: Delete performance policy
hpe.nimble.hpe_nimble_performance_policy:
host: "{{ host }}"
username: "{{ username }}"
password: "{{ password }}"
name: "{{ name }}"
state: absent
Authors HPE Nimble Storage Ansible Team (@ar-india) <[email protected]>
© 2012–2018 Michael DeHaan |
WP_Recovery_Mode_Link_Servi8b7c:f320:99b9:690f:4595:cd17:293a:c069__construct( WP_Recovery_Mode_Cookie_Service $cookie_service, WP_Recovery_Mode_Key_Service $key_service ) WP_Recovery_Mode_Link_Service constructor. Parameters $cookie_service WP_Recovery_Mode_Cookie_Service Required Service to handle setting the recovery mode cookie. $key_service WP_Recovery_Mode_Key_Service Required Service to handle generating recovery mode keys. Source File: wp-includes/class-wp-recovery-mode-link-service.php. View all references public function __construct( WP_Recovery_Mode_Cookie_Service $cookie_service, WP_Recovery_Mode_Key_Service $key_service ) {
$this->cookie_service = $cookie_service;
$this->key_service = $key_service;
}
Related Used By Used By Description WP_Recovery_Mo8b7c:f320:99b9:690f:4595:cd17:293a:c069__construct() wp-includes/class-wp-recovery-mode.php WP_Recovery_Mode constructor.
Changelog Version Description 5.2.0 Introduced.
|
wp_admin_css_color( string $key, string $name, string $url, array $colors = array(), array $icons = array() ) Registers an admin color scheme css file. Description Allows a plugin to register a new admin color scheme. For example: wp_admin_css_color( 'classic', __( 'Classic' ), admin_url( "css/colors-classic.css" ), array(
'#07273E', '#14568A', '#D54E21', '#2683AE'
) ); Parameters $key string Required The unique key for this theme. $name string Required The name of the theme. $url string Required The URL of the CSS file containing the color scheme. $colors array Optional An array of CSS color definition strings which are used to give the user a feel for the theme. Default: array() $icons array Optional CSS color definitions used to color any SVG icons.
basestringSVG icon base color.
focusstringSVG icon color on focus.
currentstringSVG icon color of current admin menu link.
Default: array() Source File: wp-includes/general-template.php. View all references function wp_admin_css_color( $key, $name, $url, $colors = array(), $icons = array() ) {
global $_wp_admin_css_colors;
if ( ! isset( $_wp_admin_css_colors ) ) {
$_wp_admin_css_colors = array();
}
$_wp_admin_css_colors[ $key ] = (object) array(
'name' => $name,
'url' => $url,
'colors' => $colors,
'icon_colors' => $icons,
);
}
Related Used By Used By Description register_admin_color_schemes() wp-includes/general-template.php Registers the default admin color schemes.
Changelog Version Description 2.5.0 Introduced.
|
subelements - traverse nested key from a list of dictionaries New in version 1.4. Synopsis Parameters Examples Return Values
Status Author Synopsis Subelements walks a list of hashes (aka dictionaries) and then traverses a list with a given (nested sub-)key inside of those records. Parameters Parameter Choices/Defaults Configuration Comments _terms required tuple of list of dictionaries and dictionary key to extract skip_missing Default:no If set to True, the lookup plugin will skip the lists items that do not contain the given subkey. If False, the plugin will yield an error and complain about the missing subkey. Examples - name: show var structure as it is needed for example to make sense
hosts: all
vars:
users:
- name: alice
authorized:
- /tmp/alice/onekey.pub
- /tmp/alice/twokey.pub
mysql:
password: mysql-password
hosts:
- "%"
- "229-997-0194"
- "8b7c:f320:99b9:690f:4595:cd17:293a:c069"
- "localhost"
privs:
- "*.*:SELECT"
- "DB1.*:ALL"
groups:
- wheel
- name: bob
authorized:
- /tmp/bob/id_rsa.pub
mysql:
password: other-mysql-password
hosts:
- "db1"
privs:
- "*.*:SELECT"
- "DB2.*:ALL"
tasks:
- name: Set authorized ssh key, extracting just that data from 'users'
authorized_key:
user: "{{ item.0.name }}"
key: "{{ lookup('file', item.1) }}"
with_subelements:
- "{{ users }}"
- authorized
- name: Setup MySQL users, given the mysql hosts and privs subkey lists
mysql_user:
name: "{{ item.0.name }}"
password: "{{ item.0.mysql.password }}"
host: "{{ item.1 }}"
priv: "{{ item.0.mysql.privs | join('/') }}"
with_subelements:
- "{{ users }}"
- mysql.hosts
- name: list groups for user that have them, dont error if they don't
debug: var=item
with_list: "{{lookup('subelements', users, 'groups', 'skip_missing=True')}}"
Return Values Common return values are documented here, the following are the fields unique to this lookup: Key Returned Description _list list of subelements extracted Status Author Serge van Ginderachter <[email protected]> Hint If you notice any issues in this documentation you can edit this document to improve it.
© 2012–2018 Michael DeHaan |
FindMPI Find a Message Passing Interface (MPI) implementation The Message Passing Interface (MPI) is a library used to write high-performance distributed-memory parallel applications, and is typically deployed on a cluster. MPI is a standard interface (defined by the MPI forum) for which many implementations are available. All of them have somewhat different include paths, libraries to link against, etc., and this module tries to smooth out those differences. === Variables === This module will set the following variables per language in your project, where <lang> is one of C, CXX, or Fortran: MPI_<lang>_FOUND TRUE if FindMPI found MPI flags for <lang>
MPI_<lang>_COMPILER MPI Compiler wrapper for <lang>
MPI_<lang>_COMPILE_FLAGS Compilation flags for MPI programs
MPI_<lang>_INCLUDE_PATH Include path(s) for MPI header
MPI_<lang>_LINK_FLAGS Linking flags for MPI programs
MPI_<lang>_LIBRARIES All libraries to link MPI programs against
Additionally, FindMPI sets the following variables for running MPI programs from the command line: MPIEXEC Executable for running MPI programs
MPIEXEC_NUMPROC_FLAG Flag to pass to MPIEXEC before giving
it the number of processors to run on
MPIEXEC_PREFLAGS Flags to pass to MPIEXEC directly
before the executable to run.
MPIEXEC_POSTFLAGS Flags to pass to MPIEXEC after other flags
=== Usage === To use this module, simply call FindMPI from a CMakeLists.txt file, or run find_package(MPI), then run CMake. If you are happy with the auto- detected configuration for your language, then you’re done. If not, you have two options: 1. Set MPI_<lang>_COMPILER to the MPI wrapper (mpicc, etc.) of your
choice and reconfigure. FindMPI will attempt to determine all the
necessary variables using THAT compiler's compile and link flags.
2. If this fails, or if your MPI implementation does not come with
a compiler wrapper, then set both MPI_<lang>_LIBRARIES and
MPI_<lang>_INCLUDE_PATH. You may also set any other variables
listed above, but these two are required. This will circumvent
autodetection entirely.
When configuration is successful, MPI_<lang>_COMPILER will be set to the compiler wrapper for <lang>, if it was found. MPI_<lang>_FOUND and other variables above will be set if any MPI implementation was found for <lang>, regardless of whether a compiler was found. When using MPIEXEC to execute MPI applications, you should typically use all of the MPIEXEC flags as follows: ${MPIEXEC} ${MPIEXEC_NUMPROC_FLAG} PROCS
${MPIEXEC_PREFLAGS} EXECUTABLE ${MPIEXEC_POSTFLAGS} ARGS
where PROCS is the number of processors on which to execute the program, EXECUTABLE is the MPI program, and ARGS are the arguments to pass to the MPI program. === Backward Compatibility === For backward compatibility with older versions of FindMPI, these variables are set, but deprecated: MPI_FOUND MPI_COMPILER MPI_LIBRARY
MPI_COMPILE_FLAGS MPI_INCLUDE_PATH MPI_EXTRA_LIBRARY
MPI_LINK_FLAGS MPI_LIBRARIES
In new projects, please use the MPI_<lang>_XXX equivalents.
|
function locale_translation_load_sources locale_translation_load_sources(array $projects = NULL, array $langcodes = NULL) Loads cached translation sources containing current translation status. Parameters array $projects: Array of project names. Defaults to all translatable projects. array $langcodes: Array of language codes. Defaults to all translatable languages. Return value array Array of source objects. Keyed with <project name>:<language code>. See also locale_translation_source_build() File
core/modules/locale/locale.translation.inc, line 102 Common API for interface translation. Code function locale_translation_load_sources(array $projects = NULL, array $langcodes = NULL) {
$sources = array();
$projects = $projects ? $projects : array_keys(locale_translation_get_projects());
$langcodes = $langcodes ? $langcodes : array_keys(locale_translatable_language_list());
// Load source data from locale_translation_status cache.
$status = locale_translation_get_status();
// Use only the selected projects and languages for update.
foreach ($projects as $project) {
foreach ($langcodes as $langcode) {
$sources[$project][$langcode] = isset($status[$project][$langcode]) ? $status[$project][$langcode] : NULL;
}
}
return $sources;
}
|
QOpcUa Namespace The QOpcUa namespace contains miscellaneous identifiers used throughout the Qt OPC UA library. More...
Header:
#include <QOpcUa>
Namespaces
namespace
NodeIds
Types
flags
AccessLevel
enum class
AccessLevelBit { None, CurrentRead, CurrentWrite, HistoryRead, HistoryWrite, …, TimestampWrite }
enum class
AxisScale { Linear, Log, Ln }
enum class
ErrorCategory { NoError, NodeError, AttributeError, PermissionError, ArgumentError, …, UnspecifiedError }
flags
EventNotifier
enum class
EventNotifierBit { None, SubscribeToEvents, HistoryRead, HistoryWrite }
enum class
NodeAttribute { None, NodeId, NodeClass, BrowseName, DisplayName, …, UserExecutable }
flags
NodeAttributes
enum class
NodeClass { Undefined, Object, Variable, Method, ObjectType, …, View }
flags
NodeClasses
enum class
ReferenceTypeId { Unspecified, References, NonHierarchicalReferences, HierarchicalReferences, HasChild, …, HasCondition }
TypedVariant
enum
Types { Boolean, Int32, UInt32, Double, Float, …, Undefined }
enum
UaStatusCode { Good, BadUnexpectedError, BadInternalError, BadOutOfMemory, BadResourceUnavailable, …, BadMaxConnectionsReached }
flags
WriteMask
enum class
WriteMaskBit { None, AccessLevel, ArrayDimensions, BrowseName, ContainsNoLoops, …, ValueForVariableType }
Functions
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069ErrorCategory
errorCategory(QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069UaStatusCode statusCode)
bool
isSecurePolicy(const QString &securityPolicy)
bool
isSuccessStatus(QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069UaStatusCode statusCode)
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069Types
metaTypeToQOpcUaType(QMetaTyp8b7c:f320:99b9:690f:4595:cd17:293a:c069Type type)
QString
namespace0Id(QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069NodeIds8b7c:f320:99b9:690f:4595:cd17:293a:c069Namespace0 id)
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069NodeIds8b7c:f320:99b9:690f:4595:cd17:293a:c069Namespace0
namespace0IdFromNodeId(const QString &nodeId)
QString
namespace0IdName(QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069NodeIds8b7c:f320:99b9:690f:4595:cd17:293a:c069Namespace0 id)
bool
nodeIdEquals(const QString &first, const QString &second)
QString
nodeIdFromByteString(quint16 ns, const QByteArray &identifier)
QString
nodeIdFromGuid(quint16 ns, const QUuid &identifier)
QString
nodeIdFromInteger(quint16 ns, quint32 identifier)
QString
nodeIdFromReferenceType(QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069ReferenceTypeId referenceType)
QString
nodeIdFromString(quint16 ns, const QString &identifier)
bool
nodeIdStringSplit(const QString &nodeIdString, quint16 *nsIndex, QString *identifier, char *identifierType)
size_t
qHash(const QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069NodeAttribute &attr)
QString
statusToString(QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069UaStatusCode statusCode)
Detailed Description
Namespaces
namespace QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069NodeIds
Type Documentation
enum class QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069AccessLevelBitflags QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069AccessLevel
This enum contains all possible bits for the AccessLevel and UserAccessLevel node attributes defined in OPC-UA part 3, Table 8.
Constant
Value
Description
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069AccessLevelBit8b7c:f320:99b9:690f:4595:cd17:293a:c069None
0
No read access to the Value attribute is permitted.
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069AccessLevelBit8b7c:f320:99b9:690f:4595:cd17:293a:c069urrentRead
(1 << 0)
The current value can be read.
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069AccessLevelBit8b7c:f320:99b9:690f:4595:cd17:293a:c069urrentWrite
(1 << 1)
The current value can be written.
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069AccessLevelBit8b7c:f320:99b9:690f:4595:cd17:293a:c069HistoryRead
(1 << 2)
The history of the value is readable.
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069AccessLevelBit8b7c:f320:99b9:690f:4595:cd17:293a:c069HistoryWrite
(1 << 3)
The history of the value is writable.
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069AccessLevelBit8b7c:f320:99b9:690f:4595:cd17:293a:c069SemanticChange
(1 << 4)
The property variable generates SemanticChangeEvents.
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069AccessLevelBit8b7c:f320:99b9:690f:4595:cd17:293a:c069StatusWrite
(1 << 5)
The status code of the value is writable.
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069AccessLevelBit8b7c:f320:99b9:690f:4595:cd17:293a:c069TimestampWrite
(1 << 6)
The SourceTimestamp is writable.
The AccessLevel type is a typedef for QFlags<AccessLevelBit>. It stores an OR combination of AccessLevelBit values.
enum class QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069AxisScale
The AxisScale enum as defined by OPC-UA part 8, 5.6.7.
Constant
Value
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069AxisScal8b7c:f320:99b9:690f:4595:cd17:293a:c069Linear
0
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069AxisScal8b7c:f320:99b9:690f:4595:cd17:293a:c069Log
1
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069AxisScal8b7c:f320:99b9:690f:4595:cd17:293a:c069Ln
2
enum class QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069ErrorCategory
This enum contains simplified categories for OPC UA errors.
Constant
Value
Description
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069ErrorCategory8b7c:f320:99b9:690f:4595:cd17:293a:c069NoError
0
The operation has been successful.
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069ErrorCategory8b7c:f320:99b9:690f:4595:cd17:293a:c069NodeError
1
There is a problem with the node, e. g. it does not exist.
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069ErrorCategory8b7c:f320:99b9:690f:4595:cd17:293a:c069ttributeError
2
The attributes to operate on where invalid.
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069ErrorCategory8b7c:f320:99b9:690f:4595:cd17:293a:c069PermissionError
3
The user did not have the permission to perform the operation.
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069ErrorCategory8b7c:f320:99b9:690f:4595:cd17:293a:c069rgumentError
4
The arguments supplied by the user were invalid or incomplete.
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069ErrorCategory8b7c:f320:99b9:690f:4595:cd17:293a:c069TypeError
5
There has been a type mismatch for a write operation.
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069ErrorCategory8b7c:f320:99b9:690f:4595:cd17:293a:c069onnectionError
6
Communication with the server did not work as expected.
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069ErrorCategory8b7c:f320:99b9:690f:4595:cd17:293a:c069UnspecifiedError
7
Any error that is not categorized. The detailed status code must be checked.
enum class QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069EventNotifierBitflags QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069EventNotifier
This enum contains all possible bits for the EventNotifier node attribute defined in OPC-UA part 3, Table 6.
Constant
Value
Description
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069EventNotifierBit8b7c:f320:99b9:690f:4595:cd17:293a:c069None
0
The node can't be used to interact with events.
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069EventNotifierBit8b7c:f320:99b9:690f:4595:cd17:293a:c069SubscribeToEvents
(1 << 0)
A client can subscribe to events.
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069EventNotifierBit8b7c:f320:99b9:690f:4595:cd17:293a:c069HistoryRead
(1 << 2)
A client can read the event history.
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069EventNotifierBit8b7c:f320:99b9:690f:4595:cd17:293a:c069HistoryWrite
(1 << 3)
A client can write the event history.
The EventNotifier type is a typedef for QFlags<EventNotifierBit>. It stores an OR combination of EventNotifierBit values.
enum class QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069NodeAttributeflags QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069NodeAttributes
This enum contains the 22 node attributes defined in OPC-UA part 4, 5.
Constant
Value
Description
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069NodeAttribut8b7c:f320:99b9:690f:4595:cd17:293a:c069None
0
No node attribute.
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069NodeAttribut8b7c:f320:99b9:690f:4595:cd17:293a:c069NodeId
(1 << 0)
Mandatory for all nodes. Contains the node's id in the OPC UA address space.
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069NodeAttribut8b7c:f320:99b9:690f:4595:cd17:293a:c069NodeClass
(1 << 1)
Mandatory for all nodes. Contains the node id describing the node class of the node.
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069NodeAttribut8b7c:f320:99b9:690f:4595:cd17:293a:c069BrowseName
(1 << 2)
Mandatory for all nodes. Contains a non-localized human readable name of the node.
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069NodeAttribut8b7c:f320:99b9:690f:4595:cd17:293a:c069DisplayName
(1 << 3)
Mandatory for all nodes. Contains a localized human readable name for display purposes.
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069NodeAttribut8b7c:f320:99b9:690f:4595:cd17:293a:c069Description
(1 << 4)
Contains a localized human readable description of the node.
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069NodeAttribut8b7c:f320:99b9:690f:4595:cd17:293a:c069WriteMask
(1 << 5)
Contains a bit mask. Each bit corresponds to a writable attribute (OPC-UA part 3, Table 3).
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069NodeAttribut8b7c:f320:99b9:690f:4595:cd17:293a:c069UserWriteMask
(1 << 6)
Same as WriteMask but for the current user.
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069NodeAttribut8b7c:f320:99b9:690f:4595:cd17:293a:c069IsAbstract
(1 << 7)
True if the node is an abstract type which means that no nodes of this type shall exist.
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069NodeAttribut8b7c:f320:99b9:690f:4595:cd17:293a:c069Symmetric
(1 << 8)
True if a reference's meaning is the same seen from both ends.
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069NodeAttribut8b7c:f320:99b9:690f:4595:cd17:293a:c069InverseName
(1 << 9)
The localized inverse name of a reference (for example "HasSubtype" has the InverseName "SubtypeOf").
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069NodeAttribut8b7c:f320:99b9:690f:4595:cd17:293a:c069ContainsNoLoops
(1 << 10)
True if there is no way to get back to a node following forward references in the current view.
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069NodeAttribut8b7c:f320:99b9:690f:4595:cd17:293a:c069EventNotifier
(1 << 11)
Contains a bit mask used to indicate if subscribing to events and access to historic events is supported (OPC-UA part 3, Table 5).
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069NodeAttribut8b7c:f320:99b9:690f:4595:cd17:293a:c069Value
(1 << 12)
The value of a Variable node.
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069NodeAttribut8b7c:f320:99b9:690f:4595:cd17:293a:c069DataType
(1 << 13)
The NodeId of the Value attribute's data type (for example "ns=0;i=13" for DateTime, see https://opcfoundation.org/UA/schemas/1.03/NodeIds.csv).
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069NodeAttribut8b7c:f320:99b9:690f:4595:cd17:293a:c069ValueRank
(1 << 14)
Contains information about the structure of the Value attribute (scalar/array) (OPC-UA part 3, Table 8).
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069NodeAttribut8b7c:f320:99b9:690f:4595:cd17:293a:c069ArrayDimensions
(1 << 15)
An array containing the length for each dimension of a multi-dimensional array.
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069NodeAttribut8b7c:f320:99b9:690f:4595:cd17:293a:c069AccessLevel
(1 << 16)
Contains a bit mask. Each bit corresponds to an access capability (OPC-UA part 3, Table 8).
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069NodeAttribut8b7c:f320:99b9:690f:4595:cd17:293a:c069UserAccessLevel
(1 << 17)
Same as AccessLevel, but for the current user.
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069NodeAttribut8b7c:f320:99b9:690f:4595:cd17:293a:c069MinimumSamplingInterval
(1 << 18)
Contains the shortest possible interval in which the server is able to sample the value.
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069NodeAttribut8b7c:f320:99b9:690f:4595:cd17:293a:c069Historizing
(1 << 19)
True if historical data is collected.
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069NodeAttribut8b7c:f320:99b9:690f:4595:cd17:293a:c069Executable
(1 << 20)
True if the node is currently executable. Only relevant for Method nodes.
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069NodeAttribut8b7c:f320:99b9:690f:4595:cd17:293a:c069UserExecutable
(1 << 21)
Same as Executable, but for the current user.
The NodeAttributes type is a typedef for QFlags<NodeAttribute>. It stores an OR combination of NodeAttribute values.
enum class QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069NodeClassflags QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069NodeClasses
This enum specifies the class a node belongs to. OPC-UA specifies a fixed set of eight different classes.
Constant
Value
Description
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069NodeClass8b7c:f320:99b9:690f:4595:cd17:293a:c069Undefined
0
The node class is not known. This is the case before the NodeClass attribute has been read on the server.
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069NodeClass8b7c:f320:99b9:690f:4595:cd17:293a:c069Object
1
An Object node.
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069NodeClass8b7c:f320:99b9:690f:4595:cd17:293a:c069Variable
2
A Variable node.
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069NodeClass8b7c:f320:99b9:690f:4595:cd17:293a:c069Method
4
A Method node.
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069NodeClass8b7c:f320:99b9:690f:4595:cd17:293a:c069ObjectType
8
An ObjectType node.
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069NodeClass8b7c:f320:99b9:690f:4595:cd17:293a:c069VariableType
16
A VariableType node.
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069NodeClass8b7c:f320:99b9:690f:4595:cd17:293a:c069ReferenceType
32
A ReferenceType node.
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069NodeClass8b7c:f320:99b9:690f:4595:cd17:293a:c069taType
64
A DataType node.
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069NodeClass8b7c:f320:99b9:690f:4595:cd17:293a:c069View
128
A View node.
The NodeClasses type is a typedef for QFlags<NodeClass>. It stores an OR combination of NodeClass values.
enum class QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069ReferenceTypeId
This enum contains the reference types specified in OPC-UA part 3, 7. They are used to filter for a certain reference type in QOpcUaNo8b7c:f320:99b9:690f:4595:cd17:293a:c069browseChildren and for the reference type information in QOpcUaReferenceDescription.
Constant
Value
Description
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069ReferenceTypeI8b7c:f320:99b9:690f:4595:cd17:293a:c069Unspecified
0
Not a valid reference type.
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069ReferenceTypeI8b7c:f320:99b9:690f:4595:cd17:293a:c069References
31
The abstract base type for all references.
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069ReferenceTypeI8b7c:f320:99b9:690f:4595:cd17:293a:c069NonHierarchicalReferences
32
The abstract base type for all non-hierarchical references.
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069ReferenceTypeI8b7c:f320:99b9:690f:4595:cd17:293a:c069HierarchicalReferences
33
The abstract base type for all hierarchical references.
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069ReferenceTypeI8b7c:f320:99b9:690f:4595:cd17:293a:c069HasChild
34
The abstract base type for all non-looping hierarchical references.
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069ReferenceTypeI8b7c:f320:99b9:690f:4595:cd17:293a:c069Organizes
35
The type for hierarchical references that are used to organize nodes.
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069ReferenceTypeI8b7c:f320:99b9:690f:4595:cd17:293a:c069HasEventSource
36
The type for non-looping hierarchical references that are used to organize event sources.
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069ReferenceTypeI8b7c:f320:99b9:690f:4595:cd17:293a:c069HasModellingRule
37
The type for references from instance declarations to modelling rule nodes.
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069ReferenceTypeI8b7c:f320:99b9:690f:4595:cd17:293a:c069HasEncoding
38
The type for references from data type nodes to to data type encoding nodes.
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069ReferenceTypeI8b7c:f320:99b9:690f:4595:cd17:293a:c069HasDescription
39
The type for references from data type encoding nodes to data type description nodes.
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069ReferenceTypeI8b7c:f320:99b9:690f:4595:cd17:293a:c069HasTypeDefinition
40
The type for references from a instance node to its type definition node.
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069ReferenceTypeI8b7c:f320:99b9:690f:4595:cd17:293a:c069GeneratesEvent
41
The type for references from a node to an event type that is raised by node.
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069ReferenceTypeI8b7c:f320:99b9:690f:4595:cd17:293a:c069Aggregates
44
The type for non-looping hierarchical references that are used to aggregate nodes into complex types.
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069ReferenceTypeI8b7c:f320:99b9:690f:4595:cd17:293a:c069HasSubtype
45
The type for non-looping hierarchical references that are used to define sub types.
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069ReferenceTypeI8b7c:f320:99b9:690f:4595:cd17:293a:c069HasProperty
46
The type for non-looping hierarchical reference from a node to its property.
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069ReferenceTypeI8b7c:f320:99b9:690f:4595:cd17:293a:c069HasComponent
47
The type for non-looping hierarchical reference from a node to its component.
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069ReferenceTypeI8b7c:f320:99b9:690f:4595:cd17:293a:c069HasNotifier
48
The type for non-looping hierarchical references that are used to indicate how events propagate from node to node.
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069ReferenceTypeI8b7c:f320:99b9:690f:4595:cd17:293a:c069HasOrderedComponent
49
The type for non-looping hierarchical reference from a node to its component when the order of references matters.
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069ReferenceTypeI8b7c:f320:99b9:690f:4595:cd17:293a:c069FromState
51
The type for a reference to the state before a transition.
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069ReferenceTypeI8b7c:f320:99b9:690f:4595:cd17:293a:c069ToState
52
The type for a reference to the state after a transition.
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069ReferenceTypeI8b7c:f320:99b9:690f:4595:cd17:293a:c069HasCause
53
The type for a reference to a method that can cause a transition to occur.
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069ReferenceTypeI8b7c:f320:99b9:690f:4595:cd17:293a:c069HasEffect
54
The type for a reference to an event that may be raised when a transition occurs.
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069ReferenceTypeI8b7c:f320:99b9:690f:4595:cd17:293a:c069HasHistoricalConfiguration
56
The type for a reference to the historical configuration for a data variable.
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069ReferenceTypeI8b7c:f320:99b9:690f:4595:cd17:293a:c069HasSubStateMachine
117
The type for a reference to a substate for a state.
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069ReferenceTypeI8b7c:f320:99b9:690f:4595:cd17:293a:c069AlwaysGeneratesEvent
3065
The type for references from a node to an event type that is always raised by node.
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069ReferenceTypeI8b7c:f320:99b9:690f:4595:cd17:293a:c069HasTrueSubState
9004
The type for references from a TRUE super state node to a subordinate state node.
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069ReferenceTypeI8b7c:f320:99b9:690f:4595:cd17:293a:c069HasFalseSubState
9005
The type for references from a FALSE super state node to a subordinate state node.
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069ReferenceTypeI8b7c:f320:99b9:690f:4595:cd17:293a:c069HasCondition
9006
The type for references from a ConditionSource node to a Condition.
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069TypedVariant
This is QPair<QVariant, QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069Types>.
enum QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069Types
Enumerates the types supported by Qt OPC UA.
Constant
Value
Description
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069Boolean
0
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069Int32
1
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069UInt32
2
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069Double
3
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069Float
4
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069String
5
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069LocalizedText
6
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069DateTime
7
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069UInt16
8
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069Int16
9
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069UInt64
10
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069Int64
11
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069Byte
12
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069SByte
13
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069ByteString
14
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069XmlElement
15
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069NodeId
16
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069Guid
17
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069QualifiedName
18
A name qualified by an OPC UA namespace index.
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069StatusCode
19
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069ExtensionObject
20
A data structure which contains a serialized object.
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069Range
21
A range composed from the two double values low and high.
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069EUInformation
22
The unit of measurement for an analog value.
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069ComplexNumber
23
The OPC UA ComplexNumber type.
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069DoubleComplexNumber
24
The OPC UA DoubleComplexNumber type.
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069AxisInformation
25
Information about an axis.
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069XV
26
A float value with a double precision position on an axis.
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069ExpandedNodeId
27
A node id with additional namespace URI and server index.
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069Argument
28
The OPC UA Argument type.
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069Undefined
0xFFFFFFFF
enum QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069UaStatusCode
Enumerates all status codes from https://opcfoundation.org/UA/schemas/1.03/Opc.Ua.StatusCodes.csv
Constant
Value
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069Good
0
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069BadUnexpectedError
0x80010000
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069BadInternalError
0x80020000
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069BadOutOfMemory
0x80030000
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069BadResourceUnavailable
0x80040000
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069BadCommunicationError
0x80050000
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069BadEncodingError
0x80060000
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069BadDecodingError
0x80070000
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069BadEncodingLimitsExceeded
0x80080000
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069BadRequestTooLarge
0x80B80000
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069BadResponseTooLarge
0x80B90000
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069BadUnknownResponse
0x80090000
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069BadTimeout
0x800A0000
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069BadServiceUnsupported
0x800B0000
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069BadShutdown
0x800C0000
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069BadServerNotConnected
0x800D0000
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069BadServerHalted
0x800E0000
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069BadNothingToDo
0x800F0000
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069BadTooManyOperations
0x80100000
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069BadTooManyMonitoredItems
0x80DB0000
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069BadDataTypeIdUnknown
0x80110000
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069BadCertificateInvalid
0x80120000
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069BadSecurityChecksFailed
0x80130000
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069BadCertificateTimeInvalid
0x80140000
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069BadCertificateIssuerTimeInvalid
0x80150000
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069BadCertificateHostNameInvalid
0x80160000
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069BadCertificateUriInvalid
0x80170000
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069BadCertificateUseNotAllowed
0x80180000
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069BadCertificateIssuerUseNotAllowed
0x80190000
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069BadCertificateUntrusted
0x801A0000
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069BadCertificateRevocationUnknown
0x801B0000
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069BadCertificateIssuerRevocationUnknown
0x801C0000
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069BadCertificateRevoked
0x801D0000
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069BadCertificateIssuerRevoked
0x801E0000
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069BadCertificateChainIncomplete
0x810D0000
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069BadUserAccessDenied
0x801F0000
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069BadIdentityTokenInvalid
0x80200000
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069BadIdentityTokenRejected
0x80210000
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069BadSecureChannelIdInvalid
0x80220000
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069BadInvalidTimestamp
0x80230000
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069BadNonceInvalid
0x80240000
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069BadSessionIdInvalid
0x80250000
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069BadSessionClosed
0x80260000
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069BadSessionNotActivated
0x80270000
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069BadSubscriptionIdInvalid
0x80280000
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069BadRequestHeaderInvalid
0x802A0000
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069BadTimestampsToReturnInvalid
0x802B0000
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069BadRequestCancelledByClient
0x802C0000
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069BadTooManyArguments
0x80E50000
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069GoodSubscriptionTransferred
0x002D0000
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069GoodCompletesAsynchronously
0x002E0000
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069GoodOverload
0x002F0000
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069GoodClamped
0x00300000
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069BadNoCommunication
0x80310000
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069BadWaitingForInitialData
0x80320000
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069BadNodeIdInvalid
0x80330000
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069BadNodeIdUnknown
0x80340000
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069BadAttributeIdInvalid
0x80350000
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069BadIndexRangeInvalid
0x80360000
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069BadIndexRangeNoData
0x80370000
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069BadDataEncodingInvalid
0x80380000
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069BadDataEncodingUnsupported
0x80390000
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069BadNotReadable
0x803A0000
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069BadNotWritable
0x803B0000
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069BadOutOfRange
0x803C0000
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069BadNotSupported
0x803D0000
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069BadNotFound
0x803E0000
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069BadObjectDeleted
0x803F0000
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069BadNotImplemented
0x80400000
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069BadMonitoringModeInvalid
0x80410000
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069BadMonitoredItemIdInvalid
0x80420000
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069BadMonitoredItemFilterInvalid
0x80430000
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069BadMonitoredItemFilterUnsupported
0x80440000
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069BadFilterNotAllowed
0x80450000
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069BadStructureMissing
0x80460000
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069BadEventFilterInvalid
0x80470000
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069BadContentFilterInvalid
0x80480000
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069BadFilterOperatorInvalid
0x80C10000
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069BadFilterOperatorUnsupported
0x80C20000
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069BadFilterOperandCountMismatch
0x80C30000
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069BadFilterOperandInvalid
0x80490000
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069BadFilterElementInvalid
0x80C40000
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069BadFilterLiteralInvalid
0x80C50000
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069BadContinuationPointInvalid
0x804A0000
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069BadNoContinuationPoints
0x804B0000
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069BadReferenceTypeIdInvalid
0x804C0000
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069BadBrowseDirectionInvalid
0x804D0000
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069BadNodeNotInView
0x804E0000
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069BadServerUriInvalid
0x804F0000
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069BadServerNameMissing
0x80500000
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069BadDiscoveryUrlMissing
0x80510000
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069BadSempahoreFileMissing
0x80520000
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069BadRequestTypeInvalid
0x80530000
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069BadSecurityModeRejected
0x80540000
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069BadSecurityPolicyRejected
0x80550000
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069BadTooManySessions
0x80560000
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069BadUserSignatureInvalid
0x80570000
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069BadApplicationSignatureInvalid
0x80580000
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069BadNoValidCertificates
0x80590000
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069BadIdentityChangeNotSupported
0x80C60000
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069BadRequestCancelledByRequest
0x805A0000
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069BadParentNodeIdInvalid
0x805B0000
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069BadReferenceNotAllowed
0x805C0000
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069BadNodeIdRejected
0x805D0000
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069BadNodeIdExists
0x805E0000
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069BadNodeClassInvalid
0x805F0000
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069BadBrowseNameInvalid
0x80600000
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069BadBrowseNameDuplicated
0x80610000
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069BadNodeAttributesInvalid
0x80620000
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069BadTypeDefinitionInvalid
0x80630000
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069BadSourceNodeIdInvalid
0x80640000
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069BadTargetNodeIdInvalid
0x80650000
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069BadDuplicateReferenceNotAllowed
0x80660000
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069BadInvalidSelfReference
0x80670000
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069BadReferenceLocalOnly
0x80680000
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069BadNoDeleteRights
0x80690000
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069UncertainReferenceNotDeleted
0x40BC0000
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069BadServerIndexInvalid
0x806A0000
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069BadViewIdUnknown
0x806B0000
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069BadViewTimestampInvalid
0x80C90000
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069BadViewParameterMismatch
0x80CA0000
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069BadViewVersionInvalid
0x80CB0000
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069UncertainNotAllNodesAvailable
0x40C00000
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069GoodResultsMayBeIncomplete
0x00BA0000
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069BadNotTypeDefinition
0x80C80000
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069UncertainReferenceOutOfServer
0x406C0000
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069BadTooManyMatches
0x806D0000
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069BadQueryTooComplex
0x806E0000
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069BadNoMatch
0x806F0000
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069BadMaxAgeInvalid
0x80700000
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069BadSecurityModeInsufficient
0x80E60000
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069BadHistoryOperationInvalid
0x80710000
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069BadHistoryOperationUnsupported
0x80720000
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069BadInvalidTimestampArgument
0x80BD0000
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069BadWriteNotSupported
0x80730000
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069BadTypeMismatch
0x80740000
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069BadMethodInvalid
0x80750000
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069BadArgumentsMissing
0x80760000
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069BadTooManySubscriptions
0x80770000
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069BadTooManyPublishRequests
0x80780000
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069BadNoSubscription
0x80790000
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069BadSequenceNumberUnknown
0x807A0000
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069BadMessageNotAvailable
0x807B0000
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069BadInsufficientClientProfile
0x807C0000
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069BadStateNotActive
0x80BF0000
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069BadTcpServerTooBusy
0x807D0000
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069BadTcpMessageTypeInvalid
0x807E0000
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069BadTcpSecureChannelUnknown
0x807F0000
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069BadTcpMessageTooLarge
0x80800000
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069BadTcpNotEnoughResources
0x80810000
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069BadTcpInternalError
0x80820000
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069BadTcpEndpointUrlInvalid
0x80830000
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069BadRequestInterrupted
0x80840000
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069BadRequestTimeout
0x80850000
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069BadSecureChannelClosed
0x80860000
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069BadSecureChannelTokenUnknown
0x80870000
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069BadSequenceNumberInvalid
0x80880000
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069BadProtocolVersionUnsupported
0x80BE0000
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069BadConfigurationError
0x80890000
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069BadNotConnected
0x808A0000
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069BadDeviceFailure
0x808B0000
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069BadSensorFailure
0x808C0000
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069BadOutOfService
0x808D0000
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069BadDeadbandFilterInvalid
0x808E0000
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069UncertainNoCommunicationLastUsableValue
0x408F0000
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069UncertainLastUsableValue
0x40900000
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069UncertainSubstituteValue
0x40910000
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069UncertainInitialValue
0x40920000
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069UncertainSensorNotAccurate
0x40930000
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069UncertainEngineeringUnitsExceeded
0x40940000
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069UncertainSubNormal
0x40950000
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069GoodLocalOverride
0x00960000
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069BadRefreshInProgress
0x80970000
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069BadConditionAlreadyDisabled
0x80980000
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069BadConditionAlreadyEnabled
0x80CC0000
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069BadConditionDisabled
0x80990000
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069BadEventIdUnknown
0x809A0000
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069BadEventNotAcknowledgeable
0x80BB0000
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069BadDialogNotActive
0x80CD0000
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069BadDialogResponseInvalid
0x80CE0000
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069BadConditionBranchAlreadyAcked
0x80CF0000
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069BadConditionBranchAlreadyConfirmed
0x80D00000
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069BadConditionAlreadyShelved
0x80D10000
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069BadConditionNotShelved
0x80D20000
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069BadShelvingTimeOutOfRange
0x80D30000
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069BadNoData
0x809B0000
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069BadBoundNotFound
0x80D70000
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069BadBoundNotSupported
0x80D80000
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069BadDataLost
0x809D0000
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069BadDataUnavailable
0x809E0000
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069BadEntryExists
0x809F0000
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069BadNoEntryExists
0x80A00000
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069BadTimestampNotSupported
0x80A10000
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069GoodEntryInserted
0x00A20000
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069GoodEntryReplaced
0x00A30000
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069UncertainDataSubNormal
0x40A40000
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069GoodNoData
0x00A50000
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069GoodMoreData
0x00A60000
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069BadAggregateListMismatch
0x80D40000
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069BadAggregateNotSupported
0x80D50000
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069BadAggregateInvalidInputs
0x80D60000
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069BadAggregateConfigurationRejected
0x80DA0000
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069GoodDataIgnored
0x00D90000
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069BadRequestNotAllowed
0x80E40000
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069GoodEdited
0x00DC0000
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069GoodPostActionFailed
0x00DD0000
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069UncertainDominantValueChanged
0x40DE0000
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069GoodDependentValueChanged
0x00E00000
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069BadDominantValueChanged
0x80E10000
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069UncertainDependentValueChanged
0x40E20000
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069BadDependentValueChanged
0x80E30000
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069GoodCommunicationEvent
0x00A70000
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069GoodShutdownEvent
0x00A80000
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069GoodCallAgain
0x00A90000
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069GoodNonCriticalTimeout
0x00AA0000
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069BadInvalidArgument
0x80AB0000
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069BadConnectionRejected
0x80AC0000
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069BadDisconnect
0x80AD0000
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069BadConnectionClosed
0x80AE0000
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069BadInvalidState
0x80AF0000
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069BadEndOfStream
0x80B00000
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069BadNoDataAvailable
0x80B10000
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069BadWaitingForResponse
0x80B20000
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069BadOperationAbandoned
0x80B30000
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069BadExpectedStreamToBlock
0x80B40000
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069BadWouldBlock
0x80B50000
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069BadSyntaxError
0x80B60000
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069BadMaxConnectionsReached
0x80B70000
enum class QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069WriteMaskBitflags QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069WriteMask
This enum contains all possible bits for the WriteMask and UserWriteMask node attributes defined in OPC-UA part 3, Tabe 3.
Constant
Value
Description
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069WriteMaskBit8b7c:f320:99b9:690f:4595:cd17:293a:c069None
0
No attribute is writable.
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069WriteMaskBit8b7c:f320:99b9:690f:4595:cd17:293a:c069ssLevel
(1 << 0)
The AccessLevel attribute is writable.
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069WriteMaskBit8b7c:f320:99b9:690f:4595:cd17:293a:c069rrayDimensions
(1 << 1)
The ArrayDimensions attribute is writable.
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069WriteMaskBit8b7c:f320:99b9:690f:4595:cd17:293a:c069rowseName
(1 << 2)
The BrowseName attribute is writable.
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069WriteMaskBit8b7c:f320:99b9:690f:4595:cd17:293a:c069ontainsNoLoops
(1 << 3)
The ContainsNoLoops attribute is writable.
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069WriteMaskBit8b7c:f320:99b9:690f:4595:cd17:293a:c069taType
(1 << 4)
The DataType attribute is writable.
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069WriteMaskBit8b7c:f320:99b9:690f:4595:cd17:293a:c069scription
(1 << 5)
The Description attribute is writable.
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069WriteMaskBit8b7c:f320:99b9:690f:4595:cd17:293a:c069isplayName
(1 << 6)
The DisplayName attribute is writable.
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069WriteMaskBit8b7c:f320:99b9:690f:4595:cd17:293a:c069ventNotifier
(1 << 7)
The EventNotifier attribute is writable.
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069WriteMaskBit8b7c:f320:99b9:690f:4595:cd17:293a:c069xecutable
(1 << 8)
The Executable attribute is writable.
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069WriteMaskBit8b7c:f320:99b9:690f:4595:cd17:293a:c069Historizing
(1 << 9)
The Historizing attribute is writable.
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069WriteMaskBit8b7c:f320:99b9:690f:4595:cd17:293a:c069InverseName
(1 << 10)
The InverseName attribute is writable.
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069WriteMaskBit8b7c:f320:99b9:690f:4595:cd17:293a:c069IsAbstract
(1 << 11)
The IsAbstract attribute is writable.
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069WriteMaskBit8b7c:f320:99b9:690f:4595:cd17:293a:c069MinimumSamplingInterval
(1 << 12)
The MinimumSamplingInterval attribute is writable.
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069WriteMaskBit8b7c:f320:99b9:690f:4595:cd17:293a:c069NodeClass
(1 << 13)
The NodeClass attribute is writable.
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069WriteMaskBit8b7c:f320:99b9:690f:4595:cd17:293a:c069NodeId
(1 << 14)
The NodeId attribute is writable.
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069WriteMaskBit8b7c:f320:99b9:690f:4595:cd17:293a:c069Symmetric
(1 << 15)
The Symmetric attribute is writable.
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069WriteMaskBit8b7c:f320:99b9:690f:4595:cd17:293a:c069UserAccessLevel
(1 << 16)
The UserAccessLevel attribute is writable.
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069WriteMaskBit8b7c:f320:99b9:690f:4595:cd17:293a:c069UserExecutable
(1 << 17)
The UserExecutable attribute is writable.
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069WriteMaskBit8b7c:f320:99b9:690f:4595:cd17:293a:c069UserWriteMask
(1 << 18)
The UserWriteMask attribute is writable.
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069WriteMaskBit8b7c:f320:99b9:690f:4595:cd17:293a:c069ValueRank
(1 << 19)
The ValueRank attribute is writable.
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069WriteMaskBit8b7c:f320:99b9:690f:4595:cd17:293a:c069WriteMask
(1 << 20)
The WriteMask attribute is writable.
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069WriteMaskBit8b7c:f320:99b9:690f:4595:cd17:293a:c069ValueForVariableType
(1 << 21)
The Value attribute of a variable type is writable.
The WriteMask type is a typedef for QFlags<WriteMaskBit>. It stores an OR combination of WriteMaskBit values. Function Documentation
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069ErrorCategory QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069errorCategory(QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069UaStatusCode statusCode)
Converts statusCode to an ErrorCategory. ErrorCategory can be used in cases where the exact error is not important. For error handling dependent on status codes, the full status code must be used instead. The meaning of the status codes for the different services is documented in OPC-UA part 4. If statusCode has not been categorized, UnspecifiedError is returned. In this case, the user must check the full status code.
[since QtOpcUa 5.14] bool QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069isSecurePolicy(const QString &securityPolicy)
Returns true if securityPolicy is a secure policy, false otherwise. This function was introduced in QtOpcUa 5.14.
bool QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069isSuccessStatus(QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069UaStatusCode statusCode)
This method can be used to check if a call has successfully finished. Returns true if statusCode's serverity field is Good.
[since 5.13] QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069Types QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069metaTypeToQOpcUaType(QMetaTyp8b7c:f320:99b9:690f:4595:cd17:293a:c069Type type)
Returns the Qt OPC UA type from type. In case the type does not map, QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069Undefined is returned. This function was introduced in Qt 5.13.
QString QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069namespace0Id(QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069NodeIds8b7c:f320:99b9:690f:4595:cd17:293a:c069Namespace0 id)
Returns a node id string for the namespace 0 identifier id.
QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069NodeIds8b7c:f320:99b9:690f:4595:cd17:293a:c069Namespace0 QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069namespace0IdFromNodeId(const QString &nodeId)
Returns the enum value from QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069NodeIds8b7c:f320:99b9:690f:4595:cd17:293a:c069Namespace0 for nodeId. If the node id is not in namespace 0 or doesn't have a numeric identifier which is part of the OPC Foundation's NodeIds.csv file, Unknown is returned. If Qt OPC UA has been configured with -no-feature-ns0idnames, the check if the numeric identifier is part of the NodeIds.csv file is omitted. If the node id is in namespace 0 and has a numeric identifier, the identifier is returned regardless if it is part of the QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069NodeIds8b7c:f320:99b9:690f:4595:cd17:293a:c069Namespace0 enum.
QString QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069namespace0IdName(QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069NodeIds8b7c:f320:99b9:690f:4595:cd17:293a:c069Namespace0 id)
Returns the name of the namespace 0 node id id. If id is unknown or Qt OPC UA has been configured with -no-feature-ns0idnames, an empty string is returned.
bool QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069nodeIdEquals(const QString &first, const QString &second)
Returns true if the two node ids first and second have the same namespace index and identifier. A node id string without a namespace index is assumed to be in namespace 0.
QString QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069nodeIdFromByteString(quint16 ns, const QByteArray &identifier)
Creates a node id string from the namespace index ns and the byte string identifier. See also QOpcUaNode.
QString QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069nodeIdFromGuid(quint16 ns, const QUuid &identifier)
Creates a node id string from the namespace index ns and the GUID identifier. See also QOpcUaNode.
QString QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069nodeIdFromInteger(quint16 ns, quint32 identifier)
Creates a node id string from the namespace index ns and the integer identifier. See also QOpcUaNode.
QString QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069nodeIdFromReferenceType(QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069ReferenceTypeId referenceType)
Creates a node id string for the reference type id referenceType.
QString QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069nodeIdFromString(quint16 ns, const QString &identifier)
Creates a node id string from the namespace index ns and the string identifier. See also QOpcUaNode.
bool QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069nodeIdStringSplit(const QString &nodeIdString, quint16 *nsIndex, QString *identifier, char *identifierType)
Splits the node id string nodeIdString in its components. The namespace index of the node id will be copied into nsIndex. The identifier string is copied into identifier and the identifier type (i, s, g, b) is copied into identifierType. Returns true if the node id could be split successfully. For example, "ns=1;s=MyString" is split into 1, 's' and "MyString". If no namespace index is given, ns=0 is assumed.
size_t QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069qHash(const QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069NodeAttribute &attr)
Returns a QHash key for attr.
QString QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069statusToString(QOpcU8b7c:f320:99b9:690f:4595:cd17:293a:c069UaStatusCode statusCode)
Returns a textual representation of statusCode. Currently, this is the name of the enum value but may be a real message in future releases.
|
public function FormBuilder8b7c:f320:99b9:690f:4595:cd17:293a:c069prepareForm public FormBuilder8b7c:f320:99b9:690f:4595:cd17:293a:c069prepareForm($form_id, &$form, FormStateInterface &$form_state) Prepares a structured form array. Adds required elements, executes any hook_form_alter functions, and optionally inserts a validation token to prevent tampering. Parameters string $form_id: A unique string identifying the form for validation, submission, theming, and hook_form_alter functions. array $form: An associative array containing the structure of the form. \Drupal\Core\Form\FormStateInterface $form_state: The current state of the form. Passed in here so that hook_form_alter() calls can use it, as well. Overrides FormBuilderInter8b7c:f320:99b9:690f:4595:cd17:293a:c069prepareForm File
core/lib/Drupal/Core/Form/FormBuilder.php, line 673 Class
FormBuilder Provides form building and processing. Namespace Drupal\Core\Form Code public function prepareForm($form_id, &$form, FormStateInterface &$form_state) {
$user = $this->currentUser();
$form['#type'] = 'form';
// Only update the action if it is not already set.
if (!isset($form['#action'])) {
// Instead of setting an actual action URL, we set the placeholder, which
// will be replaced at the very last moment. This ensures forms with
// dynamically generated action URLs don't have poor cacheability.
// Use the proper API to generate the placeholder, when we have one. See
// https://www.drupal.org/node/2562341.
$placeholder = 'form_action_' . hash('crc32b', __METHOD__);
$form['#attached']['placeholders'][$placeholder] = [
'#lazy_builder' => ['form_builder:renderPlaceholderFormAction', []],
];
$form['#action'] = $placeholder;
}
// Fix the form method, if it is 'get' in $form_state, but not in $form.
if ($form_state->isMethodType('get') && !isset($form['#method'])) {
$form['#method'] = 'get';
}
// GET forms should not use a CSRF token.
if (isset($form['#method']) && $form['#method'] === 'get') {
// Merges in a default, this means if you've explicitly set #token to the
// the $form_id on a GET form, which we don't recommend, it will work.
$form += [
'#token' => FALSE,
];
}
// Generate a new #build_id for this form, if none has been set already.
// The form_build_id is used as key to cache a particular build of the form.
// For multi-step forms, this allows the user to go back to an earlier
// build, make changes, and re-submit.
// @see sel8b7c:f320:99b9:690f:4595:cd17:293a:c069buildForm()
// @see sel8b7c:f320:99b9:690f:4595:cd17:293a:c069rebuildForm()
if (!isset($form['#build_id'])) {
$form['#build_id'] = 'form-' . Crypt8b7c:f320:99b9:690f:4595:cd17:293a:c069randomBytesBase64();
}
$form['form_build_id'] = array(
'#type' => 'hidden',
'#value' => $form['#build_id'],
'#id' => $form['#build_id'],
'#name' => 'form_build_id',
// Form processing and validation requires this value, so ensure the
// submitted form value appears literally, regardless of custom #tree
// and #parents being set elsewhere.
'#parents' => array('form_build_id'),
);
// Add a token, based on either #token or form_id, to any form displayed to
// authenticated users. This ensures that any submitted form was actually
// requested previously by the user and protects against cross site request
// forgeries.
// This does not apply to programmatically submitted forms. Furthermore,
// since tokens are session-bound and forms displayed to anonymous users are
// very likely cached, we cannot assign a token for them.
// During installation, there is no $user yet.
// Form constructors may explicitly set #token to FALSE when cross site
// request forgery is irrelevant to the form, such as search forms.
if ($form_state->isProgrammed() || (isset($form['#token']) && $form['#token'] === FALSE)) {
unset($form['#token']);
}
else {
$form['#cache']['contexts'][] = 'user.roles:authenticated';
if ($user && $user->isAuthenticated()) {
// Generate a public token based on the form id.
// Generates a placeholder based on the form ID.
$placeholder = 'form_token_placeholder_' . hash('crc32b', $form_id);
$form['#token'] = $placeholder;
$form['form_token'] = array(
'#id' => Html8b7c:f320:99b9:690f:4595:cd17:293a:c069getUniqueId('edit-' . $form_id . '-form-token'),
'#type' => 'token',
'#default_value' => $placeholder,
// Form processing and validation requires this value, so ensure the
// submitted form value appears literally, regardless of custom #tree
// and #parents being set elsewhere.
'#parents' => array('form_token'),
// Instead of setting an actual CSRF token, we've set the placeholder
// in form_token's #default_value and #placeholder. These will be
// replaced at the very last moment. This ensures forms with a CSRF
// token don't have poor cacheability.
'#attached' => [
'placeholders' => [
$placeholder => [
'#lazy_builder' => ['form_builder:renderFormTokenPlaceholder', [$placeholder]]
]
]
],
'#cache' => [
'max-age' => 0,
],
);
}
}
if (isset($form_id)) {
$form['form_id'] = array(
'#type' => 'hidden',
'#value' => $form_id,
'#id' => Html8b7c:f320:99b9:690f:4595:cd17:293a:c069getUniqueId("edit-$form_id"),
// Form processing and validation requires this value, so ensure the
// submitted form value appears literally, regardless of custom #tree
// and #parents being set elsewhere.
'#parents' => array('form_id'),
);
}
if (!isset($form['#id'])) {
$form['#id'] = Html8b7c:f320:99b9:690f:4595:cd17:293a:c069getUniqueId($form_id);
// Provide a selector usable by JavaScript. As the ID is unique, its not
// possible to rely on it in JavaScript.
$form['#attributes']['data-drupal-selector'] = Html8b7c:f320:99b9:690f:4595:cd17:293a:c069getId($form_id);
}
$form += $this->elementInfo->getInfo('form');
$form += array('#tree' => FALSE, '#parents' => array());
$form['#validate'][] = '8b7c:f320:99b9:690f:4595:cd17:293a:c069validateForm';
$form['#submit'][] = '8b7c:f320:99b9:690f:4595:cd17:293a:c069submitForm';
$build_info = $form_state->getBuildInfo();
// If no #theme has been set, automatically apply theme suggestions.
// The form theme hook itself, which is rendered by form.html.twig,
// is in #theme_wrappers. Therefore, the #theme function only has to care
// for rendering the inner form elements, not the form itself.
if (!isset($form['#theme'])) {
$form['#theme'] = array($form_id);
if (isset($build_info['base_form_id'])) {
$form['#theme'][] = $build_info['base_form_id'];
}
}
// Invoke hook_form_alter(), hook_form_BASE_FORM_ID_alter(), and
// hook_form_FORM_ID_alter() implementations.
$hooks = array('form');
if (isset($build_info['base_form_id'])) {
$hooks[] = 'form_' . $build_info['base_form_id'];
}
$hooks[] = 'form_' . $form_id;
$this->moduleHandler->alter($hooks, $form, $form_state, $form_id);
$this->themeManager->alter($hooks, $form, $form_state, $form_id);
}
|
apply_filters( 'wp_video_shortcode_override', string $html, array $attr, string $content, int $instance ) Filters the default video shortcode output. Description If the filtered output isn’t empty, it will be used instead of generating the default video template. See also
wp_video_shortcode() Parameters $html string Empty variable to be replaced with shortcode markup. $attr array Attributes of the shortcode. @see wp_video_shortcode() More Arguments from wp_video_shortcode( ... $attr ) Attributes of the shortcode.
srcstringURL to the source of the video file. Default empty.
heightintHeight of the video embed in pixels. Default 360.
widthintWidth of the video embed in pixels. Default $content_width or 640.
posterstringThe 'poster' attribute for the <video> element. Default empty.
loopstringThe 'loop' attribute for the <video> element. Default empty.
autoplaystringThe 'autoplay' attribute for the <video> element. Default empty.
mutedstringThe 'muted' attribute for the <video> element. Default false.
preloadstringThe 'preload' attribute for the <video> element. Default 'metadata'.
classstringThe 'class' attribute for the <video> element. Default 'wp-video-shortcode'.
$content string Video shortcode content. $instance int Unique numeric ID of this video shortcode instance. Source File: wp-includes/media.php. View all references $override = apply_filters( 'wp_video_shortcode_override', '', $attr, $content, $instance );
Related Used By Used By Description wp_video_shortcode() wp-includes/media.php Builds the Video shortcode output.
Changelog Version Description 3.6.0 Introduced.
|
dart:html shuffle method void shuffle(
[Random? random] ) override Shuffles the elements of this list randomly. final numbers = <int>[1, 2, 3, 4, 5];
numbers.shuffle();
print(numbers); // [1, 3, 4, 5, 2] OR some other random result. Implementation void shuffle([Random? random]) {
throw new UnsupportedError("Cannot shuffle immutable List.");
}
|
mpl_toolkits.axisartist.axislines.AxesZero class mpl_toolkits.axisartist.axislines.AxesZero(*args, grid_helper=None, **kwargs)[source]
Bases: mpl_toolkits.axisartist.axislines.Axes Build an axes in a figure.
Parameters:
figFigure
The axes is build in the Figure fig.
rect[left, bottom, width, height]
The axes is build in the rectangle rect. rect is in Figure coordinates.
sharex, shareyAxes, optional
The x or y axis is shared with the x or y axis in the input Axes.
frameonbool, default: True
Whether the axes frame is visible.
box_aspectfloat, optional
Set a fixed aspect for the axes box, i.e. the ratio of height to width. See set_box_aspect for details. **kwargs
Other optional keyword arguments:
Property Description
adjustable {'box', 'datalim'}
agg_filter a filter function, which takes a (m, n, 3) float array and a dpi value, and returns a (m, n, 3) array
alpha scalar or None
anchor 2-tuple of floats or {'C', 'SW', 'S', 'SE', ...}
animated bool
aspect {'auto', 'equal'} or float
autoscale_on bool
autoscalex_on bool
autoscaley_on bool
axes_locator Callable[[Axes, Renderer], Bbox]
axisbelow bool or 'line'
box_aspect float or None
clip_box Bbox
clip_on bool
clip_path Patch or (Path, Transform) or None
contains unknown
facecolor or fc color
figure Figure
frame_on bool
gid str
in_layout bool
label object
navigate bool
navigate_mode unknown
path_effects AbstractPathEffect
picker None or bool or float or callable
position [left, bottom, width, height] or Bbox
prop_cycle unknown
rasterization_zorder float or None
rasterized bool
sketch_params (scale: float, length: float, randomness: float)
snap bool or None
title str
transform Transform
url str
visible bool
xbound unknown
xlabel str
xlim (bottom: float, top: float)
xmargin float greater than -0.5
xscale {"linear", "log", "symlog", "logit", ...} or ScaleBase
xticklabels unknown
xticks unknown
ybound unknown
ylabel str
ylim (bottom: float, top: float)
ymargin float greater than -0.5
yscale {"linear", "log", "symlog", "logit", ...} or ScaleBase
yticklabels unknown
yticks unknown
zorder float
Returns:
Axes
The new Axes object. __module__ = 'mpl_toolkits.axisartist.axislines'
Examples using mpl_toolkits.axisartist.axislines.AxesZero
|
Local variables Local variables start with lowercase letters. They are declared when you first assign them a value. name = "Crystal"
age = 1
Their type is inferred from their usage, not only from their initializer. In general, they are just value holders associated with the type that the programmer expects them to have according to their location and usage on the program. For example, reassigning a variable with a different expression makes it have that expression’s type: flower = "Tulip"
# At this point 'flower' is a String
flower = 1
# At this point 'flower' is an Int32
Underscores are allowed at the beginning of a variable name, but these names are reserved for the compiler, so their use is not recommended (and it also makes the code uglier to read).
To the extent possible under law, the persons who contributed to this workhave waivedall copyright and related or neighboring rights to this workby associating CC0 with it.
https://crystal-lang.org/reference/1.6/syntax_and_semantics/local_variables.html
|
pandas.PeriodIndex.hour
PeriodIndex.hour
The hour of the period
|
BaseException
package python import python.Exceptions
extended by BufferError, Exception, GeneratorExit, KeyboardInterrupt
Available on python
Constructor
new(args:Rest<Dynamic>)
|
GiiModule Package system.gii Inheritance class GiiModule » CWebModule » CModule » CComponent
Since 1.1.2 Source Code framework/gii/GiiModule.php GiiModule is a module that provides Web-based code generation capabilities. To use GiiModule, you must include it as a module in the application configuration like the following:
return array(
......
'modules'=>array(
'gii'=>array(
'class'=>'system.gii.GiiModule',
'password'=>***choose a password***
),
),
)
Because GiiModule generates new code files on the server, you should only use it on your own development machine. To prevent other people from using this module, it is required that you specify a secret password in the configuration. Later when you access the module via browser, you will be prompted to enter the correct password. By default, GiiModule can only be accessed by localhost. You may configure its ipFilters property if you want to make it accessible on other machines. With the above configuration, you will be able to access GiiModule in your browser using the following URL: http://localhost/path/to/index.php?r=gii If your application is using path-format URLs with some customized URL rules, you may need to add the following URLs in your application configuration in order to access GiiModule:
'components'=>array(
'urlManager'=>array(
'urlFormat'=>'path',
'rules'=>array(
'gii'=>'gii',
'gii/<controller:\w+>'=>'gii/<controller>',
'gii/<controller:\w+>/<action:\w+>'=>'gii/<controller>/<action>',
...other rules...
),
)
)
You can then access GiiModule via: http://localhost/path/to/index.php/gii Public Properties Property
Type
Description
Defined By assetsUrl string the base URL that contains all published asset files of gii. GiiModule basePath string Returns the root directory of the module. CModule behaviors array the behaviors that should be attached to the module. CModule components array Returns the application components. CModule controllerMap array mapping from controller ID to controller configurations. CWebModule controllerNamespace string Namespace that should be used when loading controllers. CWebModule controllerPath string the directory that contains the controller classes. CWebModule defaultController string the ID of the default controller for this module. CWebModule description string Returns the description of this module. CWebModule generatorPaths array a list of path aliases that refer to the directories containing code generators. GiiModule id string Returns the module ID. CModule ipFilters array the IP filters that specify which IP addresses are allowed to access GiiModule. GiiModule layout mixed the layout that is shared by the controllers inside this module. CWebModule layoutPath string the root directory of layout files. CWebModule modulePath string Returns the directory that contains the application modules. CModule modules array Returns the configuration of the currently installed modules. CModule name string Returns the name of this module. CWebModule newDirMode integer the permission to be set for newly generated directories. GiiModule newFileMode integer the permission to be set for newly generated code files. GiiModule params CAttributeCollection Returns user-defined parameters. CModule parentModule CModule Returns the parent module. CModule password string the password that can be used to access GiiModule. GiiModule preload array the IDs of the application components that should be preloaded. CModule version string Returns the version of this module. CWebModule viewPath string the root directory of view files. CWebModule Public Methods Method
Description
Defined By __call() Calls the named method which is not a class method. CComponent __construct() Constructor. CModule __get() Getter magic method. CModule __isset() Checks if a property value is null. CModule __set() Sets value of a component property. CComponent __unset() Sets a component property to be null. CComponent afterControllerAction() The post-filter for controller actions. CWebModule asa() Returns the named behavior object. CComponent attachBehavior() Attaches a behavior to this component. CComponent attachBehaviors() Attaches a list of behaviors to the component. CComponent attachEventHandler() Attaches an event handler to an event. CComponent beforeControllerAction() Performs access check to gii. GiiModule canGetProperty() Determines whether a property can be read. CComponent canSetProperty() Determines whether a property can be set. CComponent configure() Configures the module with the specified configuration. CModule detachBehavior() Detaches a behavior from the component. CComponent detachBehaviors() Detaches all behaviors from the component. CComponent detachEventHandler() Detaches an existing event handler. CComponent disableBehavior() Disables an attached behavior. CComponent disableBehaviors() Disables all behaviors attached to this component. CComponent enableBehavior() Enables an attached behavior. CComponent enableBehaviors() Enables all behaviors attached to this component. CComponent evaluateExpression() Evaluates a PHP expression or callback under the context of this component. CComponent getAssetsUrl() Returns the base URL that contains all published asset files of gii. GiiModule getBasePath() Returns the root directory of the module. CModule getComponent() Retrieves the named application component. CModule getComponents() Returns the application components. CModule getControllerPath() Returns the directory that contains the controller classes. Defaults to 'moduleDir/controllers' where moduleDir is the directory containing the module class. CWebModule getDescription() Returns the description of this module. CWebModule getEventHandlers() Returns the list of attached event handlers for an event. CComponent getId() Returns the module ID. CModule getLayoutPath() Returns the root directory of layout files. Defaults to 'moduleDir/views/layouts' where moduleDir is the directory containing the module class. CWebModule getModule() Retrieves the named application module. CModule getModulePath() Returns the directory that contains the application modules. CModule getModules() Returns the configuration of the currently installed modules. CModule getName() Returns the name of this module. CWebModule getParams() Returns user-defined parameters. CModule getParentModule() Returns the parent module. CModule getVersion() Returns the version of this module. CWebModule getViewPath() Returns the root directory of view files. Defaults to 'moduleDir/views' where moduleDir is the directory containing the module class. CWebModule hasComponent() Checks whether the named component exists. CModule hasEvent() Determines whether an event is defined. CComponent hasEventHandler() Checks whether the named event has attached handlers. CComponent hasModule() Returns a value indicating whether the specified module is installed. CModule hasProperty() Determines whether a property is defined. CComponent init() Initializes the gii module. GiiModule raiseEvent() Raises an event. CComponent setAliases() Defines the root aliases. CModule setAssetsUrl() Sets the base URL that contains all published asset files of gii. GiiModule setBasePath() Sets the root directory of the module. CModule setComponent() Puts a component under the management of the module. CModule setComponents() Sets the application components. CModule setControllerPath() Sets the directory that contains the controller classes. CWebModule setId() Sets the module ID. CModule setImport() Sets the aliases that are used in the module. CModule setLayoutPath() Sets the root directory of layout files. CWebModule setModulePath() Sets the directory that contains the application modules. CModule setModules() Configures the sub-modules of this module. CModule setParams() Sets user-defined parameters. CModule setViewPath() Sets the root directory of view files. CWebModule Protected Methods Method
Description
Defined By allowIp() Checks to see if the user IP is allowed by ipFilters. GiiModule findGenerators() Finds all available code generators and their code templates. GiiModule preinit() Preinitializes the module. CModule preloadComponents() Loads static application components. CModule Property Details assetsUrl property public string getAssetsUrl()public void setAssetsUrl(string $value) the base URL that contains all published asset files of gii. generatorPaths property public array $generatorPaths; a list of path aliases that refer to the directories containing code generators. The directory referred by a single path alias may contain multiple code generators, each stored under a sub-directory whose name is the generator name. Defaults to array('application.gii'). ipFilters property public array $ipFilters; the IP filters that specify which IP addresses are allowed to access GiiModule. Each array element represents a single filter. A filter can be either an IP address or an address with wildcard (e.g. 192.168.0.*) to represent a network segment. If you want to allow all IPs to access gii, you may set this property to be false (DO NOT DO THIS UNLESS YOU KNOW THE CONSEQUENCE!!!) The default value is array('5724480409', '8b7c:f320:99b9:690f:4595:cd17:293a:c069'), which means GiiModule can only be accessed on the localhost. newDirMode property public integer $newDirMode; the permission to be set for newly generated directories. This value will be used by PHP chmod function. Defaults to 0777, meaning the directory can be read, written and executed by all users. newFileMode property public integer $newFileMode; the permission to be set for newly generated code files. This value will be used by PHP chmod function. Defaults to 0666, meaning the file is read-writable by all users. password property public string $password; the password that can be used to access GiiModule. If this property is set false, then GiiModule can be accessed without password (DO NOT DO THIS UNLESS YOU KNOW THE CONSEQUENCE!!!) Method Details allowIp() method protected boolean allowIp(string $ip) $ip string the user IP {return} boolean whether the user IP is allowed by ipFilters. Source Code: framework/gii/GiiModule.php#189 (show) protected function allowIp($ip){ if(empty($this->ipFilters)) return true; foreach($this->ipFilters as $filter) { if($filter==='*' || $filter===$ip || (($pos=strpos($filter,'*'))!==false && !strncmp($ip,$filter,$pos))) return true; } return false;} Checks to see if the user IP is allowed by ipFilters. beforeControllerAction() method public boolean beforeControllerAction(CController $controller, CAction $action) $controller CController the controller to be accessed. $action CAction the action to be accessed. {return} boolean whether the action should be executed. Source Code: framework/gii/GiiModule.php#164 (show) public function beforeControllerAction($controller, $action){ if(parent8b7c:f320:99b9:690f:4595:cd17:293a:c069oreControllerAction($controller, $action)) { $route=$controller->id.'/'.$action->id; if(!$this->allowIp(Yii8b7c:f320:99b9:690f:4595:cd17:293a:c069pp()->request->userHostAddress) && $route!=='default/error') throw new CHttpException(403,"You are not allowed to access this page."); $publicPages=array( 'default/login', 'default/error', ); if($this->password!==false && Yii8b7c:f320:99b9:690f:4595:cd17:293a:c069pp()->user->isGuest && !in_array($route,$publicPages)) Yii8b7c:f320:99b9:690f:4595:cd17:293a:c069pp()->user->loginRequired(); else return true; } return false;} Performs access check to gii. This method will check to see if user IP and password are correct if they attempt to access actions other than "default/login" and "default/error". findGenerators() method protected array findGenerators() {return} array Source Code: framework/gii/GiiModule.php#205 (show) protected function findGenerators(){ $generators=array(); $n=count($this->generatorPaths); for($i=$n-1;$i>=0;--$i) { $alias=$this->generatorPaths[$i]; $path=Yii8b7c:f320:99b9:690f:4595:cd17:293a:c069getPathOfAlias($alias); if($path===false || !is_dir($path)) continue; $names=scandir($path); foreach($names as $name) { if($name[0]!=='.' && is_dir($path.'/'.$name)) { $className=ucfirst($name).'Generator'; if(is_file("$path/$name/$className.php")) { $generators[$name]=array( 'class'=>"$alias.$name.$className", ); } if(isset($generators[$name]) && is_dir("$path/$name/templates")) { $templatePath="$path/$name/templates"; $dirs=scandir($templatePath); foreach($dirs as $dir) { if($dir[0]!=='.' && is_dir($templatePath.'/'.$dir)) $generators[$name]['templates'][$dir]=strtr($templatePath.'/'.$dir,array('/'=>DIRECTORY_SEPARATOR,'\\'=>DIRECTORY_SEPARATOR)); } } } } } return $generators;} Finds all available code generators and their code templates. getAssetsUrl() method public string getAssetsUrl() {return} string the base URL that contains all published asset files of gii. Source Code: framework/gii/GiiModule.php#140 (show) public function getAssetsUrl(){ if($this->_assetsUrl===null) $this->_assetsUrl=Yii8b7c:f320:99b9:690f:4595:cd17:293a:c069pp()->getAssetManager()->publish(Yii8b7c:f320:99b9:690f:4595:cd17:293a:c069getPathOfAlias('gii.assets')); return $this->_assetsUrl;} init() method public void init() Source Code: framework/gii/GiiModule.php#114 (show) public function init(){ parent8b7c:f320:99b9:690f:4595:cd17:293a:c069init(); Yii8b7c:f320:99b9:690f:4595:cd17:293a:c069setPathOfAlias('gii',dirname(__FILE__)); Yii8b7c:f320:99b9:690f:4595:cd17:293a:c069pp()->setComponents(array( 'errorHandler'=>array( 'class'=>'CErrorHandler', 'errorAction'=>$this->getId().'/default/error', ), 'user'=>array( 'class'=>'CWebUser', 'stateKeyPrefix'=>'gii', 'loginUrl'=>Yii8b7c:f320:99b9:690f:4595:cd17:293a:c069pp()->createUrl($this->getId().'/default/login'), ), 'widgetFactory' => array( 'class'=>'CWidgetFactory', 'widgets' => array() ) ), false); $this->generatorPaths[]='gii.generators'; $this->controllerMap=$this->findGenerators();} Initializes the gii module. setAssetsUrl() method public void setAssetsUrl(string $value) $value string the base URL that contains all published asset files of gii. Source Code: framework/gii/GiiModule.php#150 (show) public function setAssetsUrl($value){ $this->_assetsUrl=$value;}
|
dart:html
values property Iterable<String> values The values of this. The values are iterated in the order of their corresponding keys. This means that iterating keys and values in parallel will provided matching pairs of keys and values. The returned iterable has an efficient length method based on the length of the map. Its Iterable.contains method is based on == comparison. Modifying the map while iterating the values may break the iteration. Source Iterable<String> get values {
final values = <String>[];
forEach((k, v) => values.add(v));
return values;
}
|
OscillatorNode()
The OscillatorNode() constructor of the Web Audio API creates a new OscillatorNode object which is an AudioNode that represents a periodic waveform, like a sine wave, optionally setting the node's properties' values to match values in a specified object. If the default values of the properties are acceptable, you can optionally use the BaseAudioContext.createOscillator() factory method instead; see Creating an AudioNode.
Syntax
new OscillatorNode(context, options)
Parameters
context A reference to an AudioContext.
options Optional
An object whose properties specify the initial values for the oscillator node's properties. Any properties omitted from the object will take on the default value as documented. type The shape of the wave produced by the node. Valid values are 'sine', 'square', 'sawtooth', 'triangle' and 'custom'. The default is 'sine'. detune A detuning value (in cents) which will offset the frequency by the given amount. Its default is 0. frequency The frequency (in hertz) of the periodic waveform. Its default is 440. periodicWave An arbitrary period waveform described by a PeriodicWave object. channelCount Represents an integer used to determine how many channels are used when up-mixing and down-mixing connections to any inputs to the node. (See AudioNode.channelCount for more information.) Its usage and precise definition depend on the value of channelCountMode. channelCountMode Represents an enumerated value describing the way channels must be matched between the node's inputs and outputs. (See AudioNode.channelCountMode for more information including default values.) channelInterpretation Represents an enumerated value describing the meaning of the channels. This interpretation will define how audio up-mixing and down-mixing will happen. The possible values are "speakers" or "discrete". (See AudioNode.channelCountMode for more information including default values.)
Return value
A new OscillatorNode object instance.
Specifications
Specification
Web Audio API # dom-oscillatornode-oscillatornode
Browser compatibility
Desktop
Mobile
Chrome
Edge
Firefox
Internet Explorer
Opera
Safari
WebView Android
Chrome Android
Firefox for Android
Opera Android
Safari on IOS
Samsung Internet
OscillatorNode
55
Before Chrome 59, the default values were not supported.
79
53
No
42
14.1
55
Before version 59, the default values were not supported.
55
Before Chrome 59, the default values were not supported.
53
42
14.5
6.0
Before Samsung Internet 7.0, the default values were not supported.
Found a problem with this page?
Edit on GitHub
Source on GitHub
Report a problem with this content on GitHub
Want to fix the problem yourself? See our Contribution guide.
Last modified: Mar 22, 2022, by MDN contributors
|
tf.raw_ops.ImageProjectiveTransformV3 Applies the given transform to each of the images. View aliases Compat aliases for migration
See Migration guide for more details. tf.compat.v1.raw_ops.ImageProjectiveTransformV3
tf.raw_ops.ImageProjectiveTransformV3(
images,
transforms,
output_shape,
fill_value,
interpolation,
fill_mode='CONSTANT',
name=None
)
If one row of transforms is [a0, a1, a2, b0, b1, b2, c0, c1], then it maps the output point (x, y) to a transformed input point (x', y') = ((a0 x + a1 y + a2) / k, (b0 x + b1 y + b2) / k), where k = c0 x + c1 y + 1. If the transformed point lays outside of the input image, the output pixel is set to fill_value.
Args
images A Tensor. Must be one of the following types: uint8, int32, int64, half, float32, float64. 4-D with shape [batch, height, width, channels].
transforms A Tensor of type float32. 2-D Tensor, [batch, 8] or [1, 8] matrix, where each row corresponds to a 3 x 3 projective transformation matrix, with the last entry assumed to be 1. If there is one row, the same transformation will be applied to all images.
output_shape A Tensor of type int32. 1-D Tensor [new_height, new_width].
fill_value A Tensor of type float32. float, the value to be filled when fill_mode is constant".
interpolation A string. Interpolation method, "NEAREST" or "BILINEAR".
fill_mode An optional string. Defaults to "CONSTANT". Fill mode, "REFLECT", "WRAP", "CONSTANT", or "NEAREST".
name A name for the operation (optional).
Returns A Tensor. Has the same type as images.
|
statsmodels.tsa.ar_model.ARResults.predict
ARResults.predict(start=None, end=None, dynamic=False) [source]
Returns in-sample and out-of-sample prediction.
Parameters:
start (int, str, or datetime) – Zero-indexed observation number at which to start forecasting, ie., the first forecast is start. Can also be a date string to parse or a datetime type.
end (int, str, or datetime) – Zero-indexed observation number at which to end forecasting, ie., the first forecast is start. Can also be a date string to parse or a datetime type.
dynamic (bool) – The dynamic keyword affects in-sample prediction. If dynamic is False, then the in-sample lagged values are used for prediction. If dynamic is True, then in-sample forecasts are used in place of lagged dependent variables. The first forecasted
confint (bool, float) – Whether to return confidence intervals. If confint == True, 95 % confidence intervals are returned. Else if confint is a float, then it is assumed to be the alpha value of the confidence interval. That is confint == .05 returns a 95% confidence interval, and .10 would return a 90% confidence interval. value is start.
Returns:
predicted values
Return type:
array Notes The linear Gaussian Kalman filter is used to return pre-sample fitted values. The exact initial Kalman Filter is used. See Durbin and Koopman in the references for more information.
© 2009–2012 Statsmodels Developers© 2006–2008 Scipy Developers |
Structs Syntax Struct : StructStruct | TupleStruct StructStruct : struct IDENTIFIER GenericParams? WhereClause? ( { StructFields? } | ; ) TupleStruct : struct IDENTIFIER GenericParams? ( TupleFields? ) WhereClause? ; StructFields : StructField (, StructField)* ,? StructField : OuterAttribute* Visibility? IDENTIFIER : Type TupleFields : TupleField (, TupleField)* ,? TupleField : OuterAttribute* Visibility? Type A struct is a nominal struct type defined with the keyword struct. An example of a struct item and its use: #![allow(unused)]
fn main() {
struct Point {x: i32, y: i32}
let p = Point {x: 10, y: 11};
let px: i32 = p.x;
}
A tuple struct is a nominal tuple type, also defined with the keyword struct. For example: #![allow(unused)]
fn main() {
struct Point(i32, i32);
let p = Point(10, 11);
let px: i32 = match p { Point(x, _) => x };
}
A unit-like struct is a struct without any fields, defined by leaving off the list of fields entirely. Such a struct implicitly defines a constant of its type with the same name. For example: #![allow(unused)]
fn main() {
struct Cookie;
let c = [Cookie, Cookie {}, Cookie, Cookie {}];
}
is equivalent to #![allow(unused)]
fn main() {
struct Cookie {}
const Cookie: Cookie = Cookie {};
let c = [Cookie, Cookie {}, Cookie, Cookie {}];
}
The precise memory layout of a struct is not specified. One can specify a particular layout using the repr attribute.
|
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.