| [ Index ] |
PHP Cross Reference of WordPress |
[Source view] [Print] [Project Stats]
The identifier for the data store.
| File Size: | 1030 lines (32 kb) |
| Included or required: | 0 times |
| Referenced: | 0 times |
| Includes or requires: | 0 files |
| applyAnnotations(record) X-Ref |
| Applies given annotations to the given record. return: {Object} A record with the annotations applied. param: {Object} record The record to apply annotations to. param: {Array} annotations The annotation to apply. |
| removeAnnotations(record) X-Ref |
| Removes annotations from the given record. return: {Object} The cleaned record. param: {Object} record Record to remove annotations from. |
| retrieveAnnotationPositions(formats) X-Ref |
| Retrieves the positions of annotations inside an array of formats. return: {Object} ID keyed positions of annotations. param: {Array} formats Formats with annotations in there. |
| updateAnnotationsWithPositions(annotations, positions, _ref) X-Ref |
| Updates annotations in the state based on positions retrieved from RichText. param: {Array} annotations The annotations that are currently applied. param: {Array} positions The current positions of the given annotations. param: {Object} actions param: {Function} actions.removeAnnotation Function to remove an annotation from the state. param: {Function} actions.updateAnnotationRange Function to update an annotation range in the state. |
| filterWithReference(collection, predicate) X-Ref |
| Filters an array based on the predicate, but keeps the reference the same if the array hasn't changed. return: {Array} Filtered array. param: {Array} collection The collection to filter. param: {Function} predicate Function that determines if the item should stay |
| isValidAnnotationRange(annotation) X-Ref |
| Verifies whether the given annotations is a valid annotation. return: {boolean} Whether the given annotation is valid. param: {Object} annotation The annotation to verify. |
| annotations() X-Ref |
| Reducer managing annotations. return: {Array} Updated state. param: {Object} state The annotations currently shown in the editor. param: {Object} action Dispatched action. |
| arrayOf( value ) X-Ref |
| Returns the first argument as the sole entry in an array. return: {Array} Value returned as entry in array. param: {*} value Value to return. |
| isObjectLike( value ) X-Ref |
| Returns true if the value passed is object-like, or false otherwise. A value is object-like if it can support property assignment, e.g. object or array. return: {boolean} Whether value is object-like. param: {*} value Value to test. |
| createCache() X-Ref |
| Creates and returns a new cache object. return: {Object} Cache object. |
| isShallowEqual( a, b, fromIndex ) X-Ref |
| Returns true if entries within the two arrays are strictly equal by reference from a starting index. return: {boolean} Whether arrays are shallowly equal. param: {Array} a First array. param: {Array} b Second array. param: {number} fromIndex Index from which to start comparison. |
| rememo(selector, getDependants ) X-Ref |
| Returns a memoized selector function. The getDependants function argument is called before the memoized selector and is expected to return an immutable reference or array of references on which the selector depends for computing its own return value. The memoize cache is preserved only as long as those dependant references remain the same. If getDependants returns a different reference(s), the cache is cleared and the selector value regenerated. return: {Function} Memoized selector. param: {Function} selector Selector function. param: {Function} getDependants Dependant getter returning an immutable |
| getRootCache() X-Ref |
| Returns the root cache. If WeakMap is supported, this is assigned to the root WeakMap cache set, otherwise it is a shared instance of the default cache object. return: {(WeakMap|Object)} Root cache object. |
| getWeakMapCache( dependants ) X-Ref |
| Returns the cache for a given dependants array. When possible, a WeakMap will be used to create a unique cache for each set of dependants. This is feasible due to the nature of WeakMap in allowing garbage collection to occur on entries where the key object is no longer referenced. Since WeakMap requires the key to be an object, this is only possible when the dependant is object-like. The root cache is created as a hierarchy where each top-level key is the first entry in a dependants set, the value a WeakMap where each key is the next dependant, and so on. This continues so long as the dependants are object-like. If no dependants are object- like, then the cache is shared across all invocations. return: {Object} Cache object. param: {Array} dependants Selector dependants. |
| clear() X-Ref |
| Resets root memoization cache. |
| callSelector( ) X-Ref |
| The augmented selector call, considering first whether dependants have changed before passing it to underlying memoize function. return: {*} Selector result. param: {Object} source Source object for derivation. param: {...*} extraArgs Additional arguments to pass to selector. |
| __experimentalGetAllAnnotationsForBlock(state, blockClientId) X-Ref |
| No description |
| __experimentalGetAnnotations(state) X-Ref |
| Returns all annotations in the editor state. return: {Array} All annotations currently applied. param: {Object} state Editor state. |
| rng() X-Ref |
| No description |
| validate(uuid) X-Ref |
| No description |
| stringify(arr) X-Ref |
| No description |
| v4(options, buf, offset) X-Ref |
| No description |
| __experimentalAddAnnotation(_ref) X-Ref |
| Adds an annotation to a block. The `block` attribute refers to a block ID that needs to be annotated. `isBlockAnnotation` controls whether or not the annotation is a block annotation. The `source` is the source of the annotation, this will be used to identity groups of annotations. The `range` property is only relevant if the selector is 'range'. return: {Object} Action object. param: {Object} annotation The annotation to add. param: {string} annotation.blockClientId The blockClientId to add the annotation to. param: {string} annotation.richTextIdentifier Identifier for the RichText instance the annotation applies to. param: {WPAnnotationRange} annotation.range The range at which to apply this annotation. param: {string} [annotation.selector="range"] The way to apply this annotation. param: {string} [annotation.source="default"] The source that added the annotation. param: {string} [annotation.id] The ID the annotation should have. Generates a UUID by default. |
| __experimentalRemoveAnnotation(annotationId) X-Ref |
| Removes an annotation with a specific ID. return: {Object} Action object. param: {string} annotationId The annotation to remove. |
| __experimentalUpdateAnnotationRange(annotationId, start, end) X-Ref |
| Updates the range of an annotation. return: {Object} Action object. param: {string} annotationId ID of the annotation to update. param: {number} start The start of the new range. param: {number} end The end of the new range. |
| __experimentalRemoveAnnotationsBySource(source) X-Ref |
| Removes all annotations of a specific source. return: {Object} Action object. param: {string} source The source to remove. |
| Generated: Fri Apr 19 01:00:02 2024 | Cross-referenced by PHPXref 0.7.1 |