From 9a0f0800f56c87cccf7b047944016ebd59ed89c4 Mon Sep 17 00:00:00 2001 From: Jordi Kroon Date: Fri, 11 Sep 2026 10:43:23 +0200 Subject: [PATCH 1/2] Docbook-cs sweep --- contributors.xml | 18 +- reference/apcu/apcuiterator.xml | 2 +- reference/apcu/apcuiterator/construct.xml | 2 +- reference/apcu/apcuiterator/current.xml | 2 +- reference/apcu/apcuiterator/gettotalcount.xml | 2 +- reference/apcu/apcuiterator/gettotalhits.xml | 2 +- reference/apcu/apcuiterator/gettotalsize.xml | 2 +- reference/apcu/apcuiterator/key.xml | 2 +- reference/apcu/apcuiterator/next.xml | 2 +- reference/apcu/apcuiterator/rewind.xml | 2 +- reference/apcu/apcuiterator/valid.xml | 2 +- reference/apcu/book.xml | 2 +- reference/apcu/constants.xml | 2 +- reference/apcu/functions/apcu-add.xml | 2 +- reference/apcu/functions/apcu-cache-info.xml | 2 +- reference/apcu/functions/apcu-cas.xml | 2 +- reference/apcu/functions/apcu-clear-cache.xml | 2 +- reference/apcu/functions/apcu-dec.xml | 2 +- reference/apcu/functions/apcu-delete.xml | 2 +- reference/apcu/functions/apcu-enabled.xml | 2 +- reference/apcu/functions/apcu-entry.xml | 2 +- reference/apcu/functions/apcu-exists.xml | 2 +- reference/apcu/functions/apcu-fetch.xml | 2 +- reference/apcu/functions/apcu-inc.xml | 2 +- reference/apcu/functions/apcu-key-info.xml | 2 +- reference/apcu/functions/apcu-sma-info.xml | 2 +- reference/apcu/functions/apcu-store.xml | 2 +- reference/apcu/ini.xml | 2 +- reference/apcu/setup.xml | 2 +- reference/cmark/book.xml | 2 +- reference/cmark/commonmark.cql.xml | 2 +- .../commonmark.interfaces.ivisitable.xml | 2 +- .../cmark/commonmark.interfaces.ivisitor.xml | 2 +- .../cmark/commonmark.node.blockquote.xml | 6 +- .../cmark/commonmark.node.bulletlist.xml | 6 +- reference/cmark/commonmark.node.code.xml | 4 +- reference/cmark/commonmark.node.codeblock.xml | 6 +- .../cmark/commonmark.node.customblock.xml | 6 +- .../cmark/commonmark.node.custominline.xml | 8 +- reference/cmark/commonmark.node.document.xml | 6 +- reference/cmark/commonmark.node.heading.xml | 6 +- reference/cmark/commonmark.node.htmlblock.xml | 6 +- .../cmark/commonmark.node.htmlinline.xml | 6 +- reference/cmark/commonmark.node.image.xml | 6 +- reference/cmark/commonmark.node.item.xml | 6 +- reference/cmark/commonmark.node.linebreak.xml | 6 +- reference/cmark/commonmark.node.link.xml | 6 +- .../cmark/commonmark.node.orderedlist.xml | 6 +- reference/cmark/commonmark.node.paragraph.xml | 6 +- reference/cmark/commonmark.node.softbreak.xml | 6 +- .../cmark/commonmark.node.text.emphasis.xml | 6 +- .../cmark/commonmark.node.text.strong.xml | 6 +- reference/cmark/commonmark.node.text.xml | 6 +- .../cmark/commonmark.node.thematicbreak.xml | 6 +- reference/cmark/commonmark.node.xml | 2 +- reference/cmark/commonmark.parser.xml | 2 +- reference/cmark/commonmark/cql/construct.xml | 2 +- reference/cmark/commonmark/cql/invoke.xml | 2 +- .../interfaces/ivisitable/accept.xml | 2 +- .../commonmark/interfaces/ivisitor/enter.xml | 2 +- .../commonmark/interfaces/ivisitor/leave.xml | 2 +- reference/cmark/commonmark/node/accept.xml | 2 +- .../cmark/commonmark/node/appendchild.xml | 2 +- .../commonmark/node/bulletlist/construct.xml | 2 +- .../commonmark/node/codeblock/construct.xml | 2 +- .../commonmark/node/heading/construct.xml | 2 +- .../cmark/commonmark/node/image/construct.xml | 2 +- .../cmark/commonmark/node/insertafter.xml | 2 +- .../cmark/commonmark/node/insertbefore.xml | 2 +- .../cmark/commonmark/node/link/construct.xml | 2 +- .../commonmark/node/orderedlist/construct.xml | 2 +- .../cmark/commonmark/node/prependchild.xml | 2 +- reference/cmark/commonmark/node/replace.xml | 2 +- .../cmark/commonmark/node/text/construct.xml | 2 +- reference/cmark/commonmark/node/unlink.xml | 2 +- .../cmark/commonmark/parser/construct.xml | 2 +- reference/cmark/commonmark/parser/finish.xml | 2 +- reference/cmark/commonmark/parser/parse.xml | 2 +- reference/cmark/configure.xml | 2 +- .../cmark/functions/commonmark.parse.xml | 2 +- .../functions/commonmark.render.html.xml | 2 +- .../functions/commonmark.render.latex.xml | 2 +- .../cmark/functions/commonmark.render.man.xml | 2 +- .../cmark/functions/commonmark.render.xml | 2 +- .../cmark/functions/commonmark.render.xml.xml | 2 +- reference/cmark/setup.xml | 2 +- reference/componere/book.xml | 2 +- .../componere.abstract.definition.xml | 2 +- reference/componere/componere.definition.xml | 2 +- reference/componere/componere.method.xml | 2 +- reference/componere/componere.patch.xml | 2 +- reference/componere/componere.value.xml | 2 +- .../abstract/definition/addinterface.xml | 2 +- .../abstract/definition/addmethod.xml | 2 +- .../abstract/definition/addtrait.xml | 2 +- .../abstract/definition/getreflector.xml | 2 +- .../componere/definition/addconstant.xml | 2 +- .../componere/definition/addproperty.xml | 2 +- .../componere/definition/construct.xml | 2 +- .../componere/definition/getclosure.xml | 2 +- .../componere/definition/getclosures.xml | 2 +- .../componere/definition/isregistered.xml | 2 +- .../componere/definition/register.xml | 2 +- .../componere/componere/method/construct.xml | 2 +- .../componere/method/getreflector.xml | 2 +- .../componere/componere/method/setprivate.xml | 2 +- .../componere/method/setprotected.xml | 2 +- .../componere/componere/method/setstatic.xml | 2 +- reference/componere/componere/patch/apply.xml | 2 +- .../componere/componere/patch/construct.xml | 2 +- .../componere/componere/patch/derive.xml | 2 +- .../componere/componere/patch/getclosure.xml | 2 +- .../componere/componere/patch/getclosures.xml | 2 +- .../componere/componere/patch/revert.xml | 2 +- .../componere/componere/value/construct.xml | 2 +- .../componere/componere/value/hasdefault.xml | 2 +- .../componere/componere/value/isprivate.xml | 2 +- .../componere/componere/value/isprotected.xml | 2 +- .../componere/componere/value/isstatic.xml | 2 +- .../componere/componere/value/setprivate.xml | 2 +- .../componere/value/setprotected.xml | 2 +- .../componere/componere/value/setstatic.xml | 2 +- reference/componere/configure.xml | 2 +- .../componere/functions/componere.cast.xml | 2 +- .../functions/componere.cast_by_ref.xml | 2 +- reference/componere/setup.xml | 2 +- reference/cubrid/book.xml | 2 +- reference/cubrid/configure.xml | 2 +- reference/cubrid/constants.xml | 2 +- .../cubridmysql/cubrid-affected-rows.xml | 2 +- .../cubridmysql/cubrid-client-encoding.xml | 2 +- reference/cubrid/cubridmysql/cubrid-close.xml | 2 +- .../cubrid/cubridmysql/cubrid-data-seek.xml | 2 +- .../cubrid/cubridmysql/cubrid-db-name.xml | 2 +- reference/cubrid/cubridmysql/cubrid-errno.xml | 2 +- reference/cubrid/cubridmysql/cubrid-error.xml | 2 +- .../cubrid/cubridmysql/cubrid-fetch-array.xml | 2 +- .../cubrid/cubridmysql/cubrid-fetch-assoc.xml | 2 +- .../cubrid/cubridmysql/cubrid-fetch-field.xml | 2 +- .../cubridmysql/cubrid-fetch-lengths.xml | 2 +- .../cubridmysql/cubrid-fetch-object.xml | 2 +- .../cubrid/cubridmysql/cubrid-fetch-row.xml | 2 +- .../cubrid/cubridmysql/cubrid-field-flags.xml | 2 +- .../cubrid/cubridmysql/cubrid-field-len.xml | 2 +- .../cubrid/cubridmysql/cubrid-field-name.xml | 2 +- .../cubrid/cubridmysql/cubrid-field-seek.xml | 2 +- .../cubrid/cubridmysql/cubrid-field-table.xml | 2 +- .../cubrid/cubridmysql/cubrid-field-type.xml | 2 +- .../cubrid/cubridmysql/cubrid-list-dbs.xml | 2 +- .../cubrid/cubridmysql/cubrid-num-fields.xml | 2 +- reference/cubrid/cubridmysql/cubrid-ping.xml | 2 +- reference/cubrid/cubridmysql/cubrid-query.xml | 2 +- .../cubridmysql/cubrid-real-escape-string.xml | 2 +- .../cubrid/cubridmysql/cubrid-result.xml | 2 +- .../cubridmysql/cubrid-unbuffered-query.xml | 2 +- reference/cubrid/examples.xml | 2 +- reference/cubrid/functions/cubrid-bind.xml | 2 +- .../cubrid/functions/cubrid-close-prepare.xml | 2 +- .../cubrid/functions/cubrid-close-request.xml | 2 +- reference/cubrid/functions/cubrid-col-get.xml | 2 +- .../cubrid/functions/cubrid-col-size.xml | 2 +- .../cubrid/functions/cubrid-column-names.xml | 2 +- .../cubrid/functions/cubrid-column-types.xml | 2 +- reference/cubrid/functions/cubrid-commit.xml | 2 +- .../functions/cubrid-connect-with-url.xml | 2 +- reference/cubrid/functions/cubrid-connect.xml | 2 +- .../cubrid/functions/cubrid-current-oid.xml | 2 +- .../cubrid/functions/cubrid-disconnect.xml | 2 +- reference/cubrid/functions/cubrid-drop.xml | 2 +- .../functions/cubrid-error-code-facility.xml | 2 +- .../cubrid/functions/cubrid-error-code.xml | 2 +- .../cubrid/functions/cubrid-error-msg.xml | 2 +- reference/cubrid/functions/cubrid-execute.xml | 2 +- reference/cubrid/functions/cubrid-fetch.xml | 2 +- .../cubrid/functions/cubrid-free-result.xml | 2 +- .../functions/cubrid-get-autocommit.xml | 2 +- .../cubrid/functions/cubrid-get-charset.xml | 2 +- .../functions/cubrid-get-class-name.xml | 2 +- .../functions/cubrid-get-client-info.xml | 2 +- .../functions/cubrid-get-db-parameter.xml | 2 +- .../functions/cubrid-get-query-timeout.xml | 2 +- .../functions/cubrid-get-server-info.xml | 2 +- reference/cubrid/functions/cubrid-get.xml | 2 +- .../cubrid/functions/cubrid-insert-id.xml | 2 +- .../cubrid/functions/cubrid-is-instance.xml | 2 +- .../cubrid/functions/cubrid-lob-close.xml | 2 +- .../cubrid/functions/cubrid-lob-export.xml | 2 +- reference/cubrid/functions/cubrid-lob-get.xml | 2 +- .../cubrid/functions/cubrid-lob-send.xml | 2 +- .../cubrid/functions/cubrid-lob-size.xml | 2 +- .../cubrid/functions/cubrid-lob2-bind.xml | 2 +- .../cubrid/functions/cubrid-lob2-close.xml | 2 +- .../cubrid/functions/cubrid-lob2-export.xml | 2 +- .../cubrid/functions/cubrid-lob2-import.xml | 2 +- .../cubrid/functions/cubrid-lob2-new.xml | 2 +- .../cubrid/functions/cubrid-lob2-read.xml | 2 +- .../cubrid/functions/cubrid-lob2-seek.xml | 2 +- .../cubrid/functions/cubrid-lob2-seek64.xml | 2 +- .../cubrid/functions/cubrid-lob2-size.xml | 2 +- .../cubrid/functions/cubrid-lob2-size64.xml | 2 +- .../cubrid/functions/cubrid-lob2-tell.xml | 2 +- .../cubrid/functions/cubrid-lob2-tell64.xml | 2 +- .../cubrid/functions/cubrid-lob2-write.xml | 2 +- .../cubrid/functions/cubrid-lock-read.xml | 2 +- .../cubrid/functions/cubrid-lock-write.xml | 2 +- .../cubrid/functions/cubrid-move-cursor.xml | 2 +- .../cubrid/functions/cubrid-next-result.xml | 2 +- .../cubrid/functions/cubrid-num-cols.xml | 2 +- .../cubrid/functions/cubrid-num-rows.xml | 2 +- .../functions/cubrid-pconnect-with-url.xml | 2 +- .../cubrid/functions/cubrid-pconnect.xml | 2 +- reference/cubrid/functions/cubrid-prepare.xml | 2 +- reference/cubrid/functions/cubrid-put.xml | 2 +- .../cubrid/functions/cubrid-rollback.xml | 2 +- reference/cubrid/functions/cubrid-schema.xml | 2 +- .../cubrid/functions/cubrid-seq-drop.xml | 2 +- .../cubrid/functions/cubrid-seq-insert.xml | 2 +- reference/cubrid/functions/cubrid-seq-put.xml | 2 +- reference/cubrid/functions/cubrid-set-add.xml | 2 +- .../functions/cubrid-set-autocommit.xml | 2 +- .../functions/cubrid-set-db-parameter.xml | 2 +- .../cubrid/functions/cubrid-set-drop.xml | 2 +- .../functions/cubrid-set-query-timeout.xml | 2 +- reference/cubrid/functions/cubrid-version.xml | 2 +- .../oldaliases/cubrid-load-from-glo.xml | 2 +- .../cubrid/oldaliases/cubrid-new-glo.xml | 2 +- .../cubrid/oldaliases/cubrid-save-to-glo.xml | 2 +- .../cubrid/oldaliases/cubrid-send-glo.xml | 2 +- reference/cubrid/setup.xml | 4 +- reference/dbase/book.xml | 40 +- reference/dbase/configure.xml | 4 +- .../dbase/functions/dbase-add-record.xml | 32 +- reference/dbase/functions/dbase-close.xml | 14 +- reference/dbase/functions/dbase-create.xml | 24 +- .../dbase/functions/dbase-delete-record.xml | 20 +- .../dbase/functions/dbase-get-header-info.xml | 16 +- .../functions/dbase-get-record-with-names.xml | 20 +- .../dbase/functions/dbase-get-record.xml | 22 +- reference/dbase/functions/dbase-numfields.xml | 18 +- .../dbase/functions/dbase-numrecords.xml | 20 +- reference/dbase/functions/dbase-open.xml | 30 +- reference/dbase/functions/dbase-pack.xml | 12 +- .../dbase/functions/dbase-replace-record.xml | 34 +- reference/dbase/reference.xml | 8 +- reference/dbase/setup.xml | 4 +- reference/dio/book.xml | 14 +- reference/dio/configure.xml | 8 +- reference/dio/constants.xml | 72 ++-- reference/dio/functions/dio-close.xml | 12 +- reference/dio/functions/dio-fcntl.xml | 62 +-- reference/dio/functions/dio-open.xml | 66 +-- reference/dio/functions/dio-read.xml | 18 +- reference/dio/functions/dio-seek.xml | 50 +-- reference/dio/functions/dio-stat.xml | 60 +-- reference/dio/functions/dio-tcsetattr.xml | 34 +- reference/dio/functions/dio-truncate.xml | 28 +- reference/dio/functions/dio-write.xml | 28 +- reference/dio/setup.xml | 4 +- reference/ds/book.xml | 8 +- reference/ds/ds.deque.xml | 14 +- reference/ds/ds.map.xml | 6 +- reference/ds/ds.priorityqueue.xml | 18 +- reference/ds/ds.queue.xml | 6 +- reference/ds/ds.set.xml | 6 +- reference/ds/ds.vector.xml | 6 +- reference/ds/ds/collection/clear.xml | 8 +- reference/ds/ds/collection/copy.xml | 8 +- reference/ds/ds/collection/isempty.xml | 8 +- reference/ds/ds/collection/toarray.xml | 12 +- reference/ds/ds/deque/allocate.xml | 16 +- reference/ds/ds/deque/apply.xml | 16 +- reference/ds/ds/deque/capacity.xml | 8 +- reference/ds/ds/deque/clear.xml | 8 +- reference/ds/ds/deque/construct.xml | 8 +- reference/ds/ds/deque/contains.xml | 12 +- reference/ds/ds/deque/copy.xml | 8 +- reference/ds/ds/deque/count.xml | 4 +- reference/ds/ds/deque/filter.xml | 16 +- reference/ds/ds/deque/find.xml | 16 +- reference/ds/ds/deque/first.xml | 14 +- reference/ds/ds/deque/get.xml | 18 +- reference/ds/ds/deque/insert.xml | 26 +- reference/ds/ds/deque/isempty.xml | 8 +- reference/ds/ds/deque/join.xml | 12 +- reference/ds/ds/deque/jsonserialize.xml | 8 +- reference/ds/ds/deque/last.xml | 14 +- reference/ds/ds/deque/map.xml | 20 +- reference/ds/ds/deque/merge.xml | 16 +- reference/ds/ds/deque/pop.xml | 14 +- reference/ds/ds/deque/push.xml | 12 +- reference/ds/ds/deque/reduce.xml | 20 +- reference/ds/ds/deque/remove.xml | 18 +- reference/ds/ds/deque/reverse.xml | 8 +- reference/ds/ds/deque/reversed.xml | 8 +- reference/ds/ds/deque/rotate.xml | 12 +- reference/ds/ds/deque/set.xml | 22 +- reference/ds/ds/deque/shift.xml | 14 +- reference/ds/ds/deque/slice.xml | 20 +- reference/ds/ds/deque/sort.xml | 8 +- reference/ds/ds/deque/sorted.xml | 8 +- reference/ds/ds/deque/sum.xml | 12 +- reference/ds/ds/deque/toarray.xml | 12 +- reference/ds/ds/deque/unshift.xml | 12 +- reference/ds/ds/hashable/equals.xml | 24 +- reference/ds/ds/hashable/hash.xml | 24 +- reference/ds/ds/map/allocate.xml | 20 +- reference/ds/ds/map/apply.xml | 16 +- reference/ds/ds/map/capacity.xml | 8 +- reference/ds/ds/map/clear.xml | 8 +- reference/ds/ds/map/construct.xml | 8 +- reference/ds/ds/map/copy.xml | 8 +- reference/ds/ds/map/count.xml | 4 +- reference/ds/ds/map/diff.xml | 16 +- reference/ds/ds/map/filter.xml | 16 +- reference/ds/ds/map/first.xml | 14 +- reference/ds/ds/map/get.xml | 38 +- reference/ds/ds/map/haskey.xml | 8 +- reference/ds/ds/map/hasvalue.xml | 8 +- reference/ds/ds/map/intersect.xml | 20 +- reference/ds/ds/map/isempty.xml | 8 +- reference/ds/ds/map/jsonserialize.xml | 8 +- reference/ds/ds/map/keys.xml | 8 +- reference/ds/ds/map/last.xml | 14 +- reference/ds/ds/map/map.xml | 20 +- reference/ds/ds/map/merge.xml | 20 +- reference/ds/ds/map/pairs.xml | 8 +- reference/ds/ds/map/put.xml | 32 +- reference/ds/ds/map/putAll.xml | 16 +- reference/ds/ds/map/reduce.xml | 24 +- reference/ds/ds/map/remove.xml | 38 +- reference/ds/ds/map/reverse.xml | 8 +- reference/ds/ds/map/reversed.xml | 8 +- reference/ds/ds/map/skip.xml | 18 +- reference/ds/ds/map/slice.xml | 20 +- reference/ds/ds/map/sort.xml | 8 +- reference/ds/ds/map/sorted.xml | 8 +- reference/ds/ds/map/sum.xml | 12 +- reference/ds/ds/map/toarray.xml | 16 +- reference/ds/ds/map/union.xml | 20 +- reference/ds/ds/map/values.xml | 8 +- reference/ds/ds/map/xor.xml | 16 +- reference/ds/ds/pair/clear.xml | 8 +- reference/ds/ds/pair/construct.xml | 12 +- reference/ds/ds/pair/copy.xml | 8 +- reference/ds/ds/pair/isempty.xml | 8 +- reference/ds/ds/pair/jsonserialize.xml | 8 +- reference/ds/ds/pair/toarray.xml | 12 +- reference/ds/ds/priorityqueue/allocate.xml | 16 +- reference/ds/ds/priorityqueue/capacity.xml | 8 +- reference/ds/ds/priorityqueue/clear.xml | 8 +- reference/ds/ds/priorityqueue/construct.xml | 4 +- reference/ds/ds/priorityqueue/copy.xml | 8 +- reference/ds/ds/priorityqueue/count.xml | 4 +- reference/ds/ds/priorityqueue/isempty.xml | 8 +- .../ds/ds/priorityqueue/jsonserialize.xml | 8 +- reference/ds/ds/priorityqueue/peek.xml | 14 +- reference/ds/ds/priorityqueue/pop.xml | 18 +- reference/ds/ds/priorityqueue/push.xml | 16 +- reference/ds/ds/priorityqueue/toarray.xml | 16 +- reference/ds/ds/queue/allocate.xml | 20 +- reference/ds/ds/queue/capacity.xml | 8 +- reference/ds/ds/queue/clear.xml | 8 +- reference/ds/ds/queue/construct.xml | 8 +- reference/ds/ds/queue/copy.xml | 8 +- reference/ds/ds/queue/count.xml | 4 +- reference/ds/ds/queue/isempty.xml | 8 +- reference/ds/ds/queue/jsonserialize.xml | 8 +- reference/ds/ds/queue/peek.xml | 14 +- reference/ds/ds/queue/pop.xml | 14 +- reference/ds/ds/queue/push.xml | 12 +- reference/ds/ds/queue/toarray.xml | 16 +- reference/ds/ds/sequence/insert.xml | 4 +- reference/ds/ds/sequence/rotate.xml | 4 +- reference/ds/ds/set/add.xml | 20 +- reference/ds/ds/set/allocate.xml | 20 +- reference/ds/ds/set/capacity.xml | 8 +- reference/ds/ds/set/clear.xml | 8 +- reference/ds/ds/set/construct.xml | 8 +- reference/ds/ds/set/contains.xml | 20 +- reference/ds/ds/set/copy.xml | 8 +- reference/ds/ds/set/count.xml | 4 +- reference/ds/ds/set/diff.xml | 16 +- reference/ds/ds/set/filter.xml | 16 +- reference/ds/ds/set/first.xml | 14 +- reference/ds/ds/set/get.xml | 18 +- reference/ds/ds/set/intersect.xml | 16 +- reference/ds/ds/set/isempty.xml | 8 +- reference/ds/ds/set/join.xml | 12 +- reference/ds/ds/set/jsonserialize.xml | 8 +- reference/ds/ds/set/last.xml | 14 +- reference/ds/ds/set/map.xml | 8 +- reference/ds/ds/set/merge.xml | 16 +- reference/ds/ds/set/reduce.xml | 20 +- reference/ds/ds/set/remove.xml | 12 +- reference/ds/ds/set/reverse.xml | 8 +- reference/ds/ds/set/reversed.xml | 8 +- reference/ds/ds/set/slice.xml | 20 +- reference/ds/ds/set/sort.xml | 8 +- reference/ds/ds/set/sorted.xml | 8 +- reference/ds/ds/set/sum.xml | 12 +- reference/ds/ds/set/toarray.xml | 12 +- reference/ds/ds/set/union.xml | 16 +- reference/ds/ds/set/xor.xml | 16 +- reference/ds/ds/stack/allocate.xml | 12 +- reference/ds/ds/stack/capacity.xml | 8 +- reference/ds/ds/stack/clear.xml | 8 +- reference/ds/ds/stack/construct.xml | 8 +- reference/ds/ds/stack/copy.xml | 8 +- reference/ds/ds/stack/count.xml | 4 +- reference/ds/ds/stack/isempty.xml | 8 +- reference/ds/ds/stack/jsonserialize.xml | 8 +- reference/ds/ds/stack/peek.xml | 14 +- reference/ds/ds/stack/pop.xml | 14 +- reference/ds/ds/stack/push.xml | 12 +- reference/ds/ds/stack/toarray.xml | 12 +- reference/ds/ds/vector/allocate.xml | 12 +- reference/ds/ds/vector/apply.xml | 16 +- reference/ds/ds/vector/capacity.xml | 8 +- reference/ds/ds/vector/clear.xml | 8 +- reference/ds/ds/vector/construct.xml | 8 +- reference/ds/ds/vector/contains.xml | 12 +- reference/ds/ds/vector/copy.xml | 8 +- reference/ds/ds/vector/count.xml | 4 +- reference/ds/ds/vector/filter.xml | 16 +- reference/ds/ds/vector/find.xml | 16 +- reference/ds/ds/vector/first.xml | 14 +- reference/ds/ds/vector/get.xml | 18 +- reference/ds/ds/vector/insert.xml | 26 +- reference/ds/ds/vector/isempty.xml | 8 +- reference/ds/ds/vector/join.xml | 12 +- reference/ds/ds/vector/jsonserialize.xml | 8 +- reference/ds/ds/vector/last.xml | 14 +- reference/ds/ds/vector/map.xml | 20 +- reference/ds/ds/vector/merge.xml | 16 +- reference/ds/ds/vector/pop.xml | 14 +- reference/ds/ds/vector/push.xml | 12 +- reference/ds/ds/vector/reduce.xml | 20 +- reference/ds/ds/vector/remove.xml | 18 +- reference/ds/ds/vector/reverse.xml | 8 +- reference/ds/ds/vector/reversed.xml | 8 +- reference/ds/ds/vector/rotate.xml | 12 +- reference/ds/ds/vector/set.xml | 22 +- reference/ds/ds/vector/shift.xml | 14 +- reference/ds/ds/vector/slice.xml | 20 +- reference/ds/ds/vector/sort.xml | 8 +- reference/ds/ds/vector/sorted.xml | 8 +- reference/ds/ds/vector/sum.xml | 12 +- reference/ds/ds/vector/toarray.xml | 12 +- reference/ds/ds/vector/unshift.xml | 12 +- reference/ds/setup.xml | 8 +- reference/eio/configure.xml | 2 +- reference/eio/examples.xml | 2 +- reference/eio/functions/eio-busy.xml | 2 +- reference/eio/functions/eio-cancel.xml | 2 +- reference/eio/functions/eio-chmod.xml | 2 +- reference/eio/functions/eio-chown.xml | 2 +- reference/eio/functions/eio-close.xml | 2 +- reference/eio/functions/eio-custom.xml | 2 +- reference/eio/functions/eio-dup2.xml | 2 +- reference/eio/functions/eio-event-loop.xml | 2 +- reference/eio/functions/eio-fallocate.xml | 2 +- reference/eio/functions/eio-fchmod.xml | 2 +- reference/eio/functions/eio-fchown.xml | 2 +- reference/eio/functions/eio-fdatasync.xml | 2 +- reference/eio/functions/eio-fstat.xml | 2 +- reference/eio/functions/eio-fstatvfs.xml | 2 +- reference/eio/functions/eio-fsync.xml | 2 +- reference/eio/functions/eio-ftruncate.xml | 2 +- reference/eio/functions/eio-futime.xml | 2 +- .../eio/functions/eio-get-event-stream.xml | 2 +- .../eio/functions/eio-get-last-error.xml | 2 +- reference/eio/functions/eio-grp-add.xml | 2 +- reference/eio/functions/eio-grp-cancel.xml | 2 +- reference/eio/functions/eio-grp-limit.xml | 2 +- reference/eio/functions/eio-grp.xml | 2 +- reference/eio/functions/eio-init.xml | 2 +- reference/eio/functions/eio-link.xml | 2 +- reference/eio/functions/eio-lstat.xml | 2 +- reference/eio/functions/eio-mkdir.xml | 2 +- reference/eio/functions/eio-mknod.xml | 2 +- reference/eio/functions/eio-nop.xml | 2 +- reference/eio/functions/eio-npending.xml | 2 +- reference/eio/functions/eio-nready.xml | 2 +- reference/eio/functions/eio-nreqs.xml | 2 +- reference/eio/functions/eio-nthreads.xml | 2 +- reference/eio/functions/eio-open.xml | 2 +- reference/eio/functions/eio-poll.xml | 2 +- reference/eio/functions/eio-read.xml | 2 +- reference/eio/functions/eio-readahead.xml | 2 +- reference/eio/functions/eio-readlink.xml | 2 +- reference/eio/functions/eio-realpath.xml | 2 +- reference/eio/functions/eio-rename.xml | 2 +- reference/eio/functions/eio-rmdir.xml | 2 +- reference/eio/functions/eio-seek.xml | 2 +- reference/eio/functions/eio-sendfile.xml | 2 +- reference/eio/functions/eio-set-max-idle.xml | 2 +- .../eio/functions/eio-set-max-parallel.xml | 2 +- .../eio/functions/eio-set-max-poll-reqs.xml | 2 +- .../eio/functions/eio-set-max-poll-time.xml | 2 +- .../eio/functions/eio-set-min-parallel.xml | 2 +- reference/eio/functions/eio-stat.xml | 2 +- reference/eio/functions/eio-statvfs.xml | 2 +- reference/eio/functions/eio-symlink.xml | 2 +- .../eio/functions/eio-sync-file-range.xml | 2 +- reference/eio/functions/eio-sync.xml | 2 +- reference/eio/functions/eio-syncfs.xml | 2 +- reference/eio/functions/eio-truncate.xml | 2 +- reference/eio/functions/eio-unlink.xml | 2 +- reference/eio/functions/eio-utime.xml | 2 +- reference/eio/functions/eio-write.xml | 2 +- reference/ev/book.xml | 2 +- reference/ev/configure.xml | 2 +- reference/ev/ev/backend.xml | 2 +- reference/ev/ev/depth.xml | 2 +- reference/ev/ev/embeddablebackends.xml | 2 +- reference/ev/ev/feedsignal.xml | 2 +- reference/ev/ev/feedsignalevent.xml | 2 +- reference/ev/ev/iteration.xml | 2 +- reference/ev/ev/now.xml | 2 +- reference/ev/ev/nowupdate.xml | 2 +- reference/ev/ev/recommendedbackends.xml | 2 +- reference/ev/ev/resume.xml | 2 +- reference/ev/ev/run.xml | 2 +- reference/ev/ev/sleep.xml | 2 +- reference/ev/ev/stop.xml | 2 +- reference/ev/ev/supportedbackends.xml | 2 +- reference/ev/ev/suspend.xml | 2 +- reference/ev/ev/time.xml | 2 +- reference/ev/ev/verify.xml | 2 +- reference/ev/evcheck.xml | 2 +- reference/ev/evcheck/construct.xml | 2 +- reference/ev/evcheck/createstopped.xml | 2 +- reference/ev/evchild.xml | 2 +- reference/ev/evchild/construct.xml | 2 +- reference/ev/evchild/createstopped.xml | 2 +- reference/ev/evchild/set.xml | 2 +- reference/ev/evembed.xml | 2 +- reference/ev/evembed/construct.xml | 2 +- reference/ev/evembed/createstopped.xml | 2 +- reference/ev/evembed/set.xml | 2 +- reference/ev/evembed/sweep.xml | 2 +- reference/ev/evfork.xml | 2 +- reference/ev/evfork/construct.xml | 2 +- reference/ev/evfork/createstopped.xml | 2 +- reference/ev/evidle.xml | 2 +- reference/ev/evidle/construct.xml | 2 +- reference/ev/evidle/createstopped.xml | 2 +- reference/ev/evio/construct.xml | 2 +- reference/ev/evio/createstopped.xml | 2 +- reference/ev/evio/set.xml | 2 +- reference/ev/evloop.xml | 2 +- reference/ev/evloop/backend.xml | 2 +- reference/ev/evloop/check.xml | 2 +- reference/ev/evloop/child.xml | 2 +- reference/ev/evloop/construct.xml | 2 +- reference/ev/evloop/defaultloop.xml | 2 +- reference/ev/evloop/embed.xml | 2 +- reference/ev/evloop/fork.xml | 2 +- reference/ev/evloop/idle.xml | 2 +- reference/ev/evloop/invokepending.xml | 2 +- reference/ev/evloop/io.xml | 2 +- reference/ev/evloop/loopfork.xml | 2 +- reference/ev/evloop/now.xml | 2 +- reference/ev/evloop/nowupdate.xml | 2 +- reference/ev/evloop/periodic.xml | 2 +- reference/ev/evloop/prepare.xml | 2 +- reference/ev/evloop/resume.xml | 2 +- reference/ev/evloop/run.xml | 2 +- reference/ev/evloop/signal.xml | 2 +- reference/ev/evloop/stat.xml | 2 +- reference/ev/evloop/stop.xml | 2 +- reference/ev/evloop/suspend.xml | 2 +- reference/ev/evloop/timer.xml | 2 +- reference/ev/evloop/verify.xml | 2 +- reference/ev/evperiodic.xml | 2 +- reference/ev/evperiodic/again.xml | 2 +- reference/ev/evperiodic/at.xml | 2 +- reference/ev/evperiodic/construct.xml | 2 +- reference/ev/evperiodic/createstopped.xml | 2 +- reference/ev/evperiodic/set.xml | 2 +- reference/ev/evprepare/construct.xml | 2 +- reference/ev/evprepare/createstopped.xml | 2 +- reference/ev/evsignal.xml | 2 +- reference/ev/evsignal/construct.xml | 2 +- reference/ev/evsignal/createstopped.xml | 2 +- reference/ev/evsignal/set.xml | 2 +- reference/ev/evstat.xml | 2 +- reference/ev/evstat/attr.xml | 2 +- reference/ev/evstat/construct.xml | 2 +- reference/ev/evstat/createstopped.xml | 2 +- reference/ev/evstat/prev.xml | 2 +- reference/ev/evstat/set.xml | 2 +- reference/ev/evstat/stat.xml | 2 +- reference/ev/evtimer.xml | 2 +- reference/ev/evtimer/again.xml | 2 +- reference/ev/evtimer/construct.xml | 2 +- reference/ev/evtimer/createstopped.xml | 2 +- reference/ev/evtimer/set.xml | 2 +- reference/ev/evwatcher.xml | 2 +- reference/ev/evwatcher/clear.xml | 2 +- reference/ev/evwatcher/construct.xml | 2 +- reference/ev/evwatcher/feed.xml | 2 +- reference/ev/evwatcher/getloop.xml | 2 +- reference/ev/evwatcher/invoke.xml | 2 +- reference/ev/evwatcher/keepalive.xml | 2 +- reference/ev/evwatcher/setcallback.xml | 2 +- reference/ev/evwatcher/start.xml | 2 +- reference/ev/evwatcher/stop.xml | 2 +- reference/ev/periodic-modes.xml | 2 +- reference/ev/setup.xml | 2 +- reference/ev/watcher-callbacks.xml | 2 +- reference/ev/watchers.xml | 2 +- reference/event/book.xml | 16 +- reference/event/configure.xml | 4 +- reference/event/event.callbacks.xml | 42 +- .../event.constructing.signal.events.xml | 14 +- reference/event/event.flags.xml | 20 +- reference/event/event.persistence.xml | 24 +- reference/event/event.xml | 36 +- reference/event/event/add.xml | 16 +- reference/event/event/addsignal.xml | 4 +- reference/event/event/addtimer.xml | 4 +- reference/event/event/construct.xml | 24 +- reference/event/event/del.xml | 8 +- reference/event/event/delsignal.xml | 4 +- reference/event/event/deltimer.xml | 4 +- reference/event/event/free.xml | 12 +- reference/event/event/getsupportedmethods.xml | 4 +- reference/event/event/pending.xml | 12 +- reference/event/event/set.xml | 28 +- reference/event/event/setpriority.xml | 12 +- reference/event/event/settimer.xml | 20 +- reference/event/event/signal.xml | 24 +- reference/event/event/timer.xml | 20 +- reference/event/eventbase.xml | 48 +-- reference/event/eventbase/construct.xml | 14 +- reference/event/eventbase/dispatch.xml | 10 +- reference/event/eventbase/exit.xml | 12 +- reference/event/eventbase/free.xml | 16 +- reference/event/eventbase/getfeatures.xml | 8 +- reference/event/eventbase/getmethod.xml | 6 +- .../event/eventbase/gettimeofdaycached.xml | 8 +- reference/event/eventbase/gotexit.xml | 8 +- reference/event/eventbase/gotstop.xml | 8 +- reference/event/eventbase/loop.xml | 14 +- reference/event/eventbase/priorityinit.xml | 12 +- reference/event/eventbase/reinit.xml | 8 +- reference/event/eventbase/stop.xml | 8 +- reference/event/eventbuffer.xml | 40 +- reference/event/eventbuffer/add.xml | 12 +- reference/event/eventbuffer/addbuffer.xml | 12 +- reference/event/eventbuffer/appendfrom.xml | 14 +- reference/event/eventbuffer/construct.xml | 4 +- reference/event/eventbuffer/copyout.xml | 16 +- reference/event/eventbuffer/drain.xml | 12 +- reference/event/eventbuffer/enablelocking.xml | 8 +- reference/event/eventbuffer/expand.xml | 12 +- reference/event/eventbuffer/freeze.xml | 12 +- reference/event/eventbuffer/lock.xml | 8 +- reference/event/eventbuffer/prepend.xml | 12 +- reference/event/eventbuffer/prependbuffer.xml | 12 +- reference/event/eventbuffer/pullup.xml | 16 +- reference/event/eventbuffer/read.xml | 10 +- reference/event/eventbuffer/readfrom.xml | 12 +- reference/event/eventbuffer/readline.xml | 12 +- reference/event/eventbuffer/search.xml | 24 +- reference/event/eventbuffer/searcheol.xml | 20 +- reference/event/eventbuffer/unfreeze.xml | 12 +- reference/event/eventbuffer/unlock.xml | 8 +- reference/event/eventbuffer/write.xml | 12 +- .../eventbufferevent.about.callbacks.xml | 34 +- reference/event/eventbufferevent.xml | 94 ++-- reference/event/eventbufferevent/close.xml | 12 +- reference/event/eventbufferevent/connect.xml | 12 +- .../event/eventbufferevent/connecthost.xml | 24 +- .../event/eventbufferevent/construct.xml | 32 +- .../event/eventbufferevent/createpair.xml | 18 +- reference/event/eventbufferevent/disable.xml | 10 +- reference/event/eventbufferevent/enable.xml | 12 +- reference/event/eventbufferevent/free.xml | 12 +- .../eventbufferevent/getdnserrorstring.xml | 8 +- .../event/eventbufferevent/getenabled.xml | 8 +- reference/event/eventbufferevent/getinput.xml | 12 +- .../event/eventbufferevent/getoutput.xml | 12 +- reference/event/eventbufferevent/read.xml | 12 +- .../event/eventbufferevent/readbuffer.xml | 12 +- .../event/eventbufferevent/setcallbacks.xml | 24 +- .../event/eventbufferevent/setpriority.xml | 16 +- .../event/eventbufferevent/settimeouts.xml | 16 +- .../event/eventbufferevent/setwatermark.xml | 20 +- reference/event/eventbufferevent/sslerror.xml | 12 +- .../event/eventbufferevent/sslfilter.xml | 34 +- .../eventbufferevent/sslgetcipherinfo.xml | 12 +- .../eventbufferevent/sslgetciphername.xml | 12 +- .../eventbufferevent/sslgetcipherversion.xml | 12 +- .../event/eventbufferevent/sslgetprotocol.xml | 12 +- .../event/eventbufferevent/sslrenegotiate.xml | 12 +- .../event/eventbufferevent/sslsocket.xml | 28 +- reference/event/eventbufferevent/write.xml | 12 +- .../event/eventbufferevent/writebuffer.xml | 12 +- reference/event/eventconfig.xml | 16 +- reference/event/eventconfig/avoidmethod.xml | 12 +- reference/event/eventconfig/construct.xml | 4 +- .../event/eventconfig/requirefeatures.xml | 12 +- reference/event/eventconfig/setflags.xml | 16 +- .../eventconfig/setmaxdispatchinterval.xml | 24 +- reference/event/eventdnsbase.xml | 30 +- .../event/eventdnsbase/addnameserverip.xml | 12 +- reference/event/eventdnsbase/addsearch.xml | 12 +- reference/event/eventdnsbase/clearsearch.xml | 8 +- reference/event/eventdnsbase/construct.xml | 18 +- .../event/eventdnsbase/countnameservers.xml | 8 +- reference/event/eventdnsbase/loadhosts.xml | 12 +- .../event/eventdnsbase/parseresolvconf.xml | 20 +- reference/event/eventdnsbase/setoption.xml | 16 +- .../event/eventdnsbase/setsearchndots.xml | 12 +- reference/event/eventexception.xml | 6 +- reference/event/eventhttp.xml | 4 +- reference/event/eventhttp/accept.xml | 22 +- reference/event/eventhttp/addserveralias.xml | 12 +- reference/event/eventhttp/bind.xml | 20 +- reference/event/eventhttp/construct.xml | 18 +- .../event/eventhttp/removeserveralias.xml | 12 +- .../event/eventhttp/setallowedmethods.xml | 16 +- reference/event/eventhttp/setcallback.xml | 30 +- .../event/eventhttp/setdefaultcallback.xml | 26 +- reference/event/eventhttp/setmaxbodysize.xml | 12 +- .../event/eventhttp/setmaxheaderssize.xml | 12 +- reference/event/eventhttp/settimeout.xml | 12 +- reference/event/eventhttpconnection.xml | 4 +- .../event/eventhttpconnection/construct.xml | 30 +- .../event/eventhttpconnection/getbase.xml | 8 +- .../event/eventhttpconnection/getpeer.xml | 16 +- .../event/eventhttpconnection/makerequest.xml | 20 +- .../eventhttpconnection/setclosecallback.xml | 12 +- .../eventhttpconnection/setlocaladdress.xml | 12 +- .../eventhttpconnection/setlocalport.xml | 10 +- .../eventhttpconnection/setmaxbodysize.xml | 12 +- .../eventhttpconnection/setmaxheaderssize.xml | 12 +- .../event/eventhttpconnection/setretries.xml | 12 +- .../event/eventhttpconnection/settimeout.xml | 12 +- reference/event/eventhttprequest.xml | 48 +-- .../event/eventhttprequest/addheader.xml | 20 +- reference/event/eventhttprequest/cancel.xml | 16 +- .../event/eventhttprequest/clearheaders.xml | 8 +- .../eventhttprequest/closeconnection.xml | 8 +- .../event/eventhttprequest/construct.xml | 12 +- .../event/eventhttprequest/findheader.xml | 12 +- reference/event/eventhttprequest/free.xml | 8 +- .../event/eventhttprequest/getbufferevent.xml | 12 +- .../event/eventhttprequest/getcommand.xml | 8 +- .../event/eventhttprequest/getconnection.xml | 16 +- reference/event/eventhttprequest/gethost.xml | 8 +- .../event/eventhttprequest/getinputbuffer.xml | 8 +- .../eventhttprequest/getinputheaders.xml | 8 +- .../eventhttprequest/getoutputbuffer.xml | 8 +- .../eventhttprequest/getoutputheaders.xml | 6 +- .../eventhttprequest/getresponsecode.xml | 8 +- reference/event/eventhttprequest/geturi.xml | 8 +- .../event/eventhttprequest/removeheader.xml | 16 +- .../event/eventhttprequest/senderror.xml | 12 +- .../event/eventhttprequest/sendreply.xml | 20 +- .../event/eventhttprequest/sendreplychunk.xml | 12 +- .../event/eventhttprequest/sendreplyend.xml | 8 +- .../event/eventhttprequest/sendreplystart.xml | 24 +- reference/event/eventlistener.xml | 28 +- reference/event/eventlistener/construct.xml | 30 +- reference/event/eventlistener/disable.xml | 8 +- reference/event/eventlistener/enable.xml | 8 +- reference/event/eventlistener/getbase.xml | 8 +- .../event/eventlistener/getsocketname.xml | 12 +- reference/event/eventlistener/setcallback.xml | 38 +- .../event/eventlistener/seterrorcallback.xml | 18 +- reference/event/eventsslcontext.xml | 80 ++-- reference/event/eventsslcontext/construct.xml | 12 +- reference/event/eventutil.xml | 96 ++--- reference/event/eventutil/construct.xml | 4 +- .../event/eventutil/getlastsocketerrno.xml | 12 +- .../event/eventutil/getlastsocketerror.xml | 12 +- reference/event/eventutil/getsocketfd.xml | 12 +- reference/event/eventutil/getsocketname.xml | 16 +- reference/event/eventutil/setsocketoption.xml | 24 +- reference/event/eventutil/sslrandpoll.xml | 8 +- reference/event/setup.xml | 16 +- reference/expect/book.xml | 2 +- reference/expect/configure.xml | 2 +- reference/expect/examples.xml | 2 +- reference/expect/functions/expect-expectl.xml | 2 +- reference/expect/functions/expect-popen.xml | 2 +- reference/expect/ini.xml | 2 +- reference/expect/setup.xml | 2 +- reference/fann/book.xml | 4 +- reference/fann/configure.xml | 4 +- reference/fann/fannconnection.xml | 10 +- reference/fann/fannconnection/construct.xml | 16 +- reference/fann/fannconnection/gettoneuron.xml | 4 +- reference/fann/fannconnection/getweight.xml | 8 +- reference/fann/fannconnection/setweight.xml | 12 +- .../functions/fann-cascadetrain-on-data.xml | 20 +- .../functions/fann-cascadetrain-on-file.xml | 22 +- .../functions/fann-clear-scaling-params.xml | 4 +- reference/fann/functions/fann-copy.xml | 8 +- .../fann/functions/fann-create-from-file.xml | 8 +- .../functions/fann-create-shortcut-array.xml | 12 +- .../fann/functions/fann-create-shortcut.xml | 28 +- .../functions/fann-create-sparse-array.xml | 20 +- .../fann/functions/fann-create-sparse.xml | 28 +- .../functions/fann-create-standard-array.xml | 24 +- .../fann/functions/fann-create-standard.xml | 32 +- .../fann-create-train-from-callback.xml | 20 +- .../fann/functions/fann-create-train.xml | 16 +- .../fann/functions/fann-descale-input.xml | 8 +- .../fann/functions/fann-descale-output.xml | 8 +- .../fann/functions/fann-descale-train.xml | 4 +- .../fann/functions/fann-destroy-train.xml | 4 +- reference/fann/functions/fann-destroy.xml | 4 +- .../functions/fann-duplicate-train-data.xml | 4 +- .../fann-get-activation-function.xml | 20 +- .../fann-get-activation-steepness.xml | 32 +- .../fann/functions/fann-get-bias-array.xml | 8 +- .../functions/fann-get-bit-fail-limit.xml | 20 +- .../fann/functions/fann-get-bit-fail.xml | 12 +- ...get-cascade-activation-functions-count.xml | 12 +- .../fann-get-cascade-activation-functions.xml | 16 +- ...t-cascade-activation-steepnesses-count.xml | 12 +- ...ann-get-cascade-activation-steepnesses.xml | 16 +- ...-get-cascade-candidate-change-fraction.xml | 16 +- .../fann-get-cascade-candidate-limit.xml | 16 +- ...et-cascade-candidate-stagnation-epochs.xml | 16 +- .../fann-get-cascade-max-cand-epochs.xml | 12 +- .../fann-get-cascade-max-out-epochs.xml | 12 +- .../fann-get-cascade-min-cand-epochs.xml | 12 +- .../fann-get-cascade-min-out-epochs.xml | 12 +- .../fann-get-cascade-num-candidate-groups.xml | 20 +- .../fann-get-cascade-num-candidates.xml | 16 +- ...ann-get-cascade-output-change-fraction.xml | 16 +- ...n-get-cascade-output-stagnation-epochs.xml | 16 +- .../fann-get-cascade-weight-multiplier.xml | 12 +- .../functions/fann-get-connection-array.xml | 8 +- .../functions/fann-get-connection-rate.xml | 8 +- reference/fann/functions/fann-get-errno.xml | 8 +- reference/fann/functions/fann-get-errstr.xml | 8 +- .../fann/functions/fann-get-layer-array.xml | 8 +- .../functions/fann-get-learning-momentum.xml | 12 +- .../fann/functions/fann-get-learning-rate.xml | 12 +- reference/fann/functions/fann-get-mse.xml | 12 +- .../fann/functions/fann-get-network-type.xml | 8 +- .../fann/functions/fann-get-num-input.xml | 8 +- .../fann/functions/fann-get-num-layers.xml | 4 +- .../fann/functions/fann-get-num-output.xml | 8 +- .../functions/fann-get-quickprop-decay.xml | 12 +- .../fann/functions/fann-get-quickprop-mu.xml | 12 +- .../fann-get-rprop-decrease-factor.xml | 12 +- .../functions/fann-get-rprop-delta-max.xml | 12 +- .../functions/fann-get-rprop-delta-min.xml | 12 +- .../functions/fann-get-rprop-delta-zero.xml | 12 +- .../fann-get-rprop-increase-factor.xml | 12 +- .../fann-get-sarprop-step-error-shift.xml | 12 +- ...et-sarprop-step-error-threshold-factor.xml | 12 +- .../fann-get-sarprop-temperature.xml | 12 +- .../fann-get-sarprop-weight-decay-shift.xml | 12 +- .../functions/fann-get-total-connections.xml | 8 +- .../fann/functions/fann-get-total-neurons.xml | 8 +- .../fann-get-train-error-function.xml | 16 +- .../fann-get-train-stop-function.xml | 16 +- .../functions/fann-get-training-algorithm.xml | 12 +- .../fann/functions/fann-init-weights.xml | 12 +- .../fann/functions/fann-length-train-data.xml | 8 +- .../fann/functions/fann-merge-train-data.xml | 8 +- .../functions/fann-num-input-train-data.xml | 8 +- .../functions/fann-num-output-train-data.xml | 8 +- reference/fann/functions/fann-print-error.xml | 4 +- .../fann/functions/fann-randomize-weights.xml | 16 +- .../functions/fann-read-train-from-file.xml | 10 +- reference/fann/functions/fann-reset-errno.xml | 4 +- .../fann/functions/fann-reset-errstr.xml | 4 +- reference/fann/functions/fann-reset-mse.xml | 8 +- reference/fann/functions/fann-run.xml | 12 +- reference/fann/functions/fann-save-train.xml | 8 +- reference/fann/functions/fann-save.xml | 16 +- .../functions/fann-scale-input-train-data.xml | 12 +- reference/fann/functions/fann-scale-input.xml | 8 +- .../fann-scale-output-train-data.xml | 12 +- .../fann/functions/fann-scale-output.xml | 8 +- .../fann/functions/fann-scale-train-data.xml | 12 +- reference/fann/functions/fann-scale-train.xml | 4 +- .../fann-set-activation-function-hidden.xml | 8 +- .../fann-set-activation-function-layer.xml | 16 +- .../fann-set-activation-function-output.xml | 8 +- .../fann-set-activation-function.xml | 32 +- .../fann-set-activation-steepness-hidden.xml | 8 +- .../fann-set-activation-steepness-layer.xml | 16 +- .../fann-set-activation-steepness-output.xml | 8 +- .../fann-set-activation-steepness.xml | 32 +- .../functions/fann-set-bit-fail-limit.xml | 8 +- .../fann/functions/fann-set-callback.xml | 8 +- .../fann-set-cascade-activation-functions.xml | 12 +- ...ann-set-cascade-activation-steepnesses.xml | 12 +- ...-set-cascade-candidate-change-fraction.xml | 8 +- .../fann-set-cascade-candidate-limit.xml | 8 +- ...et-cascade-candidate-stagnation-epochs.xml | 8 +- .../fann-set-cascade-max-cand-epochs.xml | 8 +- .../fann-set-cascade-max-out-epochs.xml | 8 +- .../fann-set-cascade-min-cand-epochs.xml | 8 +- .../fann-set-cascade-min-out-epochs.xml | 8 +- .../fann-set-cascade-num-candidate-groups.xml | 8 +- ...ann-set-cascade-output-change-fraction.xml | 8 +- ...n-set-cascade-output-stagnation-epochs.xml | 8 +- .../fann-set-cascade-weight-multiplier.xml | 8 +- .../fann/functions/fann-set-error-log.xml | 8 +- .../fann-set-input-scaling-params.xml | 12 +- .../functions/fann-set-learning-momentum.xml | 12 +- .../fann/functions/fann-set-learning-rate.xml | 12 +- .../fann-set-output-scaling-params.xml | 12 +- .../functions/fann-set-quickprop-decay.xml | 8 +- .../fann/functions/fann-set-quickprop-mu.xml | 8 +- .../fann-set-rprop-decrease-factor.xml | 8 +- .../functions/fann-set-rprop-delta-max.xml | 8 +- .../functions/fann-set-rprop-delta-min.xml | 8 +- .../functions/fann-set-rprop-delta-zero.xml | 8 +- .../fann-set-rprop-increase-factor.xml | 8 +- .../fann-set-sarprop-step-error-shift.xml | 8 +- ...et-sarprop-step-error-threshold-factor.xml | 8 +- .../fann-set-sarprop-temperature.xml | 8 +- .../fann-set-sarprop-weight-decay-shift.xml | 8 +- .../functions/fann-set-scaling-params.xml | 20 +- .../fann-set-train-error-function.xml | 12 +- .../fann-set-train-stop-function.xml | 12 +- .../functions/fann-set-training-algorithm.xml | 12 +- .../fann/functions/fann-set-weight-array.xml | 12 +- reference/fann/functions/fann-set-weight.xml | 16 +- .../functions/fann-shuffle-train-data.xml | 4 +- .../fann/functions/fann-subset-train-data.xml | 16 +- reference/fann/functions/fann-test-data.xml | 12 +- reference/fann/functions/fann-test.xml | 14 +- reference/fann/functions/fann-train-epoch.xml | 12 +- .../fann/functions/fann-train-on-data.xml | 20 +- .../fann/functions/fann-train-on-file.xml | 24 +- reference/fann/functions/fann-train.xml | 12 +- reference/fann/setup.xml | 24 +- reference/fdf/book.xml | 8 +- reference/fdf/configure.xml | 2 +- reference/fdf/constants.xml | 200 ++++----- .../fdf/functions/fdf-add-doc-javascript.xml | 2 +- reference/fdf/functions/fdf-add-template.xml | 2 +- reference/fdf/functions/fdf-close.xml | 2 +- reference/fdf/functions/fdf-create.xml | 2 +- reference/fdf/functions/fdf-enum-values.xml | 2 +- reference/fdf/functions/fdf-errno.xml | 2 +- reference/fdf/functions/fdf-error.xml | 2 +- reference/fdf/functions/fdf-get-ap.xml | 2 +- .../fdf/functions/fdf-get-attachment.xml | 2 +- reference/fdf/functions/fdf-get-encoding.xml | 2 +- reference/fdf/functions/fdf-get-file.xml | 2 +- reference/fdf/functions/fdf-get-flags.xml | 2 +- reference/fdf/functions/fdf-get-opt.xml | 2 +- reference/fdf/functions/fdf-get-status.xml | 2 +- reference/fdf/functions/fdf-get-value.xml | 2 +- reference/fdf/functions/fdf-get-version.xml | 2 +- reference/fdf/functions/fdf-header.xml | 2 +- .../fdf/functions/fdf-next-field-name.xml | 2 +- reference/fdf/functions/fdf-open-string.xml | 2 +- reference/fdf/functions/fdf-open.xml | 2 +- reference/fdf/functions/fdf-remove-item.xml | 2 +- reference/fdf/functions/fdf-save-string.xml | 2 +- reference/fdf/functions/fdf-save.xml | 2 +- reference/fdf/functions/fdf-set-ap.xml | 2 +- reference/fdf/functions/fdf-set-encoding.xml | 2 +- reference/fdf/functions/fdf-set-file.xml | 2 +- reference/fdf/functions/fdf-set-flags.xml | 2 +- .../functions/fdf-set-javascript-action.xml | 2 +- .../fdf-set-on-import-javascript.xml | 2 +- reference/fdf/functions/fdf-set-opt.xml | 2 +- reference/fdf/functions/fdf-set-status.xml | 2 +- .../functions/fdf-set-submit-form-action.xml | 2 +- .../fdf/functions/fdf-set-target-frame.xml | 2 +- reference/fdf/functions/fdf-set-value.xml | 2 +- reference/fdf/functions/fdf-set-version.xml | 2 +- reference/fdf/setup.xml | 2 +- reference/gearman/book.xml | 2 +- reference/gearman/configure.xml | 2 +- reference/gearman/constants.xml | 2 +- reference/gearman/examples.xml | 2 +- reference/gearman/gearmanclient.xml | 2 +- .../gearman/gearmanclient/addoptions.xml | 2 +- reference/gearman/gearmanclient/addserver.xml | 2 +- .../gearman/gearmanclient/addservers.xml | 2 +- reference/gearman/gearmanclient/addtask.xml | 2 +- .../gearmanclient/addtaskbackground.xml | 2 +- .../gearman/gearmanclient/addtaskhigh.xml | 2 +- .../gearmanclient/addtaskhighbackground.xml | 2 +- .../gearman/gearmanclient/addtasklow.xml | 2 +- .../gearmanclient/addtasklowbackground.xml | 2 +- .../gearman/gearmanclient/addtaskstatus.xml | 2 +- .../gearman/gearmanclient/clearcallbacks.xml | 2 +- reference/gearman/gearmanclient/clone.xml | 2 +- reference/gearman/gearmanclient/construct.xml | 2 +- reference/gearman/gearmanclient/context.xml | 2 +- reference/gearman/gearmanclient/data.xml | 2 +- reference/gearman/gearmanclient/do.xml | 2 +- .../gearman/gearmanclient/dobackground.xml | 2 +- reference/gearman/gearmanclient/dohigh.xml | 2 +- .../gearmanclient/dohighbackground.xml | 2 +- .../gearman/gearmanclient/dojobhandle.xml | 2 +- reference/gearman/gearmanclient/dolow.xml | 2 +- .../gearman/gearmanclient/dolowbackground.xml | 2 +- reference/gearman/gearmanclient/donormal.xml | 2 +- reference/gearman/gearmanclient/dostatus.xml | 2 +- reference/gearman/gearmanclient/echo.xml | 2 +- reference/gearman/gearmanclient/error.xml | 2 +- reference/gearman/gearmanclient/geterrno.xml | 2 +- reference/gearman/gearmanclient/jobstatus.xml | 2 +- reference/gearman/gearmanclient/ping.xml | 2 +- .../gearman/gearmanclient/removeoptions.xml | 2 +- .../gearman/gearmanclient/returncode.xml | 2 +- reference/gearman/gearmanclient/runtasks.xml | 2 +- .../gearmanclient/setclientcallback.xml | 2 +- .../gearmanclient/setcompletecallback.xml | 2 +- .../gearman/gearmanclient/setcontext.xml | 2 +- .../gearmanclient/setcreatedcallback.xml | 2 +- reference/gearman/gearmanclient/setdata.xml | 2 +- .../gearman/gearmanclient/setdatacallback.xml | 2 +- .../gearmanclient/setexceptioncallback.xml | 2 +- .../gearman/gearmanclient/setfailcallback.xml | 2 +- .../gearman/gearmanclient/setoptions.xml | 2 +- .../gearmanclient/setstatuscallback.xml | 2 +- .../gearman/gearmanclient/settimeout.xml | 2 +- .../gearmanclient/setwarningcallback.xml | 2 +- .../gearmanclient/setworkloadcallback.xml | 2 +- reference/gearman/gearmanclient/timeout.xml | 2 +- reference/gearman/gearmanclient/wait.xml | 2 +- reference/gearman/gearmanexception.xml | 2 +- reference/gearman/gearmanjob.xml | 2 +- reference/gearman/gearmanjob/complete.xml | 2 +- reference/gearman/gearmanjob/construct.xml | 2 +- reference/gearman/gearmanjob/data.xml | 2 +- reference/gearman/gearmanjob/exception.xml | 2 +- reference/gearman/gearmanjob/fail.xml | 2 +- reference/gearman/gearmanjob/functionname.xml | 2 +- reference/gearman/gearmanjob/handle.xml | 2 +- reference/gearman/gearmanjob/returncode.xml | 2 +- reference/gearman/gearmanjob/sendcomplete.xml | 2 +- reference/gearman/gearmanjob/senddata.xml | 2 +- .../gearman/gearmanjob/sendexception.xml | 2 +- reference/gearman/gearmanjob/sendfail.xml | 2 +- reference/gearman/gearmanjob/sendstatus.xml | 2 +- reference/gearman/gearmanjob/sendwarning.xml | 2 +- reference/gearman/gearmanjob/setreturn.xml | 2 +- reference/gearman/gearmanjob/status.xml | 2 +- reference/gearman/gearmanjob/unique.xml | 2 +- reference/gearman/gearmanjob/warning.xml | 2 +- reference/gearman/gearmanjob/workload.xml | 2 +- reference/gearman/gearmanjob/workloadsize.xml | 2 +- reference/gearman/gearmantask.xml | 2 +- reference/gearman/gearmantask/construct.xml | 2 +- reference/gearman/gearmantask/data.xml | 2 +- reference/gearman/gearmantask/datasize.xml | 2 +- reference/gearman/gearmantask/function.xml | 2 +- .../gearman/gearmantask/functionname.xml | 2 +- reference/gearman/gearmantask/isknown.xml | 2 +- reference/gearman/gearmantask/isrunning.xml | 2 +- reference/gearman/gearmantask/jobhandle.xml | 2 +- reference/gearman/gearmantask/recvdata.xml | 2 +- reference/gearman/gearmantask/returncode.xml | 2 +- reference/gearman/gearmantask/senddata.xml | 2 +- .../gearman/gearmantask/sendworkload.xml | 2 +- .../gearman/gearmantask/taskdenominator.xml | 2 +- .../gearman/gearmantask/tasknumerator.xml | 2 +- reference/gearman/gearmantask/unique.xml | 2 +- reference/gearman/gearmantask/uuid.xml | 2 +- reference/gearman/gearmanworker.xml | 2 +- .../gearman/gearmanworker/addfunction.xml | 2 +- .../gearman/gearmanworker/addoptions.xml | 2 +- reference/gearman/gearmanworker/addserver.xml | 2 +- .../gearman/gearmanworker/addservers.xml | 2 +- reference/gearman/gearmanworker/clone.xml | 2 +- reference/gearman/gearmanworker/construct.xml | 2 +- reference/gearman/gearmanworker/echo.xml | 2 +- reference/gearman/gearmanworker/error.xml | 2 +- reference/gearman/gearmanworker/geterrno.xml | 2 +- reference/gearman/gearmanworker/options.xml | 2 +- reference/gearman/gearmanworker/register.xml | 2 +- .../gearman/gearmanworker/removeoptions.xml | 2 +- .../gearman/gearmanworker/returncode.xml | 2 +- reference/gearman/gearmanworker/setid.xml | 2 +- .../gearman/gearmanworker/setoptions.xml | 2 +- .../gearman/gearmanworker/settimeout.xml | 2 +- reference/gearman/gearmanworker/timeout.xml | 2 +- .../gearman/gearmanworker/unregister.xml | 2 +- .../gearman/gearmanworker/unregisterall.xml | 2 +- reference/gearman/gearmanworker/wait.xml | 2 +- reference/gearman/gearmanworker/work.xml | 2 +- reference/gearman/setup.xml | 2 +- reference/gender/book.xml | 2 +- reference/gender/configure.xml | 2 +- reference/gender/examples.xml | 2 +- reference/gender/gender.xml | 2 +- reference/gender/gender/connect.xml | 2 +- reference/gender/gender/construct.xml | 2 +- reference/gender/gender/country.xml | 2 +- reference/gender/gender/get.xml | 2 +- reference/gender/gender/isnick.xml | 2 +- reference/gender/gender/similarnames.xml | 2 +- reference/gender/setup.xml | 2 +- reference/geoip/book.xml | 2 +- reference/geoip/constants.xml | 2 +- .../geoip/functions/geoip-asnum-by-name.xml | 2 +- .../geoip-continent-code-by-name.xml | 2 +- .../functions/geoip-country-code-by-name.xml | 2 +- .../functions/geoip-country-code3-by-name.xml | 2 +- .../functions/geoip-country-name-by-name.xml | 2 +- .../geoip/functions/geoip-database-info.xml | 2 +- reference/geoip/functions/geoip-db-avail.xml | 2 +- .../geoip/functions/geoip-db-filename.xml | 2 +- .../geoip/functions/geoip-db-get-all-info.xml | 2 +- .../geoip/functions/geoip-domain-by-name.xml | 2 +- .../geoip/functions/geoip-id-by-name.xml | 2 +- .../geoip/functions/geoip-isp-by-name.xml | 2 +- .../functions/geoip-netspeedcell-by-name.xml | 2 +- .../geoip/functions/geoip-org-by-name.xml | 2 +- .../geoip/functions/geoip-record-by-name.xml | 2 +- .../geoip/functions/geoip-region-by-name.xml | 2 +- .../functions/geoip-region-name-by-code.xml | 2 +- .../geoip-setup-custom-directory.xml | 2 +- .../geoip-time-zone-by-country-and-region.xml | 2 +- reference/geoip/ini.xml | 2 +- reference/geoip/setup.xml | 2 +- reference/gmagick/book.xml | 2 +- reference/gmagick/constants.xml | 408 +++++++++--------- reference/gmagick/examples.xml | 2 +- reference/gmagick/gmagick.xml | 2 +- reference/gmagick/gmagick/addimage.xml | 2 +- reference/gmagick/gmagick/addnoiseimage.xml | 2 +- reference/gmagick/gmagick/annotateimage.xml | 2 +- reference/gmagick/gmagick/blurimage.xml | 2 +- reference/gmagick/gmagick/borderimage.xml | 2 +- reference/gmagick/gmagick/charcoalimage.xml | 2 +- reference/gmagick/gmagick/chopimage.xml | 2 +- reference/gmagick/gmagick/clear.xml | 2 +- reference/gmagick/gmagick/commentimage.xml | 2 +- reference/gmagick/gmagick/compositeimage.xml | 2 +- reference/gmagick/gmagick/construct.xml | 2 +- reference/gmagick/gmagick/cropimage.xml | 2 +- .../gmagick/gmagick/cropthumbnailimage.xml | 2 +- reference/gmagick/gmagick/current.xml | 2 +- .../gmagick/gmagick/cyclecolormapimage.xml | 2 +- .../gmagick/gmagick/deconstructimages.xml | 2 +- reference/gmagick/gmagick/despeckleimage.xml | 2 +- reference/gmagick/gmagick/destroy.xml | 2 +- reference/gmagick/gmagick/drawimage.xml | 2 +- reference/gmagick/gmagick/edgeimage.xml | 2 +- reference/gmagick/gmagick/embossimage.xml | 2 +- reference/gmagick/gmagick/enhanceimage.xml | 2 +- reference/gmagick/gmagick/equalizeimage.xml | 2 +- reference/gmagick/gmagick/flipimage.xml | 2 +- reference/gmagick/gmagick/flopimage.xml | 2 +- reference/gmagick/gmagick/frameimage.xml | 2 +- reference/gmagick/gmagick/gammaimage.xml | 2 +- reference/gmagick/gmagick/getcopyright.xml | 2 +- reference/gmagick/gmagick/getfilename.xml | 2 +- .../gmagick/getimagebackgroundcolor.xml | 2 +- .../gmagick/gmagick/getimageblueprimary.xml | 2 +- .../gmagick/gmagick/getimagebordercolor.xml | 2 +- .../gmagick/gmagick/getimagechanneldepth.xml | 2 +- reference/gmagick/gmagick/getimagecolors.xml | 2 +- .../gmagick/gmagick/getimagecolorspace.xml | 2 +- reference/gmagick/gmagick/getimagecompose.xml | 2 +- reference/gmagick/gmagick/getimagedelay.xml | 2 +- reference/gmagick/gmagick/getimagedepth.xml | 2 +- reference/gmagick/gmagick/getimagedispose.xml | 2 +- reference/gmagick/gmagick/getimageextrema.xml | 2 +- .../gmagick/gmagick/getimagefilename.xml | 2 +- reference/gmagick/gmagick/getimageformat.xml | 2 +- reference/gmagick/gmagick/getimagegamma.xml | 2 +- .../gmagick/gmagick/getimagegreenprimary.xml | 2 +- reference/gmagick/gmagick/getimageheight.xml | 2 +- .../gmagick/gmagick/getimagehistogram.xml | 4 +- reference/gmagick/gmagick/getimageindex.xml | 2 +- .../gmagick/getimageinterlacescheme.xml | 2 +- .../gmagick/gmagick/getimageiterations.xml | 2 +- reference/gmagick/gmagick/getimagematte.xml | 2 +- .../gmagick/gmagick/getimagemattecolor.xml | 2 +- reference/gmagick/gmagick/getimageprofile.xml | 2 +- .../gmagick/gmagick/getimageredprimary.xml | 2 +- .../gmagick/getimagerenderingintent.xml | 2 +- .../gmagick/gmagick/getimageresolution.xml | 2 +- reference/gmagick/gmagick/getimagescene.xml | 2 +- .../gmagick/gmagick/getimagesignature.xml | 2 +- reference/gmagick/gmagick/getimagetype.xml | 2 +- reference/gmagick/gmagick/getimageunits.xml | 2 +- .../gmagick/gmagick/getimagewhitepoint.xml | 2 +- reference/gmagick/gmagick/getimagewidth.xml | 2 +- reference/gmagick/gmagick/getpackagename.xml | 2 +- reference/gmagick/gmagick/getquantumdepth.xml | 2 +- reference/gmagick/gmagick/getreleasedate.xml | 2 +- .../gmagick/gmagick/getsamplingfactors.xml | 2 +- reference/gmagick/gmagick/getsize.xml | 2 +- reference/gmagick/gmagick/getversion.xml | 2 +- reference/gmagick/gmagick/hasnextimage.xml | 2 +- .../gmagick/gmagick/haspreviousimage.xml | 2 +- reference/gmagick/gmagick/implodeimage.xml | 2 +- reference/gmagick/gmagick/labelimage.xml | 2 +- reference/gmagick/gmagick/levelimage.xml | 2 +- reference/gmagick/gmagick/magnifyimage.xml | 2 +- reference/gmagick/gmagick/mapimage.xml | 2 +- .../gmagick/gmagick/medianfilterimage.xml | 2 +- reference/gmagick/gmagick/minifyimage.xml | 2 +- reference/gmagick/gmagick/modulateimage.xml | 2 +- reference/gmagick/gmagick/motionblurimage.xml | 2 +- reference/gmagick/gmagick/newimage.xml | 2 +- reference/gmagick/gmagick/nextimage.xml | 2 +- reference/gmagick/gmagick/normalizeimage.xml | 2 +- reference/gmagick/gmagick/oilpaintimage.xml | 2 +- reference/gmagick/gmagick/previousimage.xml | 2 +- reference/gmagick/gmagick/profileimage.xml | 2 +- reference/gmagick/gmagick/quantizeimage.xml | 2 +- reference/gmagick/gmagick/quantizeimages.xml | 2 +- .../gmagick/gmagick/queryfontmetrics.xml | 2 +- reference/gmagick/gmagick/queryfonts.xml | 2 +- reference/gmagick/gmagick/queryformats.xml | 2 +- reference/gmagick/gmagick/radialblurimage.xml | 2 +- reference/gmagick/gmagick/raiseimage.xml | 2 +- reference/gmagick/gmagick/read.xml | 2 +- reference/gmagick/gmagick/readimage.xml | 2 +- reference/gmagick/gmagick/readimageblob.xml | 2 +- reference/gmagick/gmagick/readimagefile.xml | 2 +- .../gmagick/gmagick/reducenoiseimage.xml | 2 +- reference/gmagick/gmagick/removeimage.xml | 2 +- .../gmagick/gmagick/removeimageprofile.xml | 2 +- reference/gmagick/gmagick/resampleimage.xml | 2 +- reference/gmagick/gmagick/resizeimage.xml | 2 +- reference/gmagick/gmagick/rollimage.xml | 2 +- reference/gmagick/gmagick/rotateimage.xml | 2 +- reference/gmagick/gmagick/scaleimage.xml | 2 +- .../gmagick/gmagick/separateimagechannel.xml | 2 +- .../gmagick/gmagick/setcompressionquality.xml | 2 +- reference/gmagick/gmagick/setfilename.xml | 2 +- .../gmagick/setimagebackgroundcolor.xml | 2 +- .../gmagick/gmagick/setimageblueprimary.xml | 2 +- .../gmagick/gmagick/setimagebordercolor.xml | 2 +- .../gmagick/gmagick/setimagechanneldepth.xml | 2 +- .../gmagick/gmagick/setimagecolorspace.xml | 2 +- reference/gmagick/gmagick/setimagecompose.xml | 2 +- reference/gmagick/gmagick/setimagedelay.xml | 2 +- reference/gmagick/gmagick/setimagedepth.xml | 2 +- reference/gmagick/gmagick/setimagedispose.xml | 2 +- .../gmagick/gmagick/setimagefilename.xml | 2 +- reference/gmagick/gmagick/setimageformat.xml | 2 +- reference/gmagick/gmagick/setimagegamma.xml | 2 +- .../gmagick/gmagick/setimagegreenprimary.xml | 2 +- reference/gmagick/gmagick/setimageindex.xml | 2 +- .../gmagick/setimageinterlacescheme.xml | 2 +- .../gmagick/gmagick/setimageiterations.xml | 2 +- reference/gmagick/gmagick/setimageprofile.xml | 2 +- .../gmagick/gmagick/setimageredprimary.xml | 2 +- .../gmagick/setimagerenderingintent.xml | 2 +- .../gmagick/gmagick/setimageresolution.xml | 2 +- reference/gmagick/gmagick/setimagescene.xml | 2 +- reference/gmagick/gmagick/setimagetype.xml | 2 +- reference/gmagick/gmagick/setimageunits.xml | 2 +- .../gmagick/gmagick/setimagewhitepoint.xml | 2 +- .../gmagick/gmagick/setsamplingfactors.xml | 2 +- reference/gmagick/gmagick/setsize.xml | 2 +- reference/gmagick/gmagick/shearimage.xml | 2 +- reference/gmagick/gmagick/solarizeimage.xml | 2 +- reference/gmagick/gmagick/spreadimage.xml | 2 +- reference/gmagick/gmagick/stripimage.xml | 2 +- reference/gmagick/gmagick/swirlimage.xml | 2 +- reference/gmagick/gmagick/thumbnailimage.xml | 2 +- reference/gmagick/gmagick/trimimage.xml | 2 +- reference/gmagick/gmagick/write.xml | 2 +- reference/gmagick/gmagick/writeimage.xml | 2 +- reference/gmagick/gmagickdraw.xml | 2 +- reference/gmagick/gmagickdraw/annotate.xml | 2 +- reference/gmagick/gmagickdraw/arc.xml | 2 +- reference/gmagick/gmagickdraw/bezier.xml | 2 +- reference/gmagick/gmagickdraw/ellipse.xml | 2 +- .../gmagick/gmagickdraw/getfillcolor.xml | 2 +- .../gmagick/gmagickdraw/getfillopacity.xml | 2 +- reference/gmagick/gmagickdraw/getfont.xml | 2 +- reference/gmagick/gmagickdraw/getfontsize.xml | 2 +- .../gmagick/gmagickdraw/getfontstyle.xml | 2 +- .../gmagick/gmagickdraw/getfontweight.xml | 2 +- .../gmagick/gmagickdraw/getstrokecolor.xml | 2 +- .../gmagick/gmagickdraw/getstrokeopacity.xml | 2 +- .../gmagick/gmagickdraw/getstrokewidth.xml | 2 +- .../gmagick/gmagickdraw/gettextdecoration.xml | 2 +- .../gmagick/gmagickdraw/gettextencoding.xml | 2 +- reference/gmagick/gmagickdraw/line.xml | 2 +- reference/gmagick/gmagickdraw/point.xml | 2 +- reference/gmagick/gmagickdraw/polygon.xml | 2 +- reference/gmagick/gmagickdraw/polyline.xml | 2 +- reference/gmagick/gmagickdraw/rectangle.xml | 2 +- reference/gmagick/gmagickdraw/rotate.xml | 2 +- .../gmagick/gmagickdraw/roundrectangle.xml | 2 +- reference/gmagick/gmagickdraw/scale.xml | 2 +- .../gmagick/gmagickdraw/setfillcolor.xml | 2 +- .../gmagick/gmagickdraw/setfillopacity.xml | 2 +- reference/gmagick/gmagickdraw/setfont.xml | 2 +- reference/gmagick/gmagickdraw/setfontsize.xml | 2 +- .../gmagick/gmagickdraw/setfontstyle.xml | 2 +- .../gmagick/gmagickdraw/setfontweight.xml | 2 +- .../gmagick/gmagickdraw/setstrokecolor.xml | 2 +- .../gmagick/gmagickdraw/setstrokeopacity.xml | 2 +- .../gmagick/gmagickdraw/setstrokewidth.xml | 2 +- .../gmagick/gmagickdraw/settextdecoration.xml | 2 +- .../gmagick/gmagickdraw/settextencoding.xml | 2 +- reference/gmagick/gmagickexception.xml | 2 +- reference/gmagick/gmagickpixel.xml | 2 +- reference/gmagick/gmagickpixel/construct.xml | 2 +- reference/gmagick/gmagickpixel/getcolor.xml | 4 +- .../gmagick/gmagickpixel/getcolorcount.xml | 4 +- .../gmagick/gmagickpixel/getcolorvalue.xml | 4 +- reference/gmagick/gmagickpixel/setcolor.xml | 2 +- .../gmagick/gmagickpixel/setcolorvalue.xml | 2 +- reference/gmagick/gmagickpixelexception.xml | 2 +- reference/gmagick/setup.xml | 2 +- reference/gnupg/book.xml | 2 +- reference/gnupg/configure.xml | 2 +- reference/gnupg/examples.xml | 2 +- .../gnupg/functions/gnupg-adddecryptkey.xml | 2 +- .../gnupg/functions/gnupg-addencryptkey.xml | 2 +- .../gnupg/functions/gnupg-addsignkey.xml | 2 +- .../functions/gnupg-cleardecryptkeys.xml | 2 +- .../functions/gnupg-clearencryptkeys.xml | 2 +- .../gnupg/functions/gnupg-clearsignkeys.xml | 2 +- reference/gnupg/functions/gnupg-decrypt.xml | 2 +- .../gnupg/functions/gnupg-decryptverify.xml | 2 +- reference/gnupg/functions/gnupg-deletekey.xml | 2 +- reference/gnupg/functions/gnupg-encrypt.xml | 2 +- .../gnupg/functions/gnupg-encryptsign.xml | 2 +- reference/gnupg/functions/gnupg-export.xml | 2 +- .../gnupg/functions/gnupg-getengineinfo.xml | 2 +- reference/gnupg/functions/gnupg-geterror.xml | 2 +- .../gnupg/functions/gnupg-geterrorinfo.xml | 2 +- .../gnupg/functions/gnupg-getprotocol.xml | 2 +- .../gnupg/functions/gnupg-gettrustlist.xml | 2 +- reference/gnupg/functions/gnupg-import.xml | 2 +- reference/gnupg/functions/gnupg-init.xml | 2 +- reference/gnupg/functions/gnupg-keyinfo.xml | 2 +- .../gnupg/functions/gnupg-listsignatures.xml | 2 +- reference/gnupg/functions/gnupg-setarmor.xml | 2 +- .../gnupg/functions/gnupg-seterrormode.xml | 2 +- .../gnupg/functions/gnupg-setsignmode.xml | 2 +- reference/gnupg/functions/gnupg-sign.xml | 2 +- reference/gnupg/functions/gnupg-verify.xml | 2 +- reference/gnupg/reference.xml | 2 +- reference/gnupg/setup.xml | 2 +- reference/hrtime/book.xml | 2 +- reference/hrtime/configure.xml | 2 +- reference/hrtime/examples.xml | 2 +- .../getfrequency.xml | 2 +- .../hrtime-performancecounter/getticks.xml | 2 +- .../gettickssince.xml | 2 +- .../hrtime-stopwatch/getelapsedticks.xml | 2 +- .../hrtime-stopwatch/getelapsedtime.xml | 2 +- .../hrtime-stopwatch/getlastelapsedticks.xml | 2 +- .../hrtime-stopwatch/getlastelapsedtime.xml | 2 +- .../hrtime/hrtime-stopwatch/isrunning.xml | 2 +- reference/hrtime/hrtime-stopwatch/start.xml | 2 +- reference/hrtime/hrtime-stopwatch/stop.xml | 2 +- .../hrtime/hrtime.performancecounter.xml | 2 +- reference/hrtime/hrtime.stopwatch.xml | 2 +- reference/hrtime/hrtime.unit.xml | 2 +- reference/hrtime/setup.xml | 2 +- reference/ibase/book.xml | 2 +- reference/ibase/configure.xml | 6 +- reference/ibase/constants.xml | 12 +- reference/ibase/functions/fbird-add-user.xml | 2 +- .../ibase/functions/fbird-affected-rows.xml | 2 +- reference/ibase/functions/fbird-backup.xml | 4 +- reference/ibase/functions/fbird-blob-add.xml | 2 +- .../ibase/functions/fbird-blob-cancel.xml | 2 +- .../ibase/functions/fbird-blob-close.xml | 2 +- .../ibase/functions/fbird-blob-create.xml | 2 +- reference/ibase/functions/fbird-blob-echo.xml | 2 +- reference/ibase/functions/fbird-blob-get.xml | 2 +- .../ibase/functions/fbird-blob-import.xml | 2 +- reference/ibase/functions/fbird-blob-info.xml | 4 +- reference/ibase/functions/fbird-blob-open.xml | 2 +- reference/ibase/functions/fbird-close.xml | 2 +- .../ibase/functions/fbird-commit-ret.xml | 4 +- reference/ibase/functions/fbird-commit.xml | 4 +- reference/ibase/functions/fbird-connect.xml | 2 +- reference/ibase/functions/fbird-db-info.xml | 4 +- .../ibase/functions/fbird-delete-user.xml | 2 +- reference/ibase/functions/fbird-drop-db.xml | 2 +- reference/ibase/functions/fbird-errcode.xml | 2 +- reference/ibase/functions/fbird-errmsg.xml | 2 +- reference/ibase/functions/fbird-execute.xml | 2 +- .../ibase/functions/fbird-fetch-assoc.xml | 2 +- .../ibase/functions/fbird-fetch-object.xml | 2 +- reference/ibase/functions/fbird-fetch-row.xml | 2 +- .../ibase/functions/fbird-field-info.xml | 2 +- .../functions/fbird-free-event-handler.xml | 2 +- .../ibase/functions/fbird-free-query.xml | 4 +- .../ibase/functions/fbird-free-result.xml | 4 +- reference/ibase/functions/fbird-gen-id.xml | 4 +- .../ibase/functions/fbird-maintain-db.xml | 4 +- .../ibase/functions/fbird-modify-user.xml | 2 +- .../ibase/functions/fbird-name-result.xml | 2 +- .../ibase/functions/fbird-num-fields.xml | 2 +- .../ibase/functions/fbird-num-params.xml | 2 +- .../ibase/functions/fbird-param-info.xml | 2 +- reference/ibase/functions/fbird-pconnect.xml | 2 +- reference/ibase/functions/fbird-prepare.xml | 4 +- reference/ibase/functions/fbird-query.xml | 2 +- reference/ibase/functions/fbird-restore.xml | 4 +- .../ibase/functions/fbird-rollback-ret.xml | 4 +- reference/ibase/functions/fbird-rollback.xml | 4 +- .../ibase/functions/fbird-server-info.xml | 4 +- .../ibase/functions/fbird-service-attach.xml | 4 +- .../ibase/functions/fbird-service-detach.xml | 4 +- .../functions/fbird-set-event-handler.xml | 2 +- reference/ibase/functions/fbird-trans.xml | 4 +- .../ibase/functions/fbird-wait-event.xml | 2 +- reference/ibase/functions/ibase-add-user.xml | 2 +- .../ibase/functions/ibase-affected-rows.xml | 2 +- reference/ibase/functions/ibase-backup.xml | 6 +- reference/ibase/functions/ibase-blob-add.xml | 2 +- .../ibase/functions/ibase-blob-cancel.xml | 2 +- .../ibase/functions/ibase-blob-close.xml | 2 +- .../ibase/functions/ibase-blob-create.xml | 2 +- reference/ibase/functions/ibase-blob-echo.xml | 2 +- reference/ibase/functions/ibase-blob-get.xml | 2 +- .../ibase/functions/ibase-blob-import.xml | 2 +- reference/ibase/functions/ibase-blob-info.xml | 2 +- reference/ibase/functions/ibase-blob-open.xml | 2 +- reference/ibase/functions/ibase-close.xml | 2 +- .../ibase/functions/ibase-commit-ret.xml | 2 +- reference/ibase/functions/ibase-commit.xml | 2 +- reference/ibase/functions/ibase-connect.xml | 2 +- reference/ibase/functions/ibase-db-info.xml | 4 +- .../ibase/functions/ibase-delete-user.xml | 2 +- reference/ibase/functions/ibase-drop-db.xml | 2 +- reference/ibase/functions/ibase-errcode.xml | 2 +- reference/ibase/functions/ibase-errmsg.xml | 2 +- reference/ibase/functions/ibase-execute.xml | 2 +- .../ibase/functions/ibase-fetch-assoc.xml | 2 +- .../ibase/functions/ibase-fetch-object.xml | 2 +- reference/ibase/functions/ibase-fetch-row.xml | 2 +- .../ibase/functions/ibase-field-info.xml | 2 +- .../functions/ibase-free-event-handler.xml | 2 +- .../ibase/functions/ibase-free-query.xml | 2 +- .../ibase/functions/ibase-free-result.xml | 2 +- reference/ibase/functions/ibase-gen-id.xml | 2 +- .../ibase/functions/ibase-maintain-db.xml | 2 +- .../ibase/functions/ibase-modify-user.xml | 2 +- .../ibase/functions/ibase-name-result.xml | 2 +- .../ibase/functions/ibase-num-fields.xml | 2 +- .../ibase/functions/ibase-num-params.xml | 2 +- .../ibase/functions/ibase-param-info.xml | 2 +- reference/ibase/functions/ibase-pconnect.xml | 2 +- reference/ibase/functions/ibase-prepare.xml | 2 +- reference/ibase/functions/ibase-query.xml | 2 +- reference/ibase/functions/ibase-restore.xml | 6 +- .../ibase/functions/ibase-rollback-ret.xml | 2 +- reference/ibase/functions/ibase-rollback.xml | 2 +- .../ibase/functions/ibase-server-info.xml | 2 +- .../ibase/functions/ibase-service-attach.xml | 2 +- .../ibase/functions/ibase-service-detach.xml | 2 +- .../functions/ibase-set-event-handler.xml | 2 +- reference/ibase/functions/ibase-trans.xml | 2 +- .../ibase/functions/ibase-wait-event.xml | 2 +- reference/ibase/ini.xml | 2 +- reference/ibase/reference.xml | 2 +- reference/ibm_db2/book.xml | 2 +- reference/ibm_db2/configure.xml | 2 +- reference/ibm_db2/constants.xml | 8 +- .../ibm_db2/functions/db2-autocommit.xml | 2 +- .../ibm_db2/functions/db2-bind-param.xml | 2 +- reference/ibm_db2/functions/db2-close.xml | 2 +- .../ibm_db2/functions/db2-conn-error.xml | 6 +- .../ibm_db2/functions/db2-conn-errormsg.xml | 2 +- reference/ibm_db2/functions/db2-connect.xml | 2 +- reference/ibm_db2/functions/db2-exec.xml | 2 +- reference/ibm_db2/functions/db2-execute.xml | 2 +- .../ibm_db2/functions/db2-fetch-array.xml | 2 +- .../ibm_db2/functions/db2-fetch-assoc.xml | 2 +- .../ibm_db2/functions/db2-fetch-both.xml | 2 +- .../ibm_db2/functions/db2-fetch-object.xml | 2 +- reference/ibm_db2/functions/db2-fetch-row.xml | 2 +- .../ibm_db2/functions/db2-get-option.xml | 2 +- .../ibm_db2/functions/db2-last-insert-id.xml | 2 +- reference/ibm_db2/functions/db2-lob-read.xml | 2 +- .../ibm_db2/functions/db2-num-fields.xml | 2 +- reference/ibm_db2/functions/db2-pclose.xml | 2 +- reference/ibm_db2/functions/db2-pconnect.xml | 2 +- reference/ibm_db2/functions/db2-prepare.xml | 2 +- reference/ibm_db2/functions/db2-result.xml | 2 +- reference/ibm_db2/functions/db2-rollback.xml | 2 +- .../ibm_db2/functions/db2-set-option.xml | 2 +- .../ibm_db2/functions/db2-stmt-error.xml | 4 +- reference/ibm_db2/ini.xml | 6 +- reference/ibm_db2/setup.xml | 2 +- .../igbinary/functions/igbinary-serialize.xml | 2 +- .../functions/igbinary-unserialize.xml | 4 +- reference/igbinary/ini.xml | 2 +- reference/igbinary/setup.xml | 2 +- reference/imagick/book.xml | 14 +- reference/imagick/constants.xml | 76 ++-- reference/imagick/imagick.xml | 10 +- .../imagick/imagick/adaptiveblurimage.xml | 30 +- .../imagick/imagick/adaptiveresizeimage.xml | 24 +- .../imagick/imagick/adaptivesharpenimage.xml | 26 +- .../imagick/adaptivethresholdimage.xml | 22 +- reference/imagick/imagick/addimage.xml | 18 +- reference/imagick/imagick/addnoiseimage.xml | 18 +- .../imagick/imagick/affinetransformimage.xml | 18 +- reference/imagick/imagick/animateimages.xml | 14 +- reference/imagick/imagick/annotateimage.xml | 34 +- reference/imagick/imagick/appendimages.xml | 18 +- reference/imagick/imagick/autolevelimage.xml | 12 +- reference/imagick/imagick/averageimages.xml | 14 +- .../imagick/imagick/blackthresholdimage.xml | 14 +- reference/imagick/imagick/blueshiftimage.xml | 16 +- reference/imagick/imagick/blurimage.xml | 30 +- reference/imagick/imagick/borderimage.xml | 22 +- .../imagick/brightnesscontrastimage.xml | 22 +- reference/imagick/imagick/charcoalimage.xml | 18 +- reference/imagick/imagick/chopimage.xml | 34 +- reference/imagick/imagick/clampimage.xml | 14 +- reference/imagick/imagick/clear.xml | 10 +- reference/imagick/imagick/clipimage.xml | 14 +- reference/imagick/imagick/clipimagepath.xml | 22 +- reference/imagick/imagick/clippathimage.xml | 22 +- reference/imagick/imagick/clone.xml | 10 +- reference/imagick/imagick/clutimage.xml | 22 +- reference/imagick/imagick/coalesceimages.xml | 14 +- .../imagick/imagick/colorfloodfillimage.xml | 34 +- reference/imagick/imagick/colorizeimage.xml | 24 +- .../imagick/imagick/colormatriximage.xml | 16 +- reference/imagick/imagick/combineimages.xml | 18 +- reference/imagick/imagick/commentimage.xml | 22 +- .../imagick/imagick/compareimagechannels.xml | 26 +- .../imagick/imagick/compareimagelayers.xml | 22 +- reference/imagick/imagick/compareimages.xml | 26 +- reference/imagick/imagick/compositeimage.xml | 40 +- reference/imagick/imagick/construct.xml | 16 +- reference/imagick/imagick/contrastimage.xml | 18 +- .../imagick/imagick/contraststretchimage.xml | 22 +- reference/imagick/imagick/convolveimage.xml | 24 +- reference/imagick/imagick/count.xml | 12 +- reference/imagick/imagick/cropimage.xml | 30 +- .../imagick/imagick/cropthumbnailimage.xml | 20 +- reference/imagick/imagick/current.xml | 14 +- .../imagick/imagick/cyclecolormapimage.xml | 18 +- reference/imagick/imagick/decipherimage.xml | 14 +- .../imagick/imagick/deconstructimages.xml | 14 +- .../imagick/imagick/deleteimageartifact.xml | 20 +- .../imagick/imagick/deleteimageproperty.xml | 12 +- reference/imagick/imagick/deskewimage.xml | 14 +- reference/imagick/imagick/despeckleimage.xml | 14 +- reference/imagick/imagick/destroy.xml | 12 +- reference/imagick/imagick/displayimage.xml | 18 +- reference/imagick/imagick/displayimages.xml | 20 +- reference/imagick/imagick/distortimage.xml | 42 +- reference/imagick/imagick/drawimage.xml | 14 +- reference/imagick/imagick/edgeimage.xml | 18 +- reference/imagick/imagick/embossimage.xml | 26 +- reference/imagick/imagick/encipherimage.xml | 14 +- reference/imagick/imagick/enhanceimage.xml | 14 +- reference/imagick/imagick/equalizeimage.xml | 14 +- reference/imagick/imagick/evaluateimage.xml | 26 +- .../imagick/imagick/exportimagepixels.xml | 48 +-- reference/imagick/imagick/extentimage.xml | 24 +- reference/imagick/imagick/filter.xml | 24 +- reference/imagick/imagick/flattenimages.xml | 14 +- reference/imagick/imagick/flipimage.xml | 14 +- .../imagick/imagick/floodfillpaintimage.xml | 42 +- reference/imagick/imagick/flopimage.xml | 14 +- .../imagick/forwardfouriertransformimage.xml | 12 +- reference/imagick/imagick/frameimage.xml | 34 +- reference/imagick/imagick/functionimage.xml | 30 +- reference/imagick/imagick/fximage.xml | 22 +- reference/imagick/imagick/gammaimage.xml | 22 +- .../imagick/imagick/gaussianblurimage.xml | 26 +- reference/imagick/imagick/getcolorspace.xml | 10 +- reference/imagick/imagick/getcompression.xml | 10 +- .../imagick/imagick/getcompressionquality.xml | 10 +- reference/imagick/imagick/getcopyright.xml | 10 +- reference/imagick/imagick/getfilename.xml | 14 +- reference/imagick/imagick/getfont.xml | 10 +- reference/imagick/imagick/getformat.xml | 14 +- reference/imagick/imagick/getgravity.xml | 12 +- reference/imagick/imagick/gethomeurl.xml | 10 +- reference/imagick/imagick/getimage.xml | 14 +- .../imagick/imagick/getimagealphachannel.xml | 14 +- .../imagick/imagick/getimageartifact.xml | 20 +- .../imagick/imagick/getimageattribute.xml | 14 +- .../imagick/getimagebackgroundcolor.xml | 14 +- reference/imagick/imagick/getimageblob.xml | 14 +- .../imagick/imagick/getimageblueprimary.xml | 22 +- .../imagick/imagick/getimagebordercolor.xml | 14 +- .../imagick/imagick/getimagechanneldepth.xml | 14 +- .../imagick/getimagechanneldistortion.xml | 26 +- .../imagick/getimagechanneldistortions.xml | 26 +- .../imagick/getimagechannelextrema.xml | 18 +- .../imagick/getimagechannelkurtosis.xml | 16 +- .../imagick/imagick/getimagechannelmean.xml | 18 +- .../imagick/imagick/getimagechannelrange.xml | 18 +- .../imagick/getimagechannelstatistics.xml | 10 +- .../imagick/imagick/getimageclipmask.xml | 14 +- .../imagick/imagick/getimagecolormapcolor.xml | 18 +- reference/imagick/imagick/getimagecolors.xml | 10 +- .../imagick/imagick/getimagecolorspace.xml | 10 +- reference/imagick/imagick/getimagecompose.xml | 10 +- .../imagick/imagick/getimagecompression.xml | 10 +- .../imagick/getimagecompressionquality.xml | 10 +- reference/imagick/imagick/getimagedelay.xml | 14 +- reference/imagick/imagick/getimagedepth.xml | 10 +- reference/imagick/imagick/getimagedispose.xml | 14 +- .../imagick/imagick/getimagedistortion.xml | 22 +- reference/imagick/imagick/getimageextrema.xml | 14 +- .../imagick/imagick/getimagefilename.xml | 14 +- reference/imagick/imagick/getimageformat.xml | 14 +- reference/imagick/imagick/getimagegamma.xml | 14 +- .../imagick/imagick/getimagegeometry.xml | 14 +- reference/imagick/imagick/getimagegravity.xml | 12 +- .../imagick/imagick/getimagegreenprimary.xml | 14 +- reference/imagick/imagick/getimageheight.xml | 14 +- .../imagick/imagick/getimagehistogram.xml | 20 +- reference/imagick/imagick/getimageindex.xml | 14 +- .../imagick/getimageinterlacescheme.xml | 12 +- .../imagick/getimageinterpolatemethod.xml | 16 +- .../imagick/imagick/getimageiterations.xml | 14 +- reference/imagick/imagick/getimagelength.xml | 14 +- reference/imagick/imagick/getimagematte.xml | 10 +- .../imagick/imagick/getimagemattecolor.xml | 14 +- .../imagick/imagick/getimagemimetype.xml | 10 +- .../imagick/imagick/getimageorientation.xml | 14 +- reference/imagick/imagick/getimagepage.xml | 14 +- .../imagick/imagick/getimagepixelcolor.xml | 22 +- reference/imagick/imagick/getimageprofile.xml | 18 +- .../imagick/imagick/getimageprofiles.xml | 18 +- .../imagick/imagick/getimageproperties.xml | 22 +- .../imagick/imagick/getimageproperty.xml | 20 +- .../imagick/imagick/getimageredprimary.xml | 14 +- reference/imagick/imagick/getimageregion.xml | 38 +- .../imagick/getimagerenderingintent.xml | 14 +- .../imagick/imagick/getimageresolution.xml | 14 +- reference/imagick/imagick/getimagesblob.xml | 10 +- reference/imagick/imagick/getimagescene.xml | 14 +- .../imagick/imagick/getimagesignature.xml | 14 +- reference/imagick/imagick/getimagesize.xml | 10 +- .../imagick/getimagetickspersecond.xml | 14 +- .../imagick/getimagetotalinkdensity.xml | 10 +- reference/imagick/imagick/getimagetype.xml | 12 +- reference/imagick/imagick/getimageunits.xml | 14 +- .../imagick/getimagevirtualpixelmethod.xml | 14 +- .../imagick/imagick/getimagewhitepoint.xml | 14 +- reference/imagick/imagick/getimagewidth.xml | 14 +- .../imagick/imagick/getinterlacescheme.xml | 14 +- .../imagick/imagick/getiteratorindex.xml | 18 +- reference/imagick/imagick/getnumberimages.xml | 14 +- reference/imagick/imagick/getoption.xml | 18 +- reference/imagick/imagick/getpackagename.xml | 14 +- reference/imagick/imagick/getpage.xml | 10 +- .../imagick/imagick/getpixeliterator.xml | 14 +- .../imagick/getpixelregioniterator.xml | 44 +- reference/imagick/imagick/getpointsize.xml | 10 +- reference/imagick/imagick/getquantum.xml | 10 +- reference/imagick/imagick/getquantumdepth.xml | 14 +- reference/imagick/imagick/getquantumrange.xml | 16 +- reference/imagick/imagick/getregistry.xml | 14 +- reference/imagick/imagick/getreleasedate.xml | 14 +- reference/imagick/imagick/getresource.xml | 18 +- .../imagick/imagick/getresourcelimit.xml | 20 +- .../imagick/imagick/getsamplingfactors.xml | 14 +- reference/imagick/imagick/getsize.xml | 16 +- reference/imagick/imagick/getsizeoffset.xml | 14 +- reference/imagick/imagick/getversion.xml | 14 +- reference/imagick/imagick/haldclutimage.xml | 22 +- reference/imagick/imagick/hasnextimage.xml | 10 +- .../imagick/imagick/haspreviousimage.xml | 10 +- reference/imagick/imagick/identifyformat.xml | 12 +- reference/imagick/imagick/identifyimage.xml | 20 +- reference/imagick/imagick/implodeimage.xml | 18 +- .../imagick/imagick/importimagepixels.xml | 48 +-- .../imagick/inversefouriertransformimage.xml | 16 +- reference/imagick/imagick/labelimage.xml | 14 +- reference/imagick/imagick/levelimage.xml | 30 +- .../imagick/imagick/linearstretchimage.xml | 18 +- .../imagick/imagick/liquidrescaleimage.xml | 30 +- reference/imagick/imagick/listregistry.xml | 8 +- reference/imagick/imagick/magnifyimage.xml | 14 +- reference/imagick/imagick/mapimage.xml | 18 +- .../imagick/imagick/mattefloodfillimage.xml | 34 +- .../imagick/imagick/medianfilterimage.xml | 18 +- .../imagick/imagick/mergeimagelayers.xml | 24 +- reference/imagick/imagick/minifyimage.xml | 10 +- reference/imagick/imagick/modulateimage.xml | 22 +- reference/imagick/imagick/montageimage.xml | 40 +- reference/imagick/imagick/morphimages.xml | 14 +- reference/imagick/imagick/morphology.xml | 36 +- reference/imagick/imagick/mosaicimages.xml | 10 +- reference/imagick/imagick/motionblurimage.xml | 28 +- reference/imagick/imagick/negateimage.xml | 22 +- reference/imagick/imagick/newimage.xml | 34 +- reference/imagick/imagick/newpseudoimage.xml | 26 +- reference/imagick/imagick/nextimage.xml | 10 +- reference/imagick/imagick/normalizeimage.xml | 14 +- reference/imagick/imagick/oilpaintimage.xml | 14 +- .../imagick/imagick/opaquepaintimage.xml | 30 +- .../imagick/imagick/optimizeimagelayers.xml | 20 +- .../imagick/imagick/orderedposterizeimage.xml | 32 +- .../imagick/imagick/paintfloodfillimage.xml | 34 +- .../imagick/imagick/paintopaqueimage.xml | 30 +- .../imagick/imagick/painttransparentimage.xml | 28 +- reference/imagick/imagick/pingimage.xml | 14 +- reference/imagick/imagick/pingimageblob.xml | 20 +- reference/imagick/imagick/pingimagefile.xml | 24 +- reference/imagick/imagick/polaroidimage.xml | 22 +- reference/imagick/imagick/posterizeimage.xml | 18 +- reference/imagick/imagick/previewimages.xml | 18 +- reference/imagick/imagick/previousimage.xml | 10 +- reference/imagick/imagick/profileimage.xml | 10 +- reference/imagick/imagick/quantizeimage.xml | 30 +- reference/imagick/imagick/quantizeimages.xml | 30 +- .../imagick/imagick/queryfontmetrics.xml | 42 +- reference/imagick/imagick/queryfonts.xml | 28 +- reference/imagick/imagick/queryformats.xml | 18 +- reference/imagick/imagick/radialblurimage.xml | 18 +- reference/imagick/imagick/raiseimage.xml | 30 +- .../imagick/imagick/randomthresholdimage.xml | 22 +- reference/imagick/imagick/readimage.xml | 14 +- reference/imagick/imagick/readimageblob.xml | 18 +- reference/imagick/imagick/readimagefile.xml | 22 +- reference/imagick/imagick/readimages.xml | 14 +- reference/imagick/imagick/recolorimage.xml | 16 +- .../imagick/imagick/reducenoiseimage.xml | 18 +- reference/imagick/imagick/remapimage.xml | 20 +- reference/imagick/imagick/removeimage.xml | 14 +- .../imagick/imagick/removeimageprofile.xml | 18 +- reference/imagick/imagick/render.xml | 10 +- reference/imagick/imagick/resampleimage.xml | 26 +- reference/imagick/imagick/resetimagepage.xml | 14 +- reference/imagick/imagick/resizeimage.xml | 24 +- reference/imagick/imagick/rollimage.xml | 18 +- reference/imagick/imagick/rotateimage.xml | 18 +- .../imagick/imagick/rotationalblurimage.xml | 16 +- reference/imagick/imagick/roundcorners.xml | 44 +- reference/imagick/imagick/sampleimage.xml | 18 +- reference/imagick/imagick/scaleimage.xml | 12 +- reference/imagick/imagick/segmentimage.xml | 26 +- .../imagick/imagick/selectiveblurimage.xml | 30 +- .../imagick/imagick/separateimagechannel.xml | 18 +- reference/imagick/imagick/sepiatoneimage.xml | 18 +- .../imagick/imagick/setbackgroundcolor.xml | 14 +- reference/imagick/imagick/setcolorspace.xml | 18 +- reference/imagick/imagick/setcompression.xml | 14 +- .../imagick/imagick/setcompressionquality.xml | 24 +- reference/imagick/imagick/setfilename.xml | 14 +- .../imagick/imagick/setfirstiterator.xml | 10 +- reference/imagick/imagick/setfont.xml | 12 +- reference/imagick/imagick/setformat.xml | 14 +- reference/imagick/imagick/setgravity.xml | 16 +- reference/imagick/imagick/setimage.xml | 22 +- .../imagick/imagick/setimagealphachannel.xml | 20 +- .../imagick/imagick/setimageartifact.xml | 26 +- .../imagick/imagick/setimageattribute.xml | 20 +- .../imagick/setimagebackgroundcolor.xml | 18 +- reference/imagick/imagick/setimagebias.xml | 20 +- .../imagick/imagick/setimagebiasquantum.xml | 16 +- .../imagick/imagick/setimageblueprimary.xml | 22 +- .../imagick/imagick/setimagebordercolor.xml | 18 +- .../imagick/imagick/setimagechanneldepth.xml | 22 +- .../imagick/imagick/setimageclipmask.xml | 20 +- .../imagick/imagick/setimagecolormapcolor.xml | 22 +- .../imagick/imagick/setimagecolorspace.xml | 18 +- reference/imagick/imagick/setimagecompose.xml | 18 +- .../imagick/imagick/setimagecompression.xml | 18 +- .../imagick/setimagecompressionquality.xml | 18 +- reference/imagick/imagick/setimagedelay.xml | 22 +- reference/imagick/imagick/setimagedepth.xml | 18 +- reference/imagick/imagick/setimagedispose.xml | 18 +- reference/imagick/imagick/setimageextent.xml | 22 +- .../imagick/imagick/setimagefilename.xml | 18 +- reference/imagick/imagick/setimageformat.xml | 14 +- reference/imagick/imagick/setimagegamma.xml | 18 +- reference/imagick/imagick/setimagegravity.xml | 18 +- .../imagick/imagick/setimagegreenprimary.xml | 22 +- reference/imagick/imagick/setimageindex.xml | 24 +- .../imagick/setimageinterlacescheme.xml | 18 +- .../imagick/setimageinterpolatemethod.xml | 14 +- .../imagick/imagick/setimageiterations.xml | 18 +- reference/imagick/imagick/setimagematte.xml | 16 +- .../imagick/imagick/setimagemattecolor.xml | 18 +- reference/imagick/imagick/setimageopacity.xml | 18 +- .../imagick/imagick/setimageorientation.xml | 14 +- reference/imagick/imagick/setimagepage.xml | 30 +- reference/imagick/imagick/setimageprofile.xml | 22 +- .../imagick/imagick/setimageproperty.xml | 22 +- .../imagick/imagick/setimageredprimary.xml | 22 +- .../imagick/setimagerenderingintent.xml | 18 +- .../imagick/imagick/setimageresolution.xml | 24 +- reference/imagick/imagick/setimagescene.xml | 18 +- .../imagick/setimagetickspersecond.xml | 24 +- reference/imagick/imagick/setimagetype.xml | 14 +- reference/imagick/imagick/setimageunits.xml | 14 +- .../imagick/setimagevirtualpixelmethod.xml | 14 +- .../imagick/imagick/setimagewhitepoint.xml | 22 +- .../imagick/imagick/setinterlacescheme.xml | 14 +- .../imagick/imagick/setiteratorindex.xml | 18 +- reference/imagick/imagick/setlastiterator.xml | 10 +- reference/imagick/imagick/setoption.xml | 22 +- reference/imagick/imagick/setpage.xml | 26 +- reference/imagick/imagick/setpointsize.xml | 22 +- .../imagick/imagick/setprogressmonitor.xml | 24 +- reference/imagick/imagick/setregistry.xml | 20 +- reference/imagick/imagick/setresolution.xml | 28 +- .../imagick/imagick/setresourcelimit.xml | 22 +- .../imagick/imagick/setsamplingfactors.xml | 18 +- reference/imagick/imagick/setsize.xml | 18 +- reference/imagick/imagick/setsizeoffset.xml | 22 +- reference/imagick/imagick/settype.xml | 14 +- reference/imagick/imagick/shadeimage.xml | 28 +- reference/imagick/imagick/shadowimage.xml | 26 +- reference/imagick/imagick/sharpenimage.xml | 22 +- reference/imagick/imagick/shaveimage.xml | 18 +- reference/imagick/imagick/shearimage.xml | 22 +- .../imagick/sigmoidalcontrastimage.xml | 8 +- reference/imagick/imagick/sketchimage.xml | 24 +- reference/imagick/imagick/smushimages.xml | 20 +- reference/imagick/imagick/solarizeimage.xml | 14 +- .../imagick/imagick/sparsecolorimage.xml | 26 +- reference/imagick/imagick/spliceimage.xml | 26 +- reference/imagick/imagick/spreadimage.xml | 18 +- reference/imagick/imagick/statisticimage.xml | 32 +- reference/imagick/imagick/steganoimage.xml | 18 +- reference/imagick/imagick/stereoimage.xml | 18 +- reference/imagick/imagick/stripimage.xml | 14 +- reference/imagick/imagick/subimagematch.xml | 26 +- reference/imagick/imagick/swirlimage.xml | 18 +- reference/imagick/imagick/textureimage.xml | 18 +- reference/imagick/imagick/thresholdimage.xml | 18 +- reference/imagick/imagick/thumbnailimage.xml | 36 +- reference/imagick/imagick/tintimage.xml | 22 +- reference/imagick/imagick/toString.xml | 22 +- reference/imagick/imagick/transformimage.xml | 22 +- .../imagick/transformimagecolorspace.xml | 18 +- .../imagick/imagick/transparentpaintimage.xml | 26 +- reference/imagick/imagick/transposeimage.xml | 14 +- reference/imagick/imagick/transverseimage.xml | 10 +- reference/imagick/imagick/trimimage.xml | 22 +- .../imagick/imagick/uniqueimagecolors.xml | 12 +- .../imagick/imagick/unsharpmaskimage.xml | 34 +- reference/imagick/imagick/valid.xml | 10 +- reference/imagick/imagick/vignetteimage.xml | 30 +- reference/imagick/imagick/waveimage.xml | 24 +- .../imagick/imagick/whitethresholdimage.xml | 14 +- reference/imagick/imagick/writeimage.xml | 16 +- reference/imagick/imagick/writeimagefile.xml | 18 +- reference/imagick/imagick/writeimages.xml | 18 +- reference/imagick/imagick/writeimagesfile.xml | 18 +- reference/imagick/imagickdraw/affine.xml | 14 +- reference/imagick/imagickdraw/annotation.xml | 22 +- reference/imagick/imagickdraw/arc.xml | 36 +- reference/imagick/imagickdraw/bezier.xml | 26 +- reference/imagick/imagickdraw/circle.xml | 26 +- reference/imagick/imagickdraw/clear.xml | 10 +- reference/imagick/imagickdraw/clone.xml | 10 +- reference/imagick/imagickdraw/color.xml | 22 +- reference/imagick/imagickdraw/comment.xml | 14 +- reference/imagick/imagickdraw/composite.xml | 36 +- reference/imagick/imagickdraw/construct.xml | 10 +- reference/imagick/imagickdraw/destroy.xml | 10 +- reference/imagick/imagickdraw/ellipse.xml | 34 +- reference/imagick/imagickdraw/getclippath.xml | 10 +- reference/imagick/imagickdraw/getcliprule.xml | 12 +- .../imagick/imagickdraw/getclipunits.xml | 10 +- .../imagick/imagickdraw/getfillcolor.xml | 10 +- .../imagick/imagickdraw/getfillopacity.xml | 12 +- reference/imagick/imagickdraw/getfillrule.xml | 16 +- reference/imagick/imagickdraw/getfont.xml | 12 +- .../imagick/imagickdraw/getfontfamily.xml | 12 +- reference/imagick/imagickdraw/getfontsize.xml | 10 +- .../imagick/imagickdraw/getfontstretch.xml | 10 +- .../imagick/imagickdraw/getfontstyle.xml | 12 +- .../imagick/imagickdraw/getfontweight.xml | 10 +- reference/imagick/imagickdraw/getgravity.xml | 10 +- .../imagickdraw/getstrokeantialias.xml | 10 +- .../imagick/imagickdraw/getstrokecolor.xml | 14 +- .../imagickdraw/getstrokedasharray.xml | 10 +- .../imagickdraw/getstrokedashoffset.xml | 10 +- .../imagick/imagickdraw/getstrokelinecap.xml | 10 +- .../imagick/imagickdraw/getstrokelinejoin.xml | 10 +- .../imagickdraw/getstrokemiterlimit.xml | 10 +- .../imagick/imagickdraw/getstrokeopacity.xml | 10 +- .../imagick/imagickdraw/getstrokewidth.xml | 10 +- .../imagick/imagickdraw/gettextalignment.xml | 10 +- .../imagick/imagickdraw/gettextantialias.xml | 10 +- .../imagick/imagickdraw/gettextdecoration.xml | 10 +- .../imagick/imagickdraw/gettextencoding.xml | 10 +- .../imagickdraw/gettextinterlinespacing.xml | 10 +- .../imagickdraw/gettextinterwordspacing.xml | 10 +- .../imagick/imagickdraw/gettextkerning.xml | 10 +- .../imagick/imagickdraw/gettextundercolor.xml | 10 +- .../imagick/imagickdraw/getvectorgraphics.xml | 12 +- reference/imagick/imagickdraw/line.xml | 26 +- reference/imagick/imagickdraw/matte.xml | 24 +- reference/imagick/imagickdraw/pathclose.xml | 10 +- .../imagickdraw/pathcurvetoabsolute.xml | 34 +- .../pathcurvetoquadraticbezierabsolute.xml | 28 +- .../pathcurvetoquadraticbezierrelative.xml | 26 +- ...thcurvetoquadraticbeziersmoothabsolute.xml | 32 +- ...thcurvetoquadraticbeziersmoothrelative.xml | 32 +- .../imagickdraw/pathcurvetorelative.xml | 36 +- .../imagickdraw/pathcurvetosmoothabsolute.xml | 30 +- .../imagickdraw/pathcurvetosmoothrelative.xml | 28 +- .../imagickdraw/pathellipticarcabsolute.xml | 38 +- .../imagickdraw/pathellipticarcrelative.xml | 38 +- reference/imagick/imagickdraw/pathfinish.xml | 10 +- .../imagickdraw/pathlinetoabsolute.xml | 18 +- .../pathlinetohorizontalabsolute.xml | 14 +- .../pathlinetohorizontalrelative.xml | 14 +- .../imagickdraw/pathlinetorelative.xml | 18 +- .../pathlinetoverticalabsolute.xml | 14 +- .../pathlinetoverticalrelative.xml | 14 +- .../imagickdraw/pathmovetoabsolute.xml | 18 +- .../imagickdraw/pathmovetorelative.xml | 18 +- reference/imagick/imagickdraw/pathstart.xml | 10 +- reference/imagick/imagickdraw/point.xml | 18 +- reference/imagick/imagickdraw/polygon.xml | 18 +- reference/imagick/imagickdraw/polyline.xml | 16 +- reference/imagick/imagickdraw/pop.xml | 10 +- reference/imagick/imagickdraw/popclippath.xml | 10 +- reference/imagick/imagickdraw/popdefs.xml | 10 +- reference/imagick/imagickdraw/poppattern.xml | 10 +- reference/imagick/imagickdraw/push.xml | 10 +- .../imagick/imagickdraw/pushclippath.xml | 14 +- reference/imagick/imagickdraw/pushdefs.xml | 10 +- reference/imagick/imagickdraw/pushpattern.xml | 30 +- reference/imagick/imagickdraw/rectangle.xml | 26 +- reference/imagick/imagickdraw/render.xml | 10 +- .../imagickdraw/resetvectorgraphics.xml | 8 +- reference/imagick/imagickdraw/rotate.xml | 14 +- .../imagick/imagickdraw/roundrectangle.xml | 38 +- reference/imagick/imagickdraw/scale.xml | 18 +- reference/imagick/imagickdraw/setclippath.xml | 14 +- reference/imagick/imagickdraw/setcliprule.xml | 14 +- .../imagick/imagickdraw/setclipunits.xml | 14 +- .../imagick/imagickdraw/setfillalpha.xml | 14 +- .../imagick/imagickdraw/setfillcolor.xml | 14 +- .../imagick/imagickdraw/setfillopacity.xml | 14 +- .../imagick/imagickdraw/setfillpatternurl.xml | 14 +- reference/imagick/imagickdraw/setfillrule.xml | 14 +- reference/imagick/imagickdraw/setfont.xml | 14 +- .../imagick/imagickdraw/setfontfamily.xml | 16 +- reference/imagick/imagickdraw/setfontsize.xml | 14 +- .../imagick/imagickdraw/setfontstretch.xml | 28 +- .../imagick/imagickdraw/setfontstyle.xml | 14 +- .../imagick/imagickdraw/setfontweight.xml | 14 +- reference/imagick/imagickdraw/setgravity.xml | 14 +- .../imagick/imagickdraw/setresolution.xml | 20 +- .../imagick/imagickdraw/setstrokealpha.xml | 14 +- .../imagickdraw/setstrokeantialias.xml | 14 +- .../imagick/imagickdraw/setstrokecolor.xml | 14 +- .../imagickdraw/setstrokedasharray.xml | 14 +- .../imagickdraw/setstrokedashoffset.xml | 14 +- .../imagick/imagickdraw/setstrokelinecap.xml | 14 +- .../imagick/imagickdraw/setstrokelinejoin.xml | 16 +- .../imagickdraw/setstrokemiterlimit.xml | 16 +- .../imagick/imagickdraw/setstrokeopacity.xml | 14 +- .../imagickdraw/setstrokepatternurl.xml | 14 +- .../imagick/imagickdraw/setstrokewidth.xml | 14 +- .../imagick/imagickdraw/settextalignment.xml | 14 +- .../imagick/imagickdraw/settextantialias.xml | 16 +- .../imagick/imagickdraw/settextdecoration.xml | 14 +- .../imagick/imagickdraw/settextencoding.xml | 14 +- .../imagickdraw/settextinterlinespacing.xml | 14 +- .../imagickdraw/settextinterwordspacing.xml | 14 +- .../imagick/imagickdraw/settextkerning.xml | 14 +- .../imagick/imagickdraw/settextundercolor.xml | 14 +- .../imagick/imagickdraw/setvectorgraphics.xml | 18 +- reference/imagick/imagickdraw/setviewbox.xml | 28 +- reference/imagick/imagickdraw/skewx.xml | 16 +- reference/imagick/imagickdraw/skewy.xml | 16 +- reference/imagick/imagickdraw/translate.xml | 20 +- reference/imagick/imagickkernel.xml | 6 +- reference/imagick/imagickkernel/addkernel.xml | 16 +- .../imagick/imagickkernel/addunitykernel.xml | 20 +- .../imagick/imagickkernel/frombuiltin.xml | 38 +- .../imagick/imagickkernel/frommatrix.xml | 36 +- reference/imagick/imagickkernel/getmatrix.xml | 8 +- reference/imagick/imagickkernel/scale.xml | 32 +- reference/imagick/imagickkernel/separate.xml | 20 +- reference/imagick/imagickkernelexception.xml | 4 +- reference/imagick/imagickpixel/clear.xml | 10 +- reference/imagick/imagickpixel/construct.xml | 16 +- reference/imagick/imagickpixel/destroy.xml | 10 +- reference/imagick/imagickpixel/getcolor.xml | 14 +- .../imagick/imagickpixel/getcolorasstring.xml | 14 +- .../imagick/imagickpixel/getcolorcount.xml | 22 +- .../imagick/imagickpixel/getcolorquantum.xml | 8 +- .../imagick/imagickpixel/getcolorvalue.xml | 16 +- .../imagickpixel/getcolorvaluequantum.xml | 8 +- reference/imagick/imagickpixel/gethsl.xml | 14 +- reference/imagick/imagickpixel/getindex.xml | 10 +- .../imagick/imagickpixel/ispixelsimilar.xml | 18 +- .../imagickpixel/ispixelsimilarquantum.xml | 22 +- reference/imagick/imagickpixel/issimilar.xml | 22 +- reference/imagick/imagickpixel/setcolor.xml | 14 +- .../imagick/imagickpixel/setcolorcount.xml | 14 +- .../imagick/imagickpixel/setcolorvalue.xml | 18 +- .../imagickpixel/setcolorvaluequantum.xml | 18 +- reference/imagick/imagickpixel/sethsl.xml | 26 +- reference/imagick/imagickpixel/setindex.xml | 14 +- .../imagick/imagickpixeliterator/clear.xml | 16 +- .../imagickpixeliterator/construct.xml | 14 +- .../imagick/imagickpixeliterator/destroy.xml | 10 +- .../getcurrentiteratorrow.xml | 10 +- .../imagickpixeliterator/getiteratorrow.xml | 10 +- .../getnextiteratorrow.xml | 14 +- .../getpreviousiteratorrow.xml | 10 +- .../imagickpixeliterator/newpixeliterator.xml | 10 +- .../newpixelregioniterator.xml | 30 +- .../imagickpixeliterator/resetiterator.xml | 10 +- .../setiteratorfirstrow.xml | 10 +- .../setiteratorlastrow.xml | 10 +- .../imagickpixeliterator/setiteratorrow.xml | 18 +- .../imagickpixeliterator/synciterator.xml | 10 +- reference/imagick/ini.xml | 22 +- reference/imagick/setup.xml | 16 +- reference/inotify/book.xml | 2 +- .../inotify/functions/inotify-add-watch.xml | 2 +- reference/inotify/functions/inotify-init.xml | 2 +- .../inotify/functions/inotify-queue-len.xml | 2 +- reference/inotify/functions/inotify-read.xml | 2 +- .../inotify/functions/inotify-rm-watch.xml | 2 +- reference/inotify/setup.xml | 2 +- reference/lua/book.xml | 2 +- reference/lua/configure.xml | 2 +- reference/lua/lua.xml | 2 +- reference/lua/lua/assign.xml | 2 +- reference/lua/lua/call.xml | 2 +- reference/lua/lua/construct.xml | 2 +- reference/lua/lua/eval.xml | 2 +- reference/lua/lua/getversion.xml | 2 +- reference/lua/lua/include.xml | 2 +- reference/lua/lua/registercallback.xml | 2 +- reference/lua/luaclosure.xml | 2 +- reference/lua/luaclosure/invoke.xml | 2 +- reference/lua/luaexception.xml | 2 +- reference/lua/setup.xml | 2 +- reference/luasandbox/book.xml | 2 +- reference/luasandbox/configure.xml | 2 +- reference/luasandbox/differences.xml | 2 +- reference/luasandbox/examples.xml | 2 +- reference/luasandbox/luasandbox.xml | 2 +- .../luasandbox/luasandbox/callfunction.xml | 2 +- .../luasandbox/luasandbox/disableprofiler.xml | 2 +- .../luasandbox/luasandbox/enableprofiler.xml | 2 +- .../luasandbox/luasandbox/getcpuusage.xml | 2 +- .../luasandbox/luasandbox/getmemoryusage.xml | 2 +- .../luasandbox/getpeakmemoryusage.xml | 2 +- .../luasandbox/getprofilerfunctionreport.xml | 2 +- .../luasandbox/luasandbox/getversioninfo.xml | 2 +- .../luasandbox/luasandbox/loadbinary.xml | 2 +- .../luasandbox/luasandbox/loadstring.xml | 2 +- .../luasandbox/luasandbox/pauseusagetimer.xml | 2 +- .../luasandbox/luasandbox/registerlibrary.xml | 2 +- .../luasandbox/luasandbox/setcpulimit.xml | 4 +- .../luasandbox/luasandbox/setmemorylimit.xml | 4 +- .../luasandbox/unpauseusagetimer.xml | 2 +- .../luasandbox/luasandbox/wrapphpfunction.xml | 4 +- reference/luasandbox/luasandboxerror.xml | 2 +- reference/luasandbox/luasandboxerrorerror.xml | 2 +- reference/luasandbox/luasandboxfatalerror.xml | 2 +- reference/luasandbox/luasandboxfunction.xml | 2 +- .../luasandbox/luasandboxfunction/call.xml | 4 +- .../luasandboxfunction/construct.xml | 2 +- .../luasandbox/luasandboxfunction/dump.xml | 2 +- .../luasandbox/luasandboxmemoryerror.xml | 2 +- .../luasandbox/luasandboxruntimeerror.xml | 2 +- .../luasandbox/luasandboxsyntaxerror.xml | 2 +- .../luasandbox/luasandboxtimeouterror.xml | 2 +- reference/luasandbox/setup.xml | 2 +- reference/lzf/book.xml | 2 +- reference/lzf/configure.xml | 2 +- reference/lzf/functions/lzf-compress.xml | 2 +- reference/lzf/functions/lzf-decompress.xml | 2 +- reference/lzf/functions/lzf-optimized-for.xml | 2 +- reference/mailparse/book.xml | 2 +- reference/mailparse/configure.xml | 2 +- ...mailparse-determine-best-xfer-encoding.xml | 2 +- .../functions/mailparse-msg-create.xml | 2 +- .../mailparse-msg-extract-part-file.xml | 2 +- .../functions/mailparse-msg-extract-part.xml | 2 +- .../mailparse-msg-extract-whole-part-file.xml | 2 +- .../functions/mailparse-msg-free.xml | 2 +- .../functions/mailparse-msg-get-part-data.xml | 2 +- .../functions/mailparse-msg-get-part.xml | 2 +- .../functions/mailparse-msg-get-structure.xml | 2 +- .../functions/mailparse-msg-parse-file.xml | 2 +- .../functions/mailparse-msg-parse.xml | 2 +- .../mailparse-rfc822-parse-addresses.xml | 2 +- .../functions/mailparse-stream-encode.xml | 2 +- .../functions/mailparse-uudecode-all.xml | 2 +- reference/mailparse/setup.xml | 2 +- reference/mcrypt/book.xml | 2 +- reference/mcrypt/ciphers.xml | 2 +- reference/mcrypt/configure.xml | 2 +- reference/mcrypt/constants.xml | 28 +- .../mcrypt/functions/mcrypt-create-iv.xml | 2 +- reference/mcrypt/functions/mcrypt-decrypt.xml | 2 +- .../mcrypt-enc-get-algorithms-name.xml | 2 +- .../functions/mcrypt-enc-get-block-size.xml | 2 +- .../functions/mcrypt-enc-get-iv-size.xml | 2 +- .../functions/mcrypt-enc-get-key-size.xml | 2 +- .../functions/mcrypt-enc-get-modes-name.xml | 2 +- .../mcrypt-enc-get-supported-key-sizes.xml | 2 +- .../mcrypt-enc-is-block-algorithm-mode.xml | 2 +- .../mcrypt-enc-is-block-algorithm.xml | 2 +- .../functions/mcrypt-enc-is-block-mode.xml | 2 +- .../mcrypt/functions/mcrypt-enc-self-test.xml | 2 +- reference/mcrypt/functions/mcrypt-encrypt.xml | 2 +- .../functions/mcrypt-generic-deinit.xml | 2 +- .../mcrypt/functions/mcrypt-generic-init.xml | 2 +- reference/mcrypt/functions/mcrypt-generic.xml | 2 +- .../functions/mcrypt-get-block-size.xml | 2 +- .../functions/mcrypt-get-cipher-name.xml | 2 +- .../mcrypt/functions/mcrypt-get-iv-size.xml | 2 +- .../mcrypt/functions/mcrypt-get-key-size.xml | 2 +- .../functions/mcrypt-list-algorithms.xml | 2 +- .../mcrypt/functions/mcrypt-list-modes.xml | 2 +- .../mcrypt/functions/mcrypt-module-close.xml | 2 +- .../mcrypt-module-get-algo-block-size.xml | 2 +- .../mcrypt-module-get-algo-key-size.xml | 2 +- .../mcrypt-module-get-supported-key-sizes.xml | 2 +- .../mcrypt-module-is-block-algorithm-mode.xml | 2 +- .../mcrypt-module-is-block-algorithm.xml | 2 +- .../functions/mcrypt-module-is-block-mode.xml | 2 +- .../mcrypt/functions/mcrypt-module-open.xml | 2 +- .../functions/mcrypt-module-self-test.xml | 2 +- .../mcrypt/functions/mdecrypt-generic.xml | 2 +- reference/mcrypt/ini.xml | 2 +- reference/mcrypt/reference.xml | 2 +- reference/mcrypt/setup.xml | 2 +- reference/memcache/book.xml | 2 +- reference/memcache/configure.xml | 2 +- reference/memcache/examples.xml | 2 +- .../memcache/functions/memcache-debug.xml | 2 +- reference/memcache/ini.xml | 2 +- reference/memcache/memcache.xml | 2 +- reference/memcache/memcache/add.xml | 2 +- reference/memcache/memcache/addserver.xml | 2 +- reference/memcache/memcache/close.xml | 2 +- reference/memcache/memcache/connect.xml | 2 +- reference/memcache/memcache/decrement.xml | 2 +- reference/memcache/memcache/delete.xml | 2 +- reference/memcache/memcache/flush.xml | 2 +- reference/memcache/memcache/get.xml | 2 +- .../memcache/memcache/getextendedstats.xml | 2 +- .../memcache/memcache/getserverstatus.xml | 2 +- reference/memcache/memcache/getstats.xml | 2 +- reference/memcache/memcache/getversion.xml | 2 +- reference/memcache/memcache/increment.xml | 2 +- reference/memcache/memcache/pconnect.xml | 2 +- reference/memcache/memcache/replace.xml | 2 +- reference/memcache/memcache/set.xml | 2 +- .../memcache/setcompressthreshold.xml | 2 +- .../memcache/memcache/setserverparams.xml | 2 +- reference/memcache/setup.xml | 2 +- reference/memcached/book.xml | 12 +- reference/memcached/callbacks.xml | 8 +- reference/memcached/configure.xml | 20 +- reference/memcached/constants.xml | 208 ++++----- reference/memcached/expiration.xml | 10 +- reference/memcached/ini.xml | 140 +++--- reference/memcached/memcached.xml | 6 +- reference/memcached/memcached/add.xml | 20 +- reference/memcached/memcached/addbykey.xml | 24 +- reference/memcached/memcached/addserver.xml | 28 +- reference/memcached/memcached/addservers.xml | 16 +- reference/memcached/memcached/append.xml | 24 +- reference/memcached/memcached/appendbykey.xml | 24 +- reference/memcached/memcached/cas.xml | 30 +- reference/memcached/memcached/casbykey.xml | 28 +- reference/memcached/memcached/construct.xml | 12 +- reference/memcached/memcached/decrement.xml | 24 +- .../memcached/memcached/decrementbykey.xml | 28 +- reference/memcached/memcached/delete.xml | 16 +- reference/memcached/memcached/deletebykey.xml | 20 +- reference/memcached/memcached/deletemulti.xml | 12 +- .../memcached/memcached/deletemultibykey.xml | 16 +- reference/memcached/memcached/fetch.xml | 8 +- reference/memcached/memcached/fetchall.xml | 8 +- reference/memcached/memcached/flush.xml | 12 +- reference/memcached/memcached/get.xml | 24 +- reference/memcached/memcached/getallkeys.xml | 12 +- reference/memcached/memcached/getbykey.xml | 24 +- reference/memcached/memcached/getdelayed.xml | 24 +- .../memcached/memcached/getdelayedbykey.xml | 24 +- reference/memcached/memcached/getmulti.xml | 24 +- .../memcached/memcached/getmultibykey.xml | 20 +- reference/memcached/memcached/getoption.xml | 12 +- .../memcached/memcached/getresultcode.xml | 8 +- .../memcached/memcached/getresultmessage.xml | 8 +- .../memcached/memcached/getserverbykey.xml | 12 +- .../memcached/memcached/getserverlist.xml | 8 +- reference/memcached/memcached/getstats.xml | 12 +- reference/memcached/memcached/getversion.xml | 8 +- reference/memcached/memcached/increment.xml | 24 +- .../memcached/memcached/incrementbykey.xml | 28 +- .../memcached/memcached/ispersistent.xml | 8 +- reference/memcached/memcached/ispristine.xml | 8 +- reference/memcached/memcached/prepend.xml | 24 +- .../memcached/memcached/prependbykey.xml | 24 +- reference/memcached/memcached/quit.xml | 8 +- reference/memcached/memcached/replace.xml | 20 +- .../memcached/memcached/replacebykey.xml | 24 +- .../memcached/memcached/resetserverlist.xml | 8 +- reference/memcached/memcached/set.xml | 24 +- reference/memcached/memcached/setbykey.xml | 24 +- reference/memcached/memcached/setmulti.xml | 16 +- .../memcached/memcached/setmultibykey.xml | 20 +- reference/memcached/memcached/setoption.xml | 16 +- reference/memcached/memcached/setoptions.xml | 12 +- .../memcached/memcached/setsaslauthdata.xml | 20 +- reference/memcached/memcached/touch.xml | 16 +- reference/memcached/memcached/touchbykey.xml | 20 +- reference/memcached/memcachedexception.xml | 12 +- reference/memcached/sessions.xml | 12 +- reference/memcached/setup.xml | 8 +- reference/mongodb/architecture.xml | 8 +- reference/mongodb/bson/binary/construct.xml | 8 +- .../mongodb/bson/binary/getvectortype.xml | 2 +- reference/mongodb/bson/binary/toarray.xml | 2 +- .../mongodb/bson/decimal128/construct.xml | 2 +- reference/mongodb/bson/document/frombson.xml | 2 +- reference/mongodb/bson/document/fromjson.xml | 2 +- reference/mongodb/bson/document/get.xml | 2 +- .../mongodb/bson/document/getiterator.xml | 2 +- reference/mongodb/bson/document/offsetget.xml | 2 +- reference/mongodb/bson/document/offsetset.xml | 2 +- .../mongodb/bson/document/offsetunset.xml | 2 +- reference/mongodb/bson/document/tophp.xml | 2 +- reference/mongodb/bson/int64/construct.xml | 2 +- reference/mongodb/bson/iterator/current.xml | 2 +- reference/mongodb/bson/iterator/key.xml | 2 +- .../mongodb/bson/javascript/construct.xml | 4 +- reference/mongodb/bson/maxkey/construct.xml | 2 +- reference/mongodb/bson/minkey/construct.xml | 2 +- reference/mongodb/bson/objectid/construct.xml | 2 +- .../mongodb/bson/packedarray/fromjson.xml | 2 +- .../mongodb/bson/packedarray/fromphp.xml | 2 +- reference/mongodb/bson/packedarray/get.xml | 2 +- .../mongodb/bson/packedarray/getiterator.xml | 2 +- .../mongodb/bson/packedarray/offsetget.xml | 2 +- .../mongodb/bson/packedarray/offsetset.xml | 2 +- .../mongodb/bson/packedarray/offsetunset.xml | 2 +- reference/mongodb/bson/packedarray/tophp.xml | 2 +- reference/mongodb/bson/regex/construct.xml | 4 +- reference/mongodb/exceptions.xml | 32 +- reference/mongodb/functions/bson/fromjson.xml | 2 +- reference/mongodb/functions/bson/fromphp.xml | 2 +- reference/mongodb/functions/bson/tophp.xml | 6 +- .../mongodb/mongodb/driver/bulkwrite.xml | 4 +- .../mongodb/driver/bulkwritecommand.xml | 6 +- .../driver/clientencryption/addkeyaltname.xml | 2 +- .../driver/clientencryption/construct.xml | 2 +- .../driver/clientencryption/createdatakey.xml | 2 +- .../driver/clientencryption/decrypt.xml | 2 +- .../driver/clientencryption/deletekey.xml | 2 +- .../driver/clientencryption/encrypt.xml | 2 +- .../clientencryption/encryptexpression.xml | 2 +- .../driver/clientencryption/getkey.xml | 2 +- .../clientencryption/getkeybyaltname.xml | 2 +- .../driver/clientencryption/getkeys.xml | 2 +- .../clientencryption/removekeyaltname.xml | 2 +- .../clientencryption/rewrapmanydatakey.xml | 4 +- reference/mongodb/mongodb/driver/cursor.xml | 2 +- .../mongodb/mongodb/driver/cursor/rewind.xml | 2 +- .../mongodb/driver/cursor/settypemap.xml | 2 +- .../exception/bulkwritecommandexception.xml | 4 +- .../getwriteconcernerrors.xml | 4 +- .../getwriteerrors.xml | 4 +- .../driver/exception/bulkwriteexception.xml | 4 +- .../exception/executiontimeoutexception.xml | 4 +- .../exception/sslconnectionexception.xml | 2 +- .../driver/exception/writeexception.xml | 6 +- .../mongodb/driver/manager/addsubscriber.xml | 2 +- .../mongodb/driver/manager/construct.xml | 2 +- .../driver/manager/createclientencryption.xml | 2 +- .../driver/manager/executebulkwrite.xml | 12 +- .../manager/executebulkwritecommand.xml | 6 +- .../mongodb/driver/manager/executecommand.xml | 6 +- .../mongodb/driver/manager/executequery.xml | 4 +- .../driver/manager/executereadcommand.xml | 2 +- .../manager/executereadwritecommand.xml | 4 +- .../driver/manager/executewritecommand.xml | 4 +- .../mongodb/driver/manager/selectserver.xml | 2 +- .../mongodb/driver/manager/startsession.xml | 4 +- .../commandfailedevent/geterror.xml | 2 +- .../serverheartbeatfailedevent/geterror.xml | 2 +- .../driver/readpreference/construct.xml | 6 +- .../driver/server/executebulkwrite.xml | 12 +- .../driver/server/executebulkwritecommand.xml | 6 +- .../mongodb/driver/server/executecommand.xml | 4 +- .../mongodb/driver/server/executequery.xml | 2 +- .../driver/server/executereadcommand.xml | 2 +- .../driver/server/executereadwritecommand.xml | 4 +- .../driver/server/executewritecommand.xml | 4 +- .../driver/session/aborttransaction.xml | 2 +- .../driver/session/committransaction.xml | 4 +- .../driver/session/starttransaction.xml | 4 +- .../mongodb/driver/writeconcern/construct.xml | 4 +- .../mongodb/driver/writeconcernerror.xml | 2 +- .../mongodb/mongodb/driver/writeerror.xml | 2 +- .../mongodb/mongodb/driver/writeresult.xml | 4 +- .../writeresult/getwriteconcernerror.xml | 2 +- .../driver/writeresult/getwriteerrors.xml | 4 +- reference/mqseries/book.xml | 2 +- reference/mqseries/configure.xml | 2 +- reference/mqseries/constants.xml | 2 +- .../mqseries/functions/mqseries-back.xml | 2 +- .../mqseries/functions/mqseries-begin.xml | 2 +- .../mqseries/functions/mqseries-close.xml | 2 +- .../mqseries/functions/mqseries-cmit.xml | 2 +- .../mqseries/functions/mqseries-conn.xml | 2 +- .../mqseries/functions/mqseries-connx.xml | 2 +- .../mqseries/functions/mqseries-disc.xml | 2 +- reference/mqseries/functions/mqseries-get.xml | 2 +- reference/mqseries/functions/mqseries-inq.xml | 2 +- .../mqseries/functions/mqseries-open.xml | 2 +- reference/mqseries/functions/mqseries-put.xml | 2 +- .../mqseries/functions/mqseries-put1.xml | 2 +- reference/mqseries/functions/mqseries-set.xml | 2 +- .../mqseries/functions/mqseries-strerror.xml | 2 +- reference/mqseries/resources.xml | 2 +- reference/mysql/book.xml | 2 +- reference/mysql/changelog.xml | 2 +- reference/mysql/configure.xml | 2 +- .../mysql/functions/mysql-affected-rows.xml | 2 +- .../mysql/functions/mysql-client-encoding.xml | 2 +- reference/mysql/functions/mysql-close.xml | 2 +- reference/mysql/functions/mysql-connect.xml | 2 +- reference/mysql/functions/mysql-create-db.xml | 2 +- reference/mysql/functions/mysql-data-seek.xml | 2 +- reference/mysql/functions/mysql-db-name.xml | 2 +- reference/mysql/functions/mysql-db-query.xml | 2 +- reference/mysql/functions/mysql-drop-db.xml | 2 +- reference/mysql/functions/mysql-errno.xml | 2 +- reference/mysql/functions/mysql-error.xml | 2 +- .../mysql/functions/mysql-escape-string.xml | 2 +- .../mysql/functions/mysql-fetch-array.xml | 2 +- .../mysql/functions/mysql-fetch-assoc.xml | 2 +- .../mysql/functions/mysql-fetch-field.xml | 2 +- .../mysql/functions/mysql-fetch-lengths.xml | 2 +- .../mysql/functions/mysql-fetch-object.xml | 2 +- reference/mysql/functions/mysql-fetch-row.xml | 2 +- .../mysql/functions/mysql-field-flags.xml | 2 +- reference/mysql/functions/mysql-field-len.xml | 2 +- .../mysql/functions/mysql-field-name.xml | 2 +- .../mysql/functions/mysql-field-seek.xml | 2 +- .../mysql/functions/mysql-field-table.xml | 2 +- .../mysql/functions/mysql-field-type.xml | 2 +- .../mysql/functions/mysql-free-result.xml | 2 +- .../mysql/functions/mysql-get-client-info.xml | 2 +- .../mysql/functions/mysql-get-host-info.xml | 2 +- .../mysql/functions/mysql-get-proto-info.xml | 2 +- .../mysql/functions/mysql-get-server-info.xml | 2 +- reference/mysql/functions/mysql-info.xml | 2 +- reference/mysql/functions/mysql-insert-id.xml | 2 +- reference/mysql/functions/mysql-list-dbs.xml | 2 +- .../mysql/functions/mysql-list-fields.xml | 2 +- .../mysql/functions/mysql-list-processes.xml | 2 +- .../mysql/functions/mysql-list-tables.xml | 2 +- .../mysql/functions/mysql-num-fields.xml | 2 +- reference/mysql/functions/mysql-num-rows.xml | 2 +- reference/mysql/functions/mysql-pconnect.xml | 2 +- reference/mysql/functions/mysql-ping.xml | 2 +- reference/mysql/functions/mysql-query.xml | 2 +- .../functions/mysql-real-escape-string.xml | 2 +- reference/mysql/functions/mysql-result.xml | 2 +- reference/mysql/functions/mysql-select-db.xml | 2 +- .../mysql/functions/mysql-set-charset.xml | 2 +- reference/mysql/functions/mysql-stat.xml | 2 +- reference/mysql/functions/mysql-tablename.xml | 2 +- reference/mysql/functions/mysql-thread-id.xml | 2 +- .../functions/mysql-unbuffered-query.xml | 2 +- reference/mysql/ini.xml | 2 +- reference/mysql/reference.xml | 2 +- reference/mysql/setup.xml | 2 +- reference/mysql_xdevapi/book.xml | 12 +- reference/mysql_xdevapi/changelog.xml | 18 +- reference/mysql_xdevapi/examples.xml | 34 +- .../functions/mysql-xdevapi.expression.xml | 16 +- .../functions/mysql-xdevapi.getsession.xml | 96 ++--- reference/mysql_xdevapi/ini.xml | 36 +- .../mysql-xdevapi.baseresult.xml | 6 +- .../mysql_xdevapi/mysql-xdevapi.client.xml | 6 +- .../mysql-xdevapi.collection.xml | 12 +- .../mysql-xdevapi.collectionadd.xml | 8 +- .../mysql-xdevapi.collectionfind.xml | 8 +- .../mysql-xdevapi.collectionmodify.xml | 8 +- .../mysql-xdevapi.collectionremove.xml | 8 +- .../mysql-xdevapi.columnresult.xml | 6 +- .../mysql-xdevapi.crudoperationbindable.xml | 6 +- .../mysql-xdevapi.crudoperationlimitable.xml | 6 +- .../mysql-xdevapi.crudoperationskippable.xml | 6 +- .../mysql-xdevapi.crudoperationsortable.xml | 6 +- .../mysql-xdevapi.databaseobject.xml | 6 +- .../mysql_xdevapi/mysql-xdevapi.docresult.xml | 8 +- .../mysql_xdevapi/mysql-xdevapi.driver.xml | 6 +- .../mysql_xdevapi/mysql-xdevapi.exception.xml | 12 +- .../mysql-xdevapi.executable.xml | 6 +- .../mysql-xdevapi.executionstatus.xml | 18 +- .../mysql-xdevapi.expression.xml | 10 +- .../mysql-xdevapi.fieldmetadata.xml | 34 +- .../mysql_xdevapi/mysql-xdevapi.result.xml | 8 +- .../mysql_xdevapi/mysql-xdevapi.rowresult.xml | 8 +- .../mysql_xdevapi/mysql-xdevapi.schema.xml | 12 +- .../mysql-xdevapi.schemaobject.xml | 8 +- .../mysql_xdevapi/mysql-xdevapi.session.xml | 6 +- .../mysql-xdevapi.sqlstatement.xml | 10 +- .../mysql-xdevapi.sqlstatementresult.xml | 8 +- .../mysql_xdevapi/mysql-xdevapi.statement.xml | 8 +- .../mysql_xdevapi/mysql-xdevapi.table.xml | 6 +- .../mysql-xdevapi.tabledelete.xml | 4 +- .../mysql-xdevapi.tableinsert.xml | 4 +- .../mysql-xdevapi.tableselect.xml | 4 +- .../mysql-xdevapi.tableupdate.xml | 4 +- .../mysql_xdevapi/mysql-xdevapi.warning.xml | 14 +- .../mysql_xdevapi/baseresult/getwarnings.xml | 8 +- .../baseresult/getwarningscount.xml | 10 +- .../mysql_xdevapi/client/close.xml | 8 +- .../mysql_xdevapi/client/construct.xml | 4 +- .../mysql_xdevapi/client/getsession.xml | 8 +- .../mysql_xdevapi/collection/add.xml | 46 +- .../collection/addorreplaceone.xml | 58 +-- .../mysql_xdevapi/collection/construct.xml | 4 +- .../mysql_xdevapi/collection/count.xml | 14 +- .../mysql_xdevapi/collection/createindex.xml | 76 ++-- .../mysql_xdevapi/collection/dropindex.xml | 18 +- .../collection/existsindatabase.xml | 16 +- .../mysql_xdevapi/collection/find.xml | 20 +- .../mysql_xdevapi/collection/getname.xml | 10 +- .../mysql_xdevapi/collection/getone.xml | 16 +- .../mysql_xdevapi/collection/getschema.xml | 8 +- .../mysql_xdevapi/collection/getsession.xml | 8 +- .../mysql_xdevapi/collection/modify.xml | 24 +- .../mysql_xdevapi/collection/remove.xml | 24 +- .../mysql_xdevapi/collection/removeone.xml | 16 +- .../mysql_xdevapi/collection/replaceone.xml | 24 +- .../mysql_xdevapi/collectionadd/construct.xml | 12 +- .../mysql_xdevapi/collectionadd/execute.xml | 8 +- .../mysql_xdevapi/collectionfind/bind.xml | 14 +- .../collectionfind/construct.xml | 4 +- .../mysql_xdevapi/collectionfind/execute.xml | 8 +- .../mysql_xdevapi/collectionfind/fields.xml | 12 +- .../mysql_xdevapi/collectionfind/groupby.xml | 12 +- .../mysql_xdevapi/collectionfind/having.xml | 14 +- .../mysql_xdevapi/collectionfind/limit.xml | 12 +- .../collectionfind/lockexclusive.xml | 22 +- .../collectionfind/lockshared.xml | 28 +- .../mysql_xdevapi/collectionfind/offset.xml | 16 +- .../mysql_xdevapi/collectionfind/sort.xml | 12 +- .../collectionmodify/arrayappend.xml | 18 +- .../collectionmodify/arrayinsert.xml | 22 +- .../mysql_xdevapi/collectionmodify/bind.xml | 18 +- .../collectionmodify/construct.xml | 6 +- .../collectionmodify/execute.xml | 8 +- .../mysql_xdevapi/collectionmodify/limit.xml | 12 +- .../mysql_xdevapi/collectionmodify/patch.xml | 12 +- .../collectionmodify/replace.xml | 18 +- .../mysql_xdevapi/collectionmodify/set.xml | 18 +- .../mysql_xdevapi/collectionmodify/skip.xml | 12 +- .../mysql_xdevapi/collectionmodify/sort.xml | 12 +- .../mysql_xdevapi/collectionmodify/unset.xml | 12 +- .../mysql_xdevapi/collectionremove/bind.xml | 16 +- .../collectionremove/construct.xml | 4 +- .../collectionremove/execute.xml | 8 +- .../mysql_xdevapi/collectionremove/limit.xml | 12 +- .../mysql_xdevapi/collectionremove/sort.xml | 12 +- .../mysql_xdevapi/columnresult/construct.xml | 8 +- .../columnresult/getcharactersetname.xml | 10 +- .../columnresult/getcollationname.xml | 10 +- .../columnresult/getcolumnlabel.xml | 10 +- .../columnresult/getcolumnname.xml | 10 +- .../columnresult/getfractionaldigits.xml | 10 +- .../mysql_xdevapi/columnresult/getlength.xml | 10 +- .../columnresult/getschemaname.xml | 10 +- .../columnresult/gettablelabel.xml | 10 +- .../columnresult/gettablename.xml | 8 +- .../mysql_xdevapi/columnresult/gettype.xml | 10 +- .../columnresult/isnumbersigned.xml | 6 +- .../mysql_xdevapi/columnresult/ispadded.xml | 8 +- .../crudoperationbindable/bind.xml | 12 +- .../crudoperationlimitable/limit.xml | 12 +- .../crudoperationskippable/skip.xml | 12 +- .../crudoperationsortable/sort.xml | 12 +- .../databaseobject/existsindatabase.xml | 8 +- .../mysql_xdevapi/databaseobject/getname.xml | 8 +- .../databaseobject/getsession.xml | 8 +- .../mysql_xdevapi/docresult/construct.xml | 6 +- .../mysql_xdevapi/docresult/fetchall.xml | 8 +- .../mysql_xdevapi/docresult/fetchone.xml | 10 +- .../mysql_xdevapi/docresult/getwarnings.xml | 8 +- .../docresult/getwarningscount.xml | 10 +- .../mysql_xdevapi/executable/execute.xml | 8 +- .../executionstatus/construct.xml | 6 +- .../mysql_xdevapi/expression/construct.xml | 12 +- .../mysql_xdevapi/result/construct.xml | 4 +- .../result/getaffecteditemscount.xml | 8 +- .../result/getautoincrementvalue.xml | 8 +- .../mysql_xdevapi/result/getgeneratedids.xml | 12 +- .../mysql_xdevapi/result/getwarnings.xml | 8 +- .../mysql_xdevapi/result/getwarningscount.xml | 8 +- .../mysql_xdevapi/rowresult/construct.xml | 4 +- .../mysql_xdevapi/rowresult/fetchall.xml | 8 +- .../mysql_xdevapi/rowresult/fetchone.xml | 10 +- .../rowresult/getcolumncount.xml | 8 +- .../rowresult/getcolumnnames.xml | 10 +- .../mysql_xdevapi/rowresult/getcolumns.xml | 12 +- .../mysql_xdevapi/rowresult/getwarnings.xml | 8 +- .../rowresult/getwarningscount.xml | 8 +- .../mysql_xdevapi/schema/construct.xml | 4 +- .../mysql_xdevapi/schema/createcollection.xml | 16 +- .../mysql_xdevapi/schema/dropcollection.xml | 12 +- .../mysql_xdevapi/schema/existsindatabase.xml | 8 +- .../mysql_xdevapi/schema/getcollection.xml | 12 +- .../schema/getcollectionastable.xml | 16 +- .../mysql_xdevapi/schema/getcollections.xml | 8 +- .../mysql_xdevapi/schema/getname.xml | 8 +- .../mysql_xdevapi/schema/getsession.xml | 8 +- .../mysql_xdevapi/schema/gettable.xml | 12 +- .../mysql_xdevapi/schema/gettables.xml | 8 +- .../mysql_xdevapi/schemaobject/getschema.xml | 8 +- .../mysql_xdevapi/session/close.xml | 8 +- .../mysql_xdevapi/session/commit.xml | 8 +- .../mysql_xdevapi/session/construct.xml | 4 +- .../mysql_xdevapi/session/createschema.xml | 14 +- .../mysql_xdevapi/session/dropschema.xml | 20 +- .../mysql_xdevapi/session/generateuuid.xml | 10 +- .../session/getdefaultschema.xml | 10 +- .../mysql_xdevapi/session/getschema.xml | 12 +- .../mysql_xdevapi/session/getschemas.xml | 10 +- .../session/getserverversion.xml | 8 +- .../mysql_xdevapi/session/listclients.xml | 8 +- .../mysql_xdevapi/session/quotename.xml | 16 +- .../session/releasesavepoint.xml | 12 +- .../mysql_xdevapi/session/rollback.xml | 8 +- .../mysql_xdevapi/session/rollbackto.xml | 12 +- .../mysql_xdevapi/session/setsavepoint.xml | 16 +- .../mysql_xdevapi/session/sql.xml | 12 +- .../session/starttransaction.xml | 8 +- .../mysql_xdevapi/sqlstatement/bind.xml | 16 +- .../mysql_xdevapi/sqlstatement/construct.xml | 6 +- .../mysql_xdevapi/sqlstatement/execute.xml | 12 +- .../sqlstatement/getnextresult.xml | 12 +- .../mysql_xdevapi/sqlstatement/getresult.xml | 12 +- .../sqlstatement/hasmoreresults.xml | 10 +- .../sqlstatementresult/construct.xml | 6 +- .../sqlstatementresult/fetchall.xml | 10 +- .../sqlstatementresult/fetchone.xml | 8 +- .../getaffecteditemscount.xml | 12 +- .../sqlstatementresult/getcolumncount.xml | 10 +- .../sqlstatementresult/getcolumnnames.xml | 12 +- .../sqlstatementresult/getcolumns.xml | 12 +- .../sqlstatementresult/getgeneratedids.xml | 12 +- .../sqlstatementresult/getlastinsertid.xml | 10 +- .../sqlstatementresult/getwarnings.xml | 10 +- .../sqlstatementresult/getwarningscount.xml | 10 +- .../sqlstatementresult/hasdata.xml | 10 +- .../sqlstatementresult/nextresult.xml | 10 +- .../mysql_xdevapi/statement/construct.xml | 6 +- .../mysql_xdevapi/statement/getnextresult.xml | 12 +- .../mysql_xdevapi/statement/getresult.xml | 12 +- .../statement/hasmoreresults.xml | 12 +- .../mysql_xdevapi/table/construct.xml | 4 +- .../mysql_xdevapi/table/count.xml | 8 +- .../mysql_xdevapi/table/delete.xml | 8 +- .../mysql_xdevapi/table/existsindatabase.xml | 8 +- .../mysql_xdevapi/table/getname.xml | 8 +- .../mysql_xdevapi/table/getschema.xml | 8 +- .../mysql_xdevapi/table/getsession.xml | 8 +- .../mysql_xdevapi/table/insert.xml | 16 +- .../mysql_xdevapi/table/isview.xml | 8 +- .../mysql_xdevapi/table/select.xml | 16 +- .../mysql_xdevapi/table/update.xml | 8 +- .../mysql_xdevapi/tabledelete/bind.xml | 12 +- .../mysql_xdevapi/tabledelete/construct.xml | 4 +- .../mysql_xdevapi/tabledelete/execute.xml | 8 +- .../mysql_xdevapi/tabledelete/limit.xml | 12 +- .../mysql_xdevapi/tabledelete/orderby.xml | 12 +- .../mysql_xdevapi/tabledelete/where.xml | 12 +- .../mysql_xdevapi/tableinsert/construct.xml | 4 +- .../mysql_xdevapi/tableinsert/execute.xml | 8 +- .../mysql_xdevapi/tableinsert/values.xml | 12 +- .../mysql_xdevapi/tableselect/bind.xml | 12 +- .../mysql_xdevapi/tableselect/construct.xml | 6 +- .../mysql_xdevapi/tableselect/execute.xml | 8 +- .../mysql_xdevapi/tableselect/groupby.xml | 12 +- .../mysql_xdevapi/tableselect/having.xml | 12 +- .../mysql_xdevapi/tableselect/limit.xml | 12 +- .../tableselect/lockexclusive.xml | 18 +- .../mysql_xdevapi/tableselect/lockshared.xml | 20 +- .../mysql_xdevapi/tableselect/offset.xml | 12 +- .../mysql_xdevapi/tableselect/orderby.xml | 16 +- .../mysql_xdevapi/tableselect/where.xml | 12 +- .../mysql_xdevapi/tableupdate/bind.xml | 12 +- .../mysql_xdevapi/tableupdate/construct.xml | 4 +- .../mysql_xdevapi/tableupdate/execute.xml | 8 +- .../mysql_xdevapi/tableupdate/limit.xml | 12 +- .../mysql_xdevapi/tableupdate/orderby.xml | 16 +- .../mysql_xdevapi/tableupdate/set.xml | 16 +- .../mysql_xdevapi/tableupdate/where.xml | 12 +- .../mysql_xdevapi/warning/construct.xml | 6 +- reference/mysql_xdevapi/setup.xml | 76 ++-- reference/oauth/book.xml | 2 +- reference/oauth/configure.xml | 2 +- reference/oauth/constants.xml | 2 +- reference/oauth/examples.xml | 2 +- reference/oauth/functions/oauth-get-sbs.xml | 2 +- reference/oauth/functions/oauth-urlencode.xml | 2 +- reference/oauth/oauth.xml | 2 +- reference/oauth/oauth/construct.xml | 2 +- reference/oauth/oauth/destruct.xml | 2 +- reference/oauth/oauth/disabledebug.xml | 2 +- reference/oauth/oauth/disableredirects.xml | 2 +- reference/oauth/oauth/disablesslchecks.xml | 2 +- reference/oauth/oauth/enabledebug.xml | 2 +- reference/oauth/oauth/enableredirects.xml | 2 +- reference/oauth/oauth/enablesslchecks.xml | 2 +- reference/oauth/oauth/fetch.xml | 2 +- reference/oauth/oauth/generatesignature.xml | 2 +- reference/oauth/oauth/getaccesstoken.xml | 2 +- reference/oauth/oauth/getcapath.xml | 2 +- reference/oauth/oauth/getlastresponse.xml | 2 +- .../oauth/oauth/getlastresponseheaders.xml | 2 +- reference/oauth/oauth/getlastresponseinfo.xml | 2 +- reference/oauth/oauth/getrequestheader.xml | 2 +- reference/oauth/oauth/getrequesttoken.xml | 2 +- reference/oauth/oauth/setauthtype.xml | 2 +- reference/oauth/oauth/setcapath.xml | 2 +- reference/oauth/oauth/setnonce.xml | 2 +- reference/oauth/oauth/setrequestengine.xml | 6 +- reference/oauth/oauth/setrsacertificate.xml | 2 +- reference/oauth/oauth/setsslchecks.xml | 2 +- reference/oauth/oauth/settimestamp.xml | 2 +- reference/oauth/oauth/settoken.xml | 2 +- reference/oauth/oauth/setversion.xml | 2 +- reference/oauth/oauthexception.xml | 2 +- reference/oauth/oauthprovider.xml | 2 +- .../oauthprovider/addrequiredparameter.xml | 2 +- .../oauthprovider/callconsumerhandler.xml | 2 +- .../calltimestampnoncehandler.xml | 2 +- .../oauth/oauthprovider/calltokenhandler.xml | 2 +- .../oauth/oauthprovider/checkoauthrequest.xml | 2 +- reference/oauth/oauthprovider/construct.xml | 2 +- .../oauth/oauthprovider/consumerhandler.xml | 2 +- .../oauth/oauthprovider/generatetoken.xml | 2 +- .../oauth/oauthprovider/is2leggedendpoint.xml | 2 +- .../oauthprovider/isrequesttokenendpoint.xml | 2 +- .../oauthprovider/removerequiredparameter.xml | 2 +- .../oauth/oauthprovider/reportproblem.xml | 6 +- reference/oauth/oauthprovider/setparam.xml | 2 +- .../oauthprovider/setrequesttokenpath.xml | 2 +- .../oauthprovider/timestampnoncehandler.xml | 2 +- .../oauth/oauthprovider/tokenhandler.xml | 2 +- reference/oauth/setup.xml | 2 +- reference/openal/book.xml | 2 +- reference/openal/configure.xml | 2 +- .../openal/functions/openal-buffer-create.xml | 2 +- .../openal/functions/openal-buffer-data.xml | 2 +- .../functions/openal-buffer-destroy.xml | 2 +- .../openal/functions/openal-buffer-get.xml | 2 +- .../functions/openal-buffer-loadwav.xml | 2 +- .../functions/openal-context-create.xml | 2 +- .../functions/openal-context-current.xml | 2 +- .../functions/openal-context-destroy.xml | 2 +- .../functions/openal-context-process.xml | 2 +- .../functions/openal-context-suspend.xml | 2 +- .../openal/functions/openal-device-close.xml | 2 +- .../openal/functions/openal-device-open.xml | 2 +- .../openal/functions/openal-listener-get.xml | 2 +- .../openal/functions/openal-listener-set.xml | 2 +- .../openal/functions/openal-source-create.xml | 2 +- .../functions/openal-source-destroy.xml | 2 +- .../openal/functions/openal-source-get.xml | 2 +- .../openal/functions/openal-source-pause.xml | 2 +- .../openal/functions/openal-source-play.xml | 2 +- .../openal/functions/openal-source-rewind.xml | 2 +- .../openal/functions/openal-source-set.xml | 2 +- .../openal/functions/openal-source-stop.xml | 2 +- reference/openal/functions/openal-stream.xml | 2 +- reference/openal/resources.xml | 2 +- reference/parallel/book.xml | 2 +- reference/parallel/configure.xml | 2 +- reference/parallel/functional.xml | 2 +- .../parallel/functions/parallel.bootstrap.xml | 2 +- reference/parallel/functions/parallel.run.xml | 2 +- reference/parallel/parallel.channel.xml | 2 +- reference/parallel/parallel.events.event.xml | 2 +- reference/parallel/parallel.events.input.xml | 2 +- reference/parallel/parallel.events.xml | 2 +- reference/parallel/parallel.future.xml | 2 +- reference/parallel/parallel.runtime.xml | 2 +- reference/parallel/parallel.sync.xml | 2 +- reference/parallel/parallel/channel/close.xml | 2 +- .../parallel/parallel/channel/construct.xml | 2 +- reference/parallel/parallel/channel/make.xml | 2 +- reference/parallel/parallel/channel/open.xml | 2 +- reference/parallel/parallel/channel/recv.xml | 2 +- reference/parallel/parallel/channel/send.xml | 2 +- .../parallel/parallel/events/addchannel.xml | 2 +- .../parallel/parallel/events/addfuture.xml | 2 +- reference/parallel/parallel/events/poll.xml | 2 +- reference/parallel/parallel/events/remove.xml | 2 +- .../parallel/parallel/events/setblocking.xml | 2 +- .../parallel/parallel/events/setinput.xml | 2 +- .../parallel/parallel/events/settimeout.xml | 2 +- reference/parallel/parallel/future/cancel.xml | 2 +- .../parallel/parallel/future/cancelled.xml | 2 +- reference/parallel/parallel/future/done.xml | 2 +- reference/parallel/parallel/future/value.xml | 2 +- reference/parallel/parallel/input/add.xml | 2 +- reference/parallel/parallel/input/clear.xml | 2 +- reference/parallel/parallel/input/remove.xml | 2 +- reference/parallel/parallel/runtime/close.xml | 2 +- .../parallel/parallel/runtime/construct.xml | 2 +- reference/parallel/parallel/runtime/kill.xml | 2 +- reference/parallel/parallel/runtime/run.xml | 2 +- .../parallel/parallel/sync/construct.xml | 2 +- reference/parallel/parallel/sync/get.xml | 2 +- reference/parallel/parallel/sync/invoke.xml | 2 +- reference/parallel/parallel/sync/notify.xml | 2 +- reference/parallel/parallel/sync/set.xml | 2 +- reference/parallel/parallel/sync/wait.xml | 2 +- reference/parallel/philosophy.xml | 2 +- reference/parallel/setup.xml | 2 +- reference/parle/book.xml | 12 +- reference/parle/configure.xml | 6 +- reference/parle/examples.xml | 2 +- reference/parle/parle.errorinfo.xml | 14 +- reference/parle/parle.lexer.xml | 24 +- reference/parle/parle.lexerexception.xml | 12 +- reference/parle/parle.parser.xml | 24 +- reference/parle/parle.parserexception.xml | 12 +- reference/parle/parle.rlexer.xml | 24 +- reference/parle/parle.rparser.xml | 24 +- reference/parle/parle.stack.xml | 12 +- reference/parle/parle.token.xml | 14 +- reference/parle/parle/lexer/advance.xml | 10 +- reference/parle/parle/lexer/build.xml | 10 +- reference/parle/parle/lexer/callout.xml | 18 +- reference/parle/parle/lexer/consume.xml | 18 +- reference/parle/parle/lexer/dump.xml | 12 +- reference/parle/parle/lexer/gettoken.xml | 10 +- reference/parle/parle/lexer/insertmacro.xml | 18 +- reference/parle/parle/lexer/push.xml | 18 +- reference/parle/parle/lexer/reset.xml | 14 +- reference/parle/parle/parser/advance.xml | 10 +- reference/parle/parle/parser/build.xml | 10 +- reference/parle/parle/parser/consume.xml | 22 +- reference/parle/parle/parser/dump.xml | 10 +- reference/parle/parle/parser/errorinfo.xml | 8 +- reference/parle/parle/parser/left.xml | 12 +- reference/parle/parle/parser/nonassoc.xml | 12 +- reference/parle/parle/parser/precedence.xml | 12 +- reference/parle/parle/parser/push.xml | 16 +- reference/parle/parle/parser/reset.xml | 14 +- reference/parle/parle/parser/right.xml | 12 +- reference/parle/parle/parser/sigil.xml | 14 +- reference/parle/parle/parser/sigilcount.xml | 8 +- reference/parle/parle/parser/sigilname.xml | 14 +- reference/parle/parle/parser/token.xml | 12 +- reference/parle/parle/parser/tokenid.xml | 14 +- reference/parle/parle/parser/trace.xml | 10 +- reference/parle/parle/parser/validate.xml | 16 +- reference/parle/parle/rlexer/advance.xml | 10 +- reference/parle/parle/rlexer/build.xml | 10 +- reference/parle/parle/rlexer/callout.xml | 18 +- reference/parle/parle/rlexer/consume.xml | 18 +- reference/parle/parle/rlexer/dump.xml | 12 +- reference/parle/parle/rlexer/gettoken.xml | 10 +- reference/parle/parle/rlexer/insertmacro.xml | 18 +- reference/parle/parle/rlexer/push.xml | 38 +- reference/parle/parle/rlexer/pushstate.xml | 16 +- reference/parle/parle/rlexer/reset.xml | 14 +- reference/parle/parle/rparser/advance.xml | 10 +- reference/parle/parle/rparser/build.xml | 10 +- reference/parle/parle/rparser/consume.xml | 22 +- reference/parle/parle/rparser/dump.xml | 10 +- reference/parle/parle/rparser/errorinfo.xml | 8 +- reference/parle/parle/rparser/left.xml | 12 +- reference/parle/parle/rparser/nonassoc.xml | 12 +- reference/parle/parle/rparser/precedence.xml | 12 +- reference/parle/parle/rparser/push.xml | 16 +- reference/parle/parle/rparser/reset.xml | 14 +- reference/parle/parle/rparser/right.xml | 12 +- reference/parle/parle/rparser/sigil.xml | 14 +- reference/parle/parle/rparser/sigilcount.xml | 8 +- reference/parle/parle/rparser/sigilname.xml | 14 +- reference/parle/parle/rparser/token.xml | 12 +- reference/parle/parle/rparser/tokenid.xml | 14 +- reference/parle/parle/rparser/trace.xml | 10 +- reference/parle/parle/rparser/validate.xml | 16 +- reference/parle/parle/stack/pop.xml | 10 +- reference/parle/parle/stack/push.xml | 14 +- reference/parle/pattern.matching.xml | 8 +- reference/parle/setup.xml | 12 +- reference/pdo_cubrid/configure.xml | 2 +- .../pdo_overloaded/cubrid-schema.xml | 2 +- reference/pdo_cubrid/reference.xml | 6 +- reference/pdo_ibm/configure.xml | 26 +- reference/pdo_ibm/ini.xml | 16 +- reference/pdo_ibm/reference.xml | 36 +- reference/pdo_informix/configure.xml | 4 +- reference/pdo_informix/reference.xml | 16 +- reference/pdo_sqlsrv/configure.xml | 2 +- reference/pdo_sqlsrv/constants.xml | 58 +-- reference/pdo_sqlsrv/reference.xml | 6 +- reference/ps/book.xml | 14 +- reference/ps/configure.xml | 4 +- reference/ps/functions/ps-add-bookmark.xml | 24 +- reference/ps/functions/ps-add-launchlink.xml | 32 +- reference/ps/functions/ps-add-locallink.xml | 40 +- reference/ps/functions/ps-add-note.xml | 44 +- reference/ps/functions/ps-add-pdflink.xml | 44 +- reference/ps/functions/ps-add-weblink.xml | 34 +- reference/ps/functions/ps-arc.xml | 34 +- reference/ps/functions/ps-arcn.xml | 34 +- reference/ps/functions/ps-begin-page.xml | 36 +- reference/ps/functions/ps-begin-pattern.xml | 32 +- reference/ps/functions/ps-begin-template.xml | 20 +- reference/ps/functions/ps-circle.xml | 26 +- reference/ps/functions/ps-clip.xml | 12 +- reference/ps/functions/ps-close-image.xml | 16 +- reference/ps/functions/ps-close.xml | 20 +- .../ps/functions/ps-closepath-stroke.xml | 12 +- reference/ps/functions/ps-closepath.xml | 12 +- reference/ps/functions/ps-continue-text.xml | 16 +- reference/ps/functions/ps-curveto.xml | 36 +- reference/ps/functions/ps-delete.xml | 12 +- reference/ps/functions/ps-end-page.xml | 12 +- reference/ps/functions/ps-end-pattern.xml | 12 +- reference/ps/functions/ps-end-template.xml | 12 +- reference/ps/functions/ps-fill-stroke.xml | 14 +- reference/ps/functions/ps-fill.xml | 12 +- reference/ps/functions/ps-findfont.xml | 40 +- reference/ps/functions/ps-get-buffer.xml | 8 +- reference/ps/functions/ps-get-parameter.xml | 68 +-- reference/ps/functions/ps-get-value.xml | 128 +++--- reference/ps/functions/ps-hyphenate.xml | 16 +- reference/ps/functions/ps-include-file.xml | 12 +- reference/ps/functions/ps-lineto.xml | 20 +- reference/ps/functions/ps-makespotcolor.xml | 20 +- reference/ps/functions/ps-moveto.xml | 20 +- reference/ps/functions/ps-new.xml | 8 +- reference/ps/functions/ps-open-file.xml | 16 +- reference/ps/functions/ps-open-image-file.xml | 28 +- reference/ps/functions/ps-open-image.xml | 48 +-- .../ps/functions/ps-open-memory-image.xml | 8 +- reference/ps/functions/ps-place-image.xml | 30 +- reference/ps/functions/ps-rect.xml | 28 +- reference/ps/functions/ps-restore.xml | 12 +- reference/ps/functions/ps-rotate.xml | 24 +- reference/ps/functions/ps-save.xml | 12 +- reference/ps/functions/ps-scale.xml | 20 +- .../ps/functions/ps-set-border-color.xml | 24 +- reference/ps/functions/ps-set-border-dash.xml | 20 +- .../ps/functions/ps-set-border-style.xml | 22 +- reference/ps/functions/ps-set-info.xml | 32 +- reference/ps/functions/ps-set-parameter.xml | 20 +- reference/ps/functions/ps-set-text-pos.xml | 24 +- reference/ps/functions/ps-set-value.xml | 36 +- reference/ps/functions/ps-setcolor.xml | 44 +- reference/ps/functions/ps-setdash.xml | 20 +- reference/ps/functions/ps-setflat.xml | 12 +- reference/ps/functions/ps-setfont.xml | 20 +- reference/ps/functions/ps-setgray.xml | 18 +- reference/ps/functions/ps-setlinecap.xml | 18 +- reference/ps/functions/ps-setlinejoin.xml | 16 +- reference/ps/functions/ps-setlinewidth.xml | 16 +- reference/ps/functions/ps-setmiterlimit.xml | 16 +- .../ps/functions/ps-setoverprintmode.xml | 12 +- reference/ps/functions/ps-setpolydash.xml | 20 +- reference/ps/functions/ps-shading-pattern.xml | 20 +- reference/ps/functions/ps-shading.xml | 32 +- reference/ps/functions/ps-shfill.xml | 16 +- reference/ps/functions/ps-show-boxed.xml | 96 ++--- reference/ps/functions/ps-show-xy.xml | 24 +- reference/ps/functions/ps-show-xy2.xml | 4 +- reference/ps/functions/ps-show.xml | 48 +-- reference/ps/functions/ps-show2.xml | 20 +- reference/ps/functions/ps-string-geometry.xml | 24 +- reference/ps/functions/ps-stringwidth.xml | 26 +- reference/ps/functions/ps-stroke.xml | 12 +- reference/ps/functions/ps-symbol-name.xml | 20 +- reference/ps/functions/ps-symbol-width.xml | 24 +- reference/ps/functions/ps-symbol.xml | 16 +- reference/ps/functions/ps-translate.xml | 28 +- reference/ps/reference.xml | 4 +- reference/ps/setup.xml | 8 +- reference/pthreads/book.xml | 2 +- reference/pthreads/collectable.xml | 2 +- reference/pthreads/collectable/isgarbage.xml | 2 +- reference/pthreads/configure.xml | 2 +- reference/pthreads/constants.xml | 2 +- reference/pthreads/pool.xml | 2 +- reference/pthreads/pool/collect.xml | 2 +- reference/pthreads/pool/construct.xml | 2 +- reference/pthreads/pool/resize.xml | 2 +- reference/pthreads/pool/shutdown.xml | 2 +- reference/pthreads/pool/submit.xml | 2 +- reference/pthreads/pool/submitTo.xml | 2 +- reference/pthreads/setup.xml | 2 +- reference/pthreads/thread.xml | 2 +- reference/pthreads/thread/getcreatorid.xml | 2 +- .../pthreads/thread/getcurrentthread.xml | 2 +- .../pthreads/thread/getcurrentthreadid.xml | 2 +- reference/pthreads/thread/getthreadid.xml | 2 +- reference/pthreads/thread/isjoined.xml | 2 +- reference/pthreads/thread/isstarted.xml | 2 +- reference/pthreads/thread/join.xml | 2 +- reference/pthreads/thread/start.xml | 2 +- reference/pthreads/threaded.xml | 2 +- reference/pthreads/threaded/chunk.xml | 2 +- reference/pthreads/threaded/count.xml | 2 +- reference/pthreads/threaded/extend.xml | 2 +- reference/pthreads/threaded/isrunning.xml | 2 +- reference/pthreads/threaded/isterminated.xml | 2 +- reference/pthreads/threaded/merge.xml | 2 +- reference/pthreads/threaded/notify.xml | 2 +- reference/pthreads/threaded/notifyone.xml | 2 +- reference/pthreads/threaded/pop.xml | 2 +- reference/pthreads/threaded/run.xml | 2 +- reference/pthreads/threaded/shift.xml | 2 +- reference/pthreads/threaded/synchronized.xml | 2 +- reference/pthreads/threaded/wait.xml | 2 +- reference/pthreads/worker.xml | 2 +- reference/pthreads/worker/collect.xml | 2 +- reference/pthreads/worker/getstacked.xml | 2 +- reference/pthreads/worker/isshutdown.xml | 2 +- reference/pthreads/worker/shutdown.xml | 2 +- reference/pthreads/worker/stack.xml | 2 +- reference/pthreads/worker/unstack.xml | 2 +- reference/quickhash/book.xml | 2 +- reference/quickhash/quickhashinthash.xml | 2 +- reference/quickhash/quickhashinthash/add.xml | 2 +- .../quickhash/quickhashinthash/construct.xml | 2 +- .../quickhash/quickhashinthash/delete.xml | 2 +- .../quickhash/quickhashinthash/exists.xml | 2 +- reference/quickhash/quickhashinthash/get.xml | 2 +- .../quickhash/quickhashinthash/getsize.xml | 2 +- .../quickhashinthash/loadfromfile.xml | 2 +- .../quickhashinthash/loadfromstring.xml | 2 +- .../quickhash/quickhashinthash/savetofile.xml | 2 +- .../quickhashinthash/savetostring.xml | 2 +- reference/quickhash/quickhashinthash/set.xml | 2 +- .../quickhash/quickhashinthash/update.xml | 2 +- reference/quickhash/quickhashintset.xml | 2 +- reference/quickhash/quickhashintset/add.xml | 2 +- .../quickhash/quickhashintset/construct.xml | 2 +- .../quickhash/quickhashintset/delete.xml | 2 +- .../quickhash/quickhashintset/exists.xml | 2 +- .../quickhash/quickhashintset/getsize.xml | 2 +- .../quickhashintset/loadfromfile.xml | 2 +- .../quickhashintset/loadfromstring.xml | 2 +- .../quickhash/quickhashintset/savetofile.xml | 2 +- .../quickhashintset/savetostring.xml | 2 +- .../quickhash/quickhashintstringhash.xml | 2 +- .../quickhash/quickhashintstringhash/add.xml | 2 +- .../quickhashintstringhash/construct.xml | 2 +- .../quickhashintstringhash/delete.xml | 2 +- .../quickhashintstringhash/exists.xml | 2 +- .../quickhash/quickhashintstringhash/get.xml | 2 +- .../quickhashintstringhash/getsize.xml | 2 +- .../quickhashintstringhash/loadfromfile.xml | 2 +- .../quickhashintstringhash/loadfromstring.xml | 2 +- .../quickhashintstringhash/savetofile.xml | 2 +- .../quickhashintstringhash/savetostring.xml | 2 +- .../quickhash/quickhashintstringhash/set.xml | 2 +- .../quickhashintstringhash/update.xml | 2 +- .../quickhash/quickhashstringinthash.xml | 2 +- .../quickhash/quickhashstringinthash/add.xml | 2 +- .../quickhashstringinthash/construct.xml | 2 +- .../quickhashstringinthash/delete.xml | 2 +- .../quickhashstringinthash/exists.xml | 2 +- .../quickhash/quickhashstringinthash/get.xml | 2 +- .../quickhashstringinthash/getsize.xml | 2 +- .../quickhashstringinthash/loadfromfile.xml | 2 +- .../quickhashstringinthash/loadfromstring.xml | 2 +- .../quickhashstringinthash/savetofile.xml | 2 +- .../quickhashstringinthash/savetostring.xml | 2 +- .../quickhash/quickhashstringinthash/set.xml | 2 +- .../quickhashstringinthash/update.xml | 2 +- reference/quickhash/setup.xml | 2 +- reference/radius/book.xml | 2 +- reference/radius/configure.xml | 2 +- reference/radius/constants.xml | 2 +- reference/radius/examples.xml | 2 +- .../radius/functions/radius-acct-open.xml | 2 +- .../radius/functions/radius-add-server.xml | 6 +- .../radius/functions/radius-auth-open.xml | 2 +- reference/radius/functions/radius-close.xml | 2 +- reference/radius/functions/radius-config.xml | 2 +- .../functions/radius-create-request.xml | 2 +- .../radius/functions/radius-cvt-addr.xml | 2 +- reference/radius/functions/radius-cvt-int.xml | 2 +- .../radius/functions/radius-cvt-string.xml | 2 +- .../functions/radius-demangle-mppe-key.xml | 2 +- .../radius/functions/radius-demangle.xml | 2 +- .../radius/functions/radius-get-attr.xml | 2 +- .../functions/radius-get-tagged-attr-data.xml | 2 +- .../functions/radius-get-tagged-attr-tag.xml | 2 +- .../radius/functions/radius-put-addr.xml | 2 +- .../radius/functions/radius-put-attr.xml | 2 +- reference/radius/functions/radius-put-int.xml | 2 +- .../radius/functions/radius-put-string.xml | 2 +- .../functions/radius-put-vendor-addr.xml | 2 +- .../functions/radius-put-vendor-attr.xml | 2 +- .../functions/radius-put-vendor-int.xml | 2 +- .../functions/radius-put-vendor-string.xml | 2 +- .../radius-request-authenticator.xml | 2 +- .../functions/radius-salt-encrypt-attr.xml | 2 +- .../radius/functions/radius-send-request.xml | 2 +- .../radius/functions/radius-server-secret.xml | 2 +- .../radius/functions/radius-strerror.xml | 2 +- reference/radius/reference.xml | 2 +- reference/rar/book.xml | 2 +- reference/rar/examples.xml | 2 +- .../rar/functions/rar-wrapper-cache-stats.xml | 2 +- reference/rar/rararchive.xml | 2 +- reference/rar/rararchive/close.xml | 2 +- reference/rar/rararchive/getcomment.xml | 2 +- reference/rar/rararchive/getentries.xml | 2 +- reference/rar/rararchive/getentry.xml | 2 +- reference/rar/rararchive/isbroken.xml | 2 +- reference/rar/rararchive/issolid.xml | 2 +- reference/rar/rararchive/open.xml | 2 +- reference/rar/rararchive/setallowbroken.xml | 2 +- reference/rar/rararchive/tostring.xml | 2 +- reference/rar/rarentry.xml | 2 +- reference/rar/rarentry/extract.xml | 2 +- reference/rar/rarentry/getattr.xml | 2 +- reference/rar/rarentry/getcrc.xml | 2 +- reference/rar/rarentry/getfiletime.xml | 2 +- reference/rar/rarentry/gethostos.xml | 2 +- reference/rar/rarentry/getmethod.xml | 2 +- reference/rar/rarentry/getname.xml | 2 +- reference/rar/rarentry/getpackedsize.xml | 2 +- reference/rar/rarentry/getstream.xml | 2 +- reference/rar/rarentry/getunpackedsize.xml | 2 +- reference/rar/rarentry/getversion.xml | 2 +- reference/rar/rarentry/isdirectory.xml | 2 +- reference/rar/rarentry/isencrypted.xml | 2 +- reference/rar/rarentry/tostring.xml | 2 +- reference/rar/rarexception.xml | 2 +- .../rar/rarexception/isusingexceptions.xml | 2 +- .../rar/rarexception/setusingexceptions.xml | 2 +- reference/rar/setup.xml | 2 +- reference/recode/book.xml | 2 +- reference/recode/configure.xml | 2 +- reference/recode/functions/recode-file.xml | 2 +- reference/recode/functions/recode-string.xml | 2 +- reference/recode/setup.xml | 2 +- reference/rnp/book.xml | 2 +- reference/rnp/configure.xml | 2 +- reference/rnp/constants.xml | 2 +- reference/rnp/examples.xml | 2 +- .../rnp/functions/rnp-backend-string.xml | 2 +- .../rnp/functions/rnp-backend-version.xml | 2 +- reference/rnp/functions/rnp-decrypt.xml | 2 +- .../functions/rnp-dump-packets-to-json.xml | 2 +- reference/rnp/functions/rnp-dump-packets.xml | 2 +- reference/rnp/functions/rnp-ffi-create.xml | 2 +- reference/rnp/functions/rnp-ffi-destroy.xml | 2 +- .../functions/rnp-ffi-set-pass-provider.xml | 2 +- reference/rnp/functions/rnp-import-keys.xml | 2 +- .../rnp/functions/rnp-import-signatures.xml | 2 +- .../functions/rnp-key-export-autocrypt.xml | 2 +- .../functions/rnp-key-export-revocation.xml | 2 +- reference/rnp/functions/rnp-key-export.xml | 2 +- reference/rnp/functions/rnp-key-get-info.xml | 2 +- reference/rnp/functions/rnp-key-remove.xml | 2 +- reference/rnp/functions/rnp-key-revoke.xml | 2 +- reference/rnp/functions/rnp-list-keys.xml | 2 +- .../rnp/functions/rnp-load-keys-from-path.xml | 2 +- reference/rnp/functions/rnp-load-keys.xml | 2 +- reference/rnp/functions/rnp-locate-key.xml | 2 +- reference/rnp/functions/rnp-op-encrypt.xml | 14 +- .../rnp/functions/rnp-op-generate-key.xml | 4 +- .../rnp/functions/rnp-op-sign-cleartext.xml | 2 +- .../rnp/functions/rnp-op-sign-detached.xml | 2 +- reference/rnp/functions/rnp-op-sign.xml | 8 +- .../rnp/functions/rnp-op-verify-detached.xml | 2 +- reference/rnp/functions/rnp-op-verify.xml | 2 +- .../rnp/functions/rnp-save-keys-to-path.xml | 2 +- reference/rnp/functions/rnp-save-keys.xml | 2 +- .../rnp/functions/rnp-supported-features.xml | 2 +- .../rnp/functions/rnp-version-string-full.xml | 2 +- .../rnp/functions/rnp-version-string.xml | 2 +- reference/rnp/rnpffi.xml | 2 +- reference/rnp/setup.xml | 2 +- reference/rrd/book.xml | 2 +- reference/rrd/configure.xml | 2 +- reference/rrd/examples.xml | 2 +- reference/rrd/functions/rrd-create.xml | 2 +- reference/rrd/functions/rrd-error.xml | 2 +- reference/rrd/functions/rrd-fetch.xml | 2 +- reference/rrd/functions/rrd-first.xml | 2 +- reference/rrd/functions/rrd-graph.xml | 2 +- reference/rrd/functions/rrd-info.xml | 2 +- reference/rrd/functions/rrd-last.xml | 2 +- reference/rrd/functions/rrd-lastupdate.xml | 2 +- reference/rrd/functions/rrd-restore.xml | 2 +- reference/rrd/functions/rrd-tune.xml | 2 +- reference/rrd/functions/rrd-update.xml | 2 +- reference/rrd/functions/rrd-version.xml | 2 +- reference/rrd/functions/rrd-xport.xml | 2 +- reference/rrd/functions/rrdc-disconnect.xml | 2 +- reference/rrd/rrdcreator.xml | 2 +- reference/rrd/rrdcreator/addarchive.xml | 2 +- reference/rrd/rrdcreator/adddatasource.xml | 2 +- reference/rrd/rrdcreator/construct.xml | 2 +- reference/rrd/rrdcreator/save.xml | 2 +- reference/rrd/rrdgraph.xml | 2 +- reference/rrd/rrdgraph/construct.xml | 2 +- reference/rrd/rrdgraph/save.xml | 2 +- reference/rrd/rrdgraph/saveverbose.xml | 2 +- reference/rrd/rrdgraph/setoptions.xml | 2 +- reference/rrd/rrdupdater.xml | 2 +- reference/rrd/rrdupdater/construct.xml | 2 +- reference/rrd/rrdupdater/update.xml | 4 +- reference/rrd/setup.xml | 2 +- reference/runkit7/constants.xml | 2 +- .../functions/runkit7-constant-add.xml | 2 +- .../functions/runkit7-constant-redefine.xml | 2 +- .../functions/runkit7-constant-remove.xml | 2 +- .../functions/runkit7-function-add.xml | 2 +- .../functions/runkit7-function-copy.xml | 2 +- .../functions/runkit7-function-redefine.xml | 2 +- .../functions/runkit7-function-remove.xml | 2 +- .../functions/runkit7-function-rename.xml | 2 +- .../runkit7/functions/runkit7-import.xml | 2 +- .../runkit7/functions/runkit7-method-add.xml | 2 +- .../runkit7/functions/runkit7-method-copy.xml | 2 +- .../functions/runkit7-method-redefine.xml | 2 +- .../functions/runkit7-method-remove.xml | 2 +- .../functions/runkit7-method-rename.xml | 2 +- .../runkit7/functions/runkit7-object-id.xml | 2 +- .../functions/runkit7-superglobals.xml | 2 +- .../functions/runkit7-zval-inspect.xml | 2 +- reference/runkit7/ini.xml | 2 +- reference/runkit7/setup.xml | 2 +- reference/scoutapm/book.xml | 2 +- reference/scoutapm/configure.xml | 2 +- .../scoutapm/functions/scoutapm-get-calls.xml | 2 +- .../scoutapm-list-instrumented-functions.xml | 2 +- reference/scoutapm/setup.xml | 2 +- reference/seaslog/book.xml | 2 +- reference/seaslog/configure.xml | 2 +- reference/seaslog/constants.xml | 2 +- reference/seaslog/examples.xml | 2 +- .../seaslog/functions/seaslog-get-author.xml | 2 +- .../seaslog/functions/seaslog-get-version.xml | 2 +- reference/seaslog/ini.xml | 2 +- reference/seaslog/seaslog.xml | 2 +- reference/seaslog/seaslog/alert.xml | 2 +- reference/seaslog/seaslog/analyzercount.xml | 2 +- reference/seaslog/seaslog/analyzerdetail.xml | 2 +- .../seaslog/seaslog/closeloggerstream.xml | 2 +- reference/seaslog/seaslog/construct.xml | 2 +- reference/seaslog/seaslog/critical.xml | 2 +- reference/seaslog/seaslog/debug.xml | 2 +- reference/seaslog/seaslog/destruct.xml | 2 +- reference/seaslog/seaslog/emergency.xml | 2 +- reference/seaslog/seaslog/error.xml | 2 +- reference/seaslog/seaslog/flushbuffer.xml | 2 +- reference/seaslog/seaslog/getbasepath.xml | 2 +- reference/seaslog/seaslog/getbuffer.xml | 2 +- .../seaslog/seaslog/getbufferenabled.xml | 2 +- .../seaslog/seaslog/getdatetimeformat.xml | 2 +- reference/seaslog/seaslog/getlastlogger.xml | 2 +- reference/seaslog/seaslog/getrequestid.xml | 2 +- .../seaslog/seaslog/getrequestvariable.xml | 2 +- reference/seaslog/seaslog/info.xml | 2 +- reference/seaslog/seaslog/log.xml | 2 +- reference/seaslog/seaslog/notice.xml | 2 +- reference/seaslog/seaslog/setbasepath.xml | 2 +- .../seaslog/seaslog/setdatetimeformat.xml | 2 +- reference/seaslog/seaslog/setlogger.xml | 2 +- reference/seaslog/seaslog/setrequestid.xml | 2 +- .../seaslog/seaslog/setrequestvariable.xml | 2 +- reference/seaslog/seaslog/warning.xml | 2 +- reference/seaslog/setup.xml | 2 +- reference/simdjson/book.xml | 2 +- reference/simdjson/constants.xml | 2 +- .../simdjson/functions/simdjson-decode.xml | 10 +- .../simdjson/functions/simdjson-is-valid.xml | 10 +- .../simdjson/functions/simdjson-key-count.xml | 4 +- .../functions/simdjson-key-exists.xml | 4 +- .../simdjson/functions/simdjson-key-value.xml | 8 +- reference/simdjson/setup.xml | 2 +- reference/simdjson/simdjsonexception.xml | 2 +- reference/simdjson/simdjsonvalueerror.xml | 8 +- reference/solr/book.xml | 36 +- reference/solr/examples.xml | 32 +- reference/solr/functions/solr-get-version.xml | 12 +- reference/solr/setup.xml | 36 +- reference/solr/solrclient.xml | 34 +- reference/solr/solrclient/adddocument.xml | 50 +-- reference/solr/solrclient/adddocuments.xml | 48 +-- reference/solr/solrclient/commit.xml | 58 +-- reference/solr/solrclient/construct.xml | 30 +- reference/solr/solrclient/deletebyid.xml | 26 +- reference/solr/solrclient/deletebyids.xml | 26 +- reference/solr/solrclient/deletebyqueries.xml | 26 +- reference/solr/solrclient/deletebyquery.xml | 28 +- reference/solr/solrclient/destruct.xml | 8 +- reference/solr/solrclient/getbyid.xml | 12 +- reference/solr/solrclient/getbyids.xml | 12 +- reference/solr/solrclient/getdebug.xml | 8 +- reference/solr/solrclient/getoptions.xml | 10 +- reference/solr/solrclient/optimize.xml | 50 +-- reference/solr/solrclient/ping.xml | 24 +- reference/solr/solrclient/query.xml | 26 +- reference/solr/solrclient/request.xml | 34 +- reference/solr/solrclient/rollback.xml | 10 +- .../solr/solrclient/setresponsewriter.xml | 22 +- reference/solr/solrclient/setservlet.xml | 18 +- reference/solr/solrclient/system.xml | 22 +- reference/solr/solrclient/threads.xml | 24 +- reference/solr/solrclientexception.xml | 12 +- .../solrclientexception/getinternalinfo.xml | 8 +- reference/solr/solrcollapsefunction.xml | 10 +- .../solr/solrcollapsefunction/construct.xml | 12 +- .../solr/solrcollapsefunction/getfield.xml | 10 +- .../solr/solrcollapsefunction/gethint.xml | 10 +- .../solr/solrcollapsefunction/getmax.xml | 10 +- .../solr/solrcollapsefunction/getmin.xml | 10 +- .../solrcollapsefunction/getnullpolicy.xml | 10 +- .../solr/solrcollapsefunction/getsize.xml | 12 +- .../solr/solrcollapsefunction/setfield.xml | 16 +- .../solr/solrcollapsefunction/sethint.xml | 14 +- .../solr/solrcollapsefunction/setmax.xml | 14 +- .../solr/solrcollapsefunction/setmin.xml | 14 +- .../solrcollapsefunction/setnullpolicy.xml | 14 +- .../solr/solrcollapsefunction/setsize.xml | 14 +- .../solr/solrcollapsefunction/tostring.xml | 10 +- reference/solr/solrdismaxquery.xml | 26 +- .../solrdismaxquery/addbigramphrasefield.xml | 28 +- .../solr/solrdismaxquery/addboostquery.xml | 30 +- .../solr/solrdismaxquery/addphrasefield.xml | 26 +- .../solr/solrdismaxquery/addqueryfield.xml | 18 +- .../solrdismaxquery/addtrigramphrasefield.xml | 22 +- .../solr/solrdismaxquery/adduserfield.xml | 14 +- reference/solr/solrdismaxquery/construct.xml | 24 +- .../removebigramphrasefield.xml | 14 +- .../solr/solrdismaxquery/removeboostquery.xml | 14 +- .../solrdismaxquery/removephrasefield.xml | 12 +- .../solr/solrdismaxquery/removequeryfield.xml | 16 +- .../removetrigramphrasefield.xml | 14 +- .../solr/solrdismaxquery/removeuserfield.xml | 12 +- .../solrdismaxquery/setbigramphrasefields.xml | 14 +- .../solrdismaxquery/setbigramphraseslop.xml | 16 +- .../solr/solrdismaxquery/setboostfunction.xml | 24 +- .../solr/solrdismaxquery/setboostquery.xml | 14 +- .../solr/solrdismaxquery/setminimummatch.xml | 16 +- .../solr/solrdismaxquery/setphrasefields.xml | 14 +- .../solr/solrdismaxquery/setphraseslop.xml | 18 +- .../solr/solrdismaxquery/setqueryalt.xml | 18 +- .../solrdismaxquery/setqueryphraseslop.xml | 18 +- .../solr/solrdismaxquery/settiebreaker.xml | 14 +- .../settrigramphrasefields.xml | 14 +- .../solrdismaxquery/settrigramphraseslop.xml | 14 +- .../solr/solrdismaxquery/setuserfields.xml | 28 +- .../solrdismaxquery/usedismaxqueryparser.xml | 10 +- .../solrdismaxquery/useedismaxqueryparser.xml | 10 +- reference/solr/solrdocument.xml | 22 +- reference/solr/solrdocument/addfield.xml | 16 +- reference/solr/solrdocument/clear.xml | 8 +- reference/solr/solrdocument/clone.xml | 8 +- reference/solr/solrdocument/construct.xml | 10 +- reference/solr/solrdocument/current.xml | 8 +- reference/solr/solrdocument/deletefield.xml | 14 +- reference/solr/solrdocument/destruct.xml | 10 +- reference/solr/solrdocument/fieldexists.xml | 12 +- reference/solr/solrdocument/get.xml | 14 +- .../solr/solrdocument/getchilddocuments.xml | 12 +- .../solrdocument/getchilddocumentscount.xml | 12 +- reference/solr/solrdocument/getfield.xml | 12 +- reference/solr/solrdocument/getfieldcount.xml | 10 +- reference/solr/solrdocument/getfieldnames.xml | 8 +- .../solr/solrdocument/getinputdocument.xml | 10 +- .../solr/solrdocument/haschilddocuments.xml | 12 +- reference/solr/solrdocument/isset.xml | 14 +- reference/solr/solrdocument/key.xml | 10 +- reference/solr/solrdocument/merge.xml | 18 +- reference/solr/solrdocument/next.xml | 10 +- reference/solr/solrdocument/offsetexists.xml | 12 +- reference/solr/solrdocument/offsetget.xml | 14 +- reference/solr/solrdocument/offsetset.xml | 16 +- reference/solr/solrdocument/offsetunset.xml | 14 +- reference/solr/solrdocument/reset.xml | 10 +- reference/solr/solrdocument/rewind.xml | 10 +- reference/solr/solrdocument/serialize.xml | 10 +- reference/solr/solrdocument/set.xml | 16 +- reference/solr/solrdocument/sort.xml | 28 +- reference/solr/solrdocument/toarray.xml | 10 +- reference/solr/solrdocument/unserialize.xml | 14 +- reference/solr/solrdocument/unset.xml | 14 +- reference/solr/solrdocument/valid.xml | 8 +- reference/solr/solrdocumentfield.xml | 14 +- .../solr/solrdocumentfield/construct.xml | 8 +- reference/solr/solrdocumentfield/destruct.xml | 10 +- reference/solr/solrexception.xml | 18 +- .../solr/solrexception/getinternalinfo.xml | 8 +- reference/solr/solrgenericresponse.xml | 16 +- .../solr/solrgenericresponse/construct.xml | 8 +- .../solr/solrgenericresponse/destruct.xml | 8 +- .../solr/solrillegalargumentexception.xml | 12 +- .../getinternalinfo.xml | 8 +- .../solr/solrillegaloperationexception.xml | 12 +- .../getinternalinfo.xml | 8 +- reference/solr/solrinputdocument.xml | 20 +- .../solrinputdocument/addchilddocument.xml | 26 +- .../solrinputdocument/addchilddocuments.xml | 26 +- reference/solr/solrinputdocument/addfield.xml | 20 +- reference/solr/solrinputdocument/clear.xml | 10 +- reference/solr/solrinputdocument/clone.xml | 10 +- .../solr/solrinputdocument/construct.xml | 8 +- .../solr/solrinputdocument/deletefield.xml | 12 +- reference/solr/solrinputdocument/destruct.xml | 10 +- .../solr/solrinputdocument/fieldexists.xml | 12 +- reference/solr/solrinputdocument/getboost.xml | 10 +- .../solrinputdocument/getchilddocuments.xml | 12 +- .../getchilddocumentscount.xml | 12 +- reference/solr/solrinputdocument/getfield.xml | 12 +- .../solr/solrinputdocument/getfieldboost.xml | 12 +- .../solr/solrinputdocument/getfieldcount.xml | 8 +- .../solr/solrinputdocument/getfieldnames.xml | 8 +- .../solrinputdocument/haschilddocuments.xml | 14 +- reference/solr/solrinputdocument/merge.xml | 16 +- reference/solr/solrinputdocument/reset.xml | 10 +- reference/solr/solrinputdocument/setboost.xml | 14 +- .../solr/solrinputdocument/setfieldboost.xml | 18 +- reference/solr/solrinputdocument/sort.xml | 32 +- reference/solr/solrinputdocument/toarray.xml | 10 +- ...solrmissingmandatoryparameterexception.xml | 8 +- reference/solr/solrmodifiableparams.xml | 12 +- .../solr/solrmodifiableparams/construct.xml | 8 +- .../solr/solrmodifiableparams/destruct.xml | 8 +- reference/solr/solrobject.xml | 8 +- reference/solr/solrobject/construct.xml | 8 +- reference/solr/solrobject/destruct.xml | 8 +- .../solr/solrobject/getpropertynames.xml | 8 +- reference/solr/solrobject/offsetexists.xml | 12 +- reference/solr/solrobject/offsetget.xml | 12 +- reference/solr/solrobject/offsetset.xml | 16 +- reference/solr/solrobject/offsetunset.xml | 12 +- reference/solr/solrparams.xml | 8 +- reference/solr/solrparams/add.xml | 18 +- reference/solr/solrparams/addparam.xml | 16 +- reference/solr/solrparams/get.xml | 12 +- reference/solr/solrparams/getparam.xml | 14 +- reference/solr/solrparams/getparams.xml | 8 +- .../solr/solrparams/getpreparedparams.xml | 8 +- reference/solr/solrparams/serialize.xml | 8 +- reference/solr/solrparams/set.xml | 16 +- reference/solr/solrparams/setparam.xml | 16 +- reference/solr/solrparams/tostring.xml | 12 +- reference/solr/solrparams/unserialize.xml | 12 +- reference/solr/solrpingresponse.xml | 38 +- reference/solr/solrpingresponse/construct.xml | 10 +- reference/solr/solrpingresponse/destruct.xml | 8 +- .../solr/solrpingresponse/getresponse.xml | 8 +- reference/solr/solrquery.xml | 26 +- .../solr/solrquery/addexpandfilterquery.xml | 16 +- .../solr/solrquery/addexpandsortfield.xml | 20 +- .../solr/solrquery/addfacetdatefield.xml | 14 +- .../solr/solrquery/addfacetdateother.xml | 18 +- reference/solr/solrquery/addfacetfield.xml | 12 +- reference/solr/solrquery/addfacetquery.xml | 14 +- reference/solr/solrquery/addfield.xml | 14 +- reference/solr/solrquery/addfilterquery.xml | 12 +- reference/solr/solrquery/addgroupfield.xml | 14 +- reference/solr/solrquery/addgroupfunction.xml | 14 +- reference/solr/solrquery/addgroupquery.xml | 14 +- .../solr/solrquery/addgroupsortfield.xml | 22 +- .../solr/solrquery/addhighlightfield.xml | 12 +- reference/solr/solrquery/addmltfield.xml | 12 +- reference/solr/solrquery/addmltqueryfield.xml | 16 +- reference/solr/solrquery/addsortfield.xml | 18 +- reference/solr/solrquery/addstatsfacet.xml | 12 +- reference/solr/solrquery/addstatsfield.xml | 12 +- reference/solr/solrquery/collapse.xml | 20 +- reference/solr/solrquery/construct.xml | 20 +- reference/solr/solrquery/destruct.xml | 8 +- reference/solr/solrquery/getexpand.xml | 8 +- .../solr/solrquery/getexpandfilterqueries.xml | 10 +- reference/solr/solrquery/getexpandquery.xml | 8 +- reference/solr/solrquery/getexpandrows.xml | 8 +- .../solr/solrquery/getexpandsortfields.xml | 8 +- reference/solr/solrquery/getfacet.xml | 8 +- reference/solr/solrquery/getfacetdateend.xml | 12 +- .../solr/solrquery/getfacetdatefields.xml | 8 +- reference/solr/solrquery/getfacetdategap.xml | 12 +- .../solr/solrquery/getfacetdatehardend.xml | 12 +- .../solr/solrquery/getfacetdateother.xml | 12 +- .../solr/solrquery/getfacetdatestart.xml | 14 +- reference/solr/solrquery/getfacetfields.xml | 8 +- reference/solr/solrquery/getfacetlimit.xml | 14 +- reference/solr/solrquery/getfacetmethod.xml | 12 +- reference/solr/solrquery/getfacetmincount.xml | 12 +- reference/solr/solrquery/getfacetmissing.xml | 12 +- reference/solr/solrquery/getfacetoffset.xml | 12 +- reference/solr/solrquery/getfacetprefix.xml | 12 +- reference/solr/solrquery/getfacetqueries.xml | 8 +- reference/solr/solrquery/getfacetsort.xml | 14 +- reference/solr/solrquery/getfields.xml | 8 +- reference/solr/solrquery/getfilterqueries.xml | 8 +- reference/solr/solrquery/getgroup.xml | 10 +- .../solr/solrquery/getgroupcachepercent.xml | 10 +- reference/solr/solrquery/getgroupfacet.xml | 10 +- reference/solr/solrquery/getgroupfields.xml | 10 +- reference/solr/solrquery/getgroupformat.xml | 10 +- .../solr/solrquery/getgroupfunctions.xml | 10 +- reference/solr/solrquery/getgrouplimit.xml | 10 +- reference/solr/solrquery/getgroupmain.xml | 10 +- reference/solr/solrquery/getgroupngroups.xml | 10 +- reference/solr/solrquery/getgroupoffset.xml | 10 +- reference/solr/solrquery/getgroupqueries.xml | 8 +- .../solr/solrquery/getgroupsortfields.xml | 10 +- reference/solr/solrquery/getgrouptruncate.xml | 10 +- reference/solr/solrquery/gethighlight.xml | 10 +- .../solrquery/gethighlightalternatefield.xml | 12 +- .../solr/solrquery/gethighlightfields.xml | 8 +- .../solr/solrquery/gethighlightformatter.xml | 12 +- .../solr/solrquery/gethighlightfragmenter.xml | 14 +- .../solr/solrquery/gethighlightfragsize.xml | 14 +- .../gethighlighthighlightmultiterm.xml | 8 +- .../gethighlightmaxalternatefieldlength.xml | 12 +- .../gethighlightmaxanalyzedchars.xml | 10 +- .../solrquery/gethighlightmergecontiguous.xml | 12 +- .../gethighlightregexmaxanalyzedchars.xml | 8 +- .../solrquery/gethighlightregexpattern.xml | 8 +- .../solr/solrquery/gethighlightregexslop.xml | 8 +- .../gethighlightrequirefieldmatch.xml | 8 +- .../solr/solrquery/gethighlightsimplepost.xml | 12 +- .../solr/solrquery/gethighlightsimplepre.xml | 14 +- .../solr/solrquery/gethighlightsnippets.xml | 14 +- .../gethighlightusephrasehighlighter.xml | 8 +- reference/solr/solrquery/getmlt.xml | 10 +- reference/solr/solrquery/getmltboost.xml | 8 +- reference/solr/solrquery/getmltcount.xml | 8 +- reference/solr/solrquery/getmltfields.xml | 8 +- .../solr/solrquery/getmltmaxnumqueryterms.xml | 10 +- .../solr/solrquery/getmltmaxnumtokens.xml | 10 +- .../solr/solrquery/getmltmaxwordlength.xml | 10 +- .../solr/solrquery/getmltmindocfrequency.xml | 8 +- .../solr/solrquery/getmltmintermfrequency.xml | 8 +- .../solr/solrquery/getmltminwordlength.xml | 8 +- .../solr/solrquery/getmltqueryfields.xml | 10 +- reference/solr/solrquery/getquery.xml | 10 +- reference/solr/solrquery/getrows.xml | 10 +- reference/solr/solrquery/getsortfields.xml | 10 +- reference/solr/solrquery/getstart.xml | 10 +- reference/solr/solrquery/getstats.xml | 10 +- reference/solr/solrquery/getstatsfacets.xml | 8 +- reference/solr/solrquery/getstatsfields.xml | 10 +- reference/solr/solrquery/getterms.xml | 8 +- reference/solr/solrquery/gettermsfield.xml | 10 +- .../solrquery/gettermsincludelowerbound.xml | 8 +- .../solrquery/gettermsincludeupperbound.xml | 8 +- reference/solr/solrquery/gettermslimit.xml | 8 +- .../solr/solrquery/gettermslowerbound.xml | 8 +- reference/solr/solrquery/gettermsmaxcount.xml | 10 +- reference/solr/solrquery/gettermsmincount.xml | 8 +- reference/solr/solrquery/gettermsprefix.xml | 8 +- .../solr/solrquery/gettermsreturnraw.xml | 8 +- reference/solr/solrquery/gettermssort.xml | 8 +- .../solr/solrquery/gettermsupperbound.xml | 8 +- reference/solr/solrquery/gettimeallowed.xml | 8 +- .../solrquery/removeexpandfilterquery.xml | 14 +- .../solr/solrquery/removeexpandsortfield.xml | 12 +- .../solr/solrquery/removefacetdatefield.xml | 12 +- .../solr/solrquery/removefacetdateother.xml | 16 +- reference/solr/solrquery/removefacetfield.xml | 12 +- reference/solr/solrquery/removefacetquery.xml | 12 +- reference/solr/solrquery/removefield.xml | 14 +- .../solr/solrquery/removefilterquery.xml | 12 +- .../solr/solrquery/removehighlightfield.xml | 14 +- reference/solr/solrquery/removemltfield.xml | 14 +- .../solr/solrquery/removemltqueryfield.xml | 12 +- reference/solr/solrquery/removesortfield.xml | 12 +- reference/solr/solrquery/removestatsfacet.xml | 12 +- reference/solr/solrquery/removestatsfield.xml | 12 +- reference/solr/solrquery/setechohandler.xml | 12 +- reference/solr/solrquery/setechoparams.xml | 22 +- reference/solr/solrquery/setexpand.xml | 12 +- reference/solr/solrquery/setexpandquery.xml | 22 +- reference/solr/solrquery/setexpandrows.xml | 14 +- reference/solr/solrquery/setexplainother.xml | 14 +- reference/solr/solrquery/setfacet.xml | 12 +- reference/solr/solrquery/setfacetdateend.xml | 18 +- reference/solr/solrquery/setfacetdategap.xml | 16 +- .../solr/solrquery/setfacetdatehardend.xml | 16 +- .../solr/solrquery/setfacetdatestart.xml | 16 +- .../setfacetenumcachemindefaultfrequency.xml | 16 +- reference/solr/solrquery/setfacetlimit.xml | 16 +- reference/solr/solrquery/setfacetmethod.xml | 18 +- reference/solr/solrquery/setfacetmincount.xml | 18 +- reference/solr/solrquery/setfacetmissing.xml | 16 +- reference/solr/solrquery/setfacetoffset.xml | 16 +- reference/solr/solrquery/setfacetprefix.xml | 16 +- reference/solr/solrquery/setfacetsort.xml | 16 +- reference/solr/solrquery/setgroup.xml | 16 +- .../solr/solrquery/setgroupcachepercent.xml | 30 +- reference/solr/solrquery/setgroupfacet.xml | 16 +- reference/solr/solrquery/setgroupformat.xml | 16 +- reference/solr/solrquery/setgrouplimit.xml | 16 +- reference/solr/solrquery/setgroupmain.xml | 12 +- reference/solr/solrquery/setgroupngroups.xml | 16 +- reference/solr/solrquery/setgroupoffset.xml | 16 +- reference/solr/solrquery/setgrouptruncate.xml | 16 +- reference/solr/solrquery/sethighlight.xml | 16 +- .../solrquery/sethighlightalternatefield.xml | 16 +- .../solr/solrquery/sethighlightformatter.xml | 16 +- .../solr/solrquery/sethighlightfragmenter.xml | 18 +- .../solr/solrquery/sethighlightfragsize.xml | 16 +- .../sethighlighthighlightmultiterm.xml | 12 +- .../sethighlightmaxalternatefieldlength.xml | 22 +- .../sethighlightmaxanalyzedchars.xml | 12 +- .../solrquery/sethighlightmergecontiguous.xml | 16 +- .../sethighlightregexmaxanalyzedchars.xml | 12 +- .../solrquery/sethighlightregexpattern.xml | 12 +- .../solr/solrquery/sethighlightregexslop.xml | 12 +- .../sethighlightrequirefieldmatch.xml | 14 +- .../solr/solrquery/sethighlightsimplepost.xml | 18 +- .../solr/solrquery/sethighlightsimplepre.xml | 18 +- .../solr/solrquery/sethighlightsnippets.xml | 16 +- .../sethighlightusephrasehighlighter.xml | 16 +- reference/solr/solrquery/setmlt.xml | 12 +- reference/solr/solrquery/setmltboost.xml | 12 +- reference/solr/solrquery/setmltcount.xml | 12 +- .../solr/solrquery/setmltmaxnumqueryterms.xml | 14 +- .../solr/solrquery/setmltmaxnumtokens.xml | 14 +- .../solr/solrquery/setmltmaxwordlength.xml | 14 +- .../solr/solrquery/setmltmindocfrequency.xml | 12 +- .../solr/solrquery/setmltmintermfrequency.xml | 14 +- .../solr/solrquery/setmltminwordlength.xml | 14 +- reference/solr/solrquery/setomitheader.xml | 12 +- reference/solr/solrquery/setquery.xml | 12 +- reference/solr/solrquery/setrows.xml | 12 +- reference/solr/solrquery/setshowdebuginfo.xml | 12 +- reference/solr/solrquery/setstart.xml | 12 +- reference/solr/solrquery/setstats.xml | 12 +- reference/solr/solrquery/setterms.xml | 14 +- reference/solr/solrquery/settermsfield.xml | 12 +- .../solrquery/settermsincludelowerbound.xml | 12 +- .../solrquery/settermsincludeupperbound.xml | 12 +- reference/solr/solrquery/settermslimit.xml | 12 +- .../solr/solrquery/settermslowerbound.xml | 12 +- reference/solr/solrquery/settermsmaxcount.xml | 14 +- reference/solr/solrquery/settermsmincount.xml | 12 +- reference/solr/solrquery/settermsprefix.xml | 12 +- .../solr/solrquery/settermsreturnraw.xml | 12 +- reference/solr/solrquery/settermssort.xml | 12 +- .../solr/solrquery/settermsupperbound.xml | 12 +- reference/solr/solrquery/settimeallowed.xml | 12 +- reference/solr/solrqueryresponse.xml | 16 +- .../solr/solrqueryresponse/construct.xml | 8 +- reference/solr/solrqueryresponse/destruct.xml | 8 +- reference/solr/solrresponse.xml | 34 +- .../solr/solrresponse/getdigestedresponse.xml | 8 +- reference/solr/solrresponse/gethttpstatus.xml | 8 +- .../solrresponse/gethttpstatusmessage.xml | 8 +- reference/solr/solrresponse/getrawrequest.xml | 8 +- .../solrresponse/getrawrequestheaders.xml | 8 +- .../solr/solrresponse/getrawresponse.xml | 8 +- .../solrresponse/getrawresponseheaders.xml | 8 +- reference/solr/solrresponse/getrequesturl.xml | 8 +- reference/solr/solrresponse/getresponse.xml | 8 +- reference/solr/solrresponse/setparsemode.xml | 12 +- reference/solr/solrresponse/success.xml | 8 +- reference/solr/solrserverexception.xml | 12 +- .../solrserverexception/getinternalinfo.xml | 8 +- reference/solr/solrupdateresponse.xml | 16 +- .../solr/solrupdateresponse/construct.xml | 8 +- .../solr/solrupdateresponse/destruct.xml | 10 +- reference/solr/solrutils.xml | 8 +- .../solr/solrutils/digestxmlresponse.xml | 26 +- reference/solr/solrutils/escapequerychars.xml | 22 +- reference/solr/solrutils/getsolrversion.xml | 8 +- reference/solr/solrutils/queryphrase.xml | 12 +- reference/sqlsrv/book.xml | 2 +- reference/sqlsrv/configure.xml | 2 +- .../functions/sqlsrv-begin-transaction.xml | 2 +- reference/sqlsrv/functions/sqlsrv-cancel.xml | 2 +- .../sqlsrv/functions/sqlsrv-client-info.xml | 2 +- reference/sqlsrv/functions/sqlsrv-commit.xml | 2 +- .../sqlsrv/functions/sqlsrv-configure.xml | 2 +- reference/sqlsrv/functions/sqlsrv-connect.xml | 2 +- reference/sqlsrv/functions/sqlsrv-errors.xml | 2 +- reference/sqlsrv/functions/sqlsrv-execute.xml | 2 +- .../sqlsrv/functions/sqlsrv-fetch-array.xml | 2 +- .../sqlsrv/functions/sqlsrv-fetch-object.xml | 2 +- reference/sqlsrv/functions/sqlsrv-fetch.xml | 2 +- .../functions/sqlsrv-field-metadata.xml | 2 +- .../sqlsrv/functions/sqlsrv-free-stmt.xml | 2 +- .../sqlsrv/functions/sqlsrv-get-config.xml | 2 +- .../sqlsrv/functions/sqlsrv-get-field.xml | 2 +- .../sqlsrv/functions/sqlsrv-has-rows.xml | 2 +- .../sqlsrv/functions/sqlsrv-next-result.xml | 2 +- .../sqlsrv/functions/sqlsrv-num-fields.xml | 2 +- reference/sqlsrv/functions/sqlsrv-prepare.xml | 2 +- reference/sqlsrv/functions/sqlsrv-query.xml | 2 +- .../sqlsrv/functions/sqlsrv-rollback.xml | 2 +- .../sqlsrv/functions/sqlsrv-rows-affected.xml | 2 +- .../functions/sqlsrv-send-stream-data.xml | 2 +- .../sqlsrv/functions/sqlsrv-server-info.xml | 2 +- reference/sqlsrv/ini.xml | 2 +- reference/sqlsrv/setup.xml | 2 +- reference/ssdeep/book.xml | 2 +- reference/ssdeep/configure.xml | 2 +- .../ssdeep/functions/ssdeep-fuzzy-compare.xml | 2 +- .../functions/ssdeep-fuzzy-hash-filename.xml | 2 +- .../ssdeep/functions/ssdeep-fuzzy-hash.xml | 2 +- reference/ssdeep/setup.xml | 2 +- reference/ssh2/book.xml | 2 +- reference/ssh2/functions/ssh2-auth-agent.xml | 2 +- .../functions/ssh2-auth-hostbased-file.xml | 2 +- reference/ssh2/functions/ssh2-auth-none.xml | 2 +- .../ssh2/functions/ssh2-auth-password.xml | 2 +- .../ssh2/functions/ssh2-auth-pubkey-file.xml | 2 +- reference/ssh2/functions/ssh2-auth-pubkey.xml | 2 +- reference/ssh2/functions/ssh2-connect.xml | 2 +- reference/ssh2/functions/ssh2-exec.xml | 2 +- .../ssh2/functions/ssh2-fetch-stream.xml | 2 +- reference/ssh2/functions/ssh2-fingerprint.xml | 2 +- .../ssh2/functions/ssh2-forward-accept.xml | 2 +- .../ssh2/functions/ssh2-forward-listen.xml | 2 +- .../functions/ssh2-methods-negotiated.xml | 2 +- reference/ssh2/functions/ssh2-poll.xml | 2 +- .../ssh2/functions/ssh2-publickey-add.xml | 2 +- .../ssh2/functions/ssh2-publickey-init.xml | 2 +- .../ssh2/functions/ssh2-publickey-list.xml | 2 +- .../ssh2/functions/ssh2-publickey-remove.xml | 2 +- reference/ssh2/functions/ssh2-scp-recv.xml | 2 +- reference/ssh2/functions/ssh2-scp-send.xml | 2 +- reference/ssh2/functions/ssh2-sftp-chmod.xml | 2 +- reference/ssh2/functions/ssh2-sftp-mkdir.xml | 2 +- reference/ssh2/functions/ssh2-sftp-rename.xml | 2 +- reference/ssh2/functions/ssh2-sftp-rmdir.xml | 2 +- .../ssh2/functions/ssh2-sftp-symlink.xml | 2 +- reference/ssh2/functions/ssh2-sftp-unlink.xml | 2 +- reference/ssh2/functions/ssh2-sftp.xml | 2 +- reference/ssh2/functions/ssh2-shell.xml | 2 +- reference/ssh2/functions/ssh2-tunnel.xml | 2 +- reference/ssh2/installation.xml | 2 +- reference/ssh2/setup.xml | 2 +- .../stats/functions/stats-rand-gen-f.xml | 12 +- .../functions/stats-standard-deviation.xml | 8 +- reference/stats/functions/stats-variance.xml | 8 +- reference/stats/setup.xml | 16 +- reference/stomp/book.xml | 2 +- reference/stomp/examples.xml | 2 +- .../stomp/functions/stomp-connect-error.xml | 2 +- reference/stomp/functions/stomp-version.xml | 2 +- reference/stomp/ini.xml | 2 +- reference/stomp/setup.xml | 2 +- reference/stomp/stomp.xml | 2 +- reference/stomp/stomp/abort.xml | 2 +- reference/stomp/stomp/ack.xml | 2 +- reference/stomp/stomp/begin.xml | 2 +- reference/stomp/stomp/commit.xml | 2 +- reference/stomp/stomp/construct.xml | 2 +- reference/stomp/stomp/destruct.xml | 2 +- reference/stomp/stomp/error.xml | 2 +- reference/stomp/stomp/getreadtimeout.xml | 2 +- reference/stomp/stomp/getsessionid.xml | 2 +- reference/stomp/stomp/hasframe.xml | 2 +- reference/stomp/stomp/readframe.xml | 2 +- reference/stomp/stomp/send.xml | 2 +- reference/stomp/stomp/setreadtimeout.xml | 2 +- reference/stomp/stomp/subscribe.xml | 2 +- reference/stomp/stomp/unsubscribe.xml | 2 +- reference/stomp/stompexception.xml | 2 +- reference/stomp/stompexception/getdetails.xml | 2 +- reference/stomp/stompframe.xml | 2 +- reference/stomp/stompframe/construct.xml | 2 +- reference/svm/book.xml | 2 +- reference/svm/configure.xml | 2 +- reference/svm/examples.xml | 2 +- reference/svm/setup.xml | 2 +- reference/svm/svm.xml | 2 +- reference/svm/svm/construct.xml | 4 +- reference/svm/svm/crossvalidate.xml | 2 +- reference/svm/svm/getoptions.xml | 2 +- reference/svm/svm/setoptions.xml | 2 +- reference/svm/svm/train.xml | 2 +- reference/svm/svmexception.xml | 2 +- reference/svm/svmmodel.xml | 2 +- .../svm/svmmodel/checkprobabilitymodel.xml | 2 +- reference/svm/svmmodel/construct.xml | 4 +- reference/svm/svmmodel/getlabels.xml | 2 +- reference/svm/svmmodel/getnrclass.xml | 2 +- reference/svm/svmmodel/getsvmtype.xml | 2 +- reference/svm/svmmodel/getsvrprobability.xml | 2 +- reference/svm/svmmodel/load.xml | 2 +- .../svm/svmmodel/predict-probability.xml | 2 +- reference/svm/svmmodel/predict.xml | 2 +- reference/svm/svmmodel/save.xml | 2 +- reference/svn/book.xml | 2 +- reference/svn/configure.xml | 2 +- reference/svn/constants.xml | 72 ++-- reference/svn/functions/svn-blame.xml | 2 +- reference/svn/functions/svn-delete.xml | 2 +- reference/svn/functions/svn-export.xml | 2 +- reference/svn/functions/svn-ls.xml | 2 +- reference/svn/functions/svn-mkdir.xml | 2 +- reference/svn/functions/svn-revert.xml | 2 +- reference/svn/setup.xml | 2 +- reference/swoole/book.xml | 10 +- reference/swoole/configure.xml | 10 +- .../functions/swoole-async-dns-lookup.xml | 20 +- .../swoole/functions/swoole-async-read.xml | 24 +- .../functions/swoole-async-readfile.xml | 20 +- .../swoole/functions/swoole-async-set.xml | 16 +- .../swoole/functions/swoole-async-write.xml | 26 +- .../functions/swoole-async-writefile.xml | 32 +- .../swoole/functions/swoole-clear-error.xml | 8 +- .../swoole/functions/swoole-client-select.xml | 34 +- reference/swoole/functions/swoole-cpu-num.xml | 8 +- reference/swoole/functions/swoole-errno.xml | 10 +- .../swoole/functions/swoole-error-log.xml | 16 +- .../swoole/functions/swoole-event-add.xml | 34 +- .../swoole/functions/swoole-event-defer.xml | 14 +- .../swoole/functions/swoole-event-del.xml | 14 +- .../swoole/functions/swoole-event-exit.xml | 10 +- .../swoole/functions/swoole-event-set.xml | 34 +- .../swoole/functions/swoole-event-wait.xml | 10 +- .../swoole/functions/swoole-event-write.xml | 20 +- .../swoole/functions/swoole-get-local-ip.xml | 10 +- .../swoole/functions/swoole-last-error.xml | 10 +- .../swoole/functions/swoole-load-module.xml | 10 +- reference/swoole/functions/swoole-select.xml | 34 +- .../functions/swoole-set-process-name.xml | 16 +- .../swoole/functions/swoole-strerror.xml | 16 +- .../swoole/functions/swoole-timer-after.xml | 28 +- .../swoole/functions/swoole-timer-exists.xml | 16 +- .../swoole/functions/swoole-timer-tick.xml | 22 +- reference/swoole/functions/swoole-version.xml | 8 +- reference/swoole/ini.xml | 24 +- reference/swoole/setup.xml | 40 +- reference/swoole/swoole.async.xml | 6 +- reference/swoole/swoole.atomic.xml | 6 +- reference/swoole/swoole.buffer.xml | 6 +- reference/swoole/swoole.channel.xml | 6 +- reference/swoole/swoole.client.xml | 20 +- .../swoole/swoole.connection.iterator.xml | 8 +- reference/swoole/swoole.coroutine.client.xml | 16 +- .../swoole/swoole.coroutine.http.client.xml | 12 +- reference/swoole/swoole.coroutine.lock.xml | 24 +- .../swoole.coroutine.mysql.exception.xml | 8 +- reference/swoole/swoole.coroutine.mysql.xml | 24 +- reference/swoole/swoole.coroutine.xml | 6 +- reference/swoole/swoole.event.xml | 2 +- reference/swoole/swoole.exception.xml | 8 +- reference/swoole/swoole.http.client.xml | 12 +- reference/swoole/swoole.http.request.xml | 6 +- reference/swoole/swoole.http.response.xml | 6 +- reference/swoole/swoole.http.server.xml | 10 +- reference/swoole/swoole.lock.xml | 6 +- reference/swoole/swoole.mmap.xml | 6 +- reference/swoole/swoole.module.xml | 6 +- reference/swoole/swoole.mysql.exception.xml | 8 +- reference/swoole/swoole.mysql.xml | 6 +- reference/swoole/swoole.process.xml | 6 +- reference/swoole/swoole.redis.server.xml | 18 +- reference/swoole/swoole.runtime.xml | 4 +- reference/swoole/swoole.serialize.xml | 6 +- reference/swoole/swoole.server.port.xml | 6 +- reference/swoole/swoole.server.xml | 6 +- reference/swoole/swoole.table.xml | 10 +- reference/swoole/swoole.timer.xml | 2 +- reference/swoole/swoole.websocket.frame.xml | 8 +- reference/swoole/swoole.websocket.server.xml | 10 +- reference/swoole/swoole/async/dnslookup.xml | 16 +- reference/swoole/swoole/async/read.xml | 24 +- reference/swoole/swoole/async/readfile.xml | 14 +- reference/swoole/swoole/async/set.xml | 10 +- reference/swoole/swoole/async/write.xml | 22 +- reference/swoole/swoole/async/writefile.xml | 28 +- reference/swoole/swoole/atomic/add.xml | 12 +- reference/swoole/swoole/atomic/cmpset.xml | 16 +- reference/swoole/swoole/atomic/construct.xml | 18 +- reference/swoole/swoole/atomic/get.xml | 8 +- reference/swoole/swoole/atomic/set.xml | 14 +- reference/swoole/swoole/atomic/sub.xml | 12 +- reference/swoole/swoole/buffer/append.xml | 12 +- reference/swoole/swoole/buffer/clear.xml | 4 +- reference/swoole/swoole/buffer/construct.xml | 10 +- reference/swoole/swoole/buffer/destruct.xml | 4 +- reference/swoole/swoole/buffer/expand.xml | 12 +- reference/swoole/swoole/buffer/read.xml | 12 +- reference/swoole/swoole/buffer/recycle.xml | 4 +- reference/swoole/swoole/buffer/substr.xml | 18 +- reference/swoole/swoole/buffer/tostring.xml | 8 +- reference/swoole/swoole/buffer/write.xml | 18 +- reference/swoole/swoole/channel/construct.xml | 10 +- reference/swoole/swoole/channel/destruct.xml | 4 +- reference/swoole/swoole/channel/pop.xml | 8 +- reference/swoole/swoole/channel/push.xml | 16 +- reference/swoole/swoole/channel/stats.xml | 8 +- reference/swoole/swoole/client/close.xml | 12 +- reference/swoole/swoole/client/connect.xml | 26 +- reference/swoole/swoole/client/construct.xml | 12 +- reference/swoole/swoole/client/destruct.xml | 4 +- .../swoole/swoole/client/getpeername.xml | 8 +- .../swoole/swoole/client/getsockname.xml | 8 +- .../swoole/swoole/client/isconnected.xml | 8 +- reference/swoole/swoole/client/on.xml | 16 +- reference/swoole/swoole/client/pause.xml | 4 +- reference/swoole/swoole/client/pipe.xml | 10 +- reference/swoole/swoole/client/recv.xml | 22 +- reference/swoole/swoole/client/resume.xml | 4 +- reference/swoole/swoole/client/send.xml | 26 +- reference/swoole/swoole/client/sendfile.xml | 18 +- reference/swoole/swoole/client/sendto.xml | 22 +- reference/swoole/swoole/client/set.xml | 16 +- reference/swoole/swoole/client/sleep.xml | 10 +- reference/swoole/swoole/client/wakeup.xml | 10 +- .../swoole/connection/iterator/count.xml | 8 +- .../swoole/connection/iterator/current.xml | 8 +- .../swoole/swoole/connection/iterator/key.xml | 8 +- .../swoole/connection/iterator/next.xml | 10 +- .../connection/iterator/offsetexists.xml | 12 +- .../swoole/connection/iterator/offsetget.xml | 14 +- .../swoole/connection/iterator/offsetset.xml | 18 +- .../connection/iterator/offsetunset.xml | 14 +- .../swoole/connection/iterator/rewind.xml | 10 +- .../swoole/connection/iterator/valid.xml | 8 +- .../swoole/coroutine/call-user-func-array.xml | 18 +- .../swoole/coroutine/call-user-func.xml | 18 +- .../swoole/swoole/coroutine/cli-wait.xml | 10 +- .../swoole/swoole/coroutine/client/close.xml | 10 +- .../swoole/coroutine/client/connect.xml | 10 +- .../swoole/coroutine/client/construct.xml | 6 +- .../swoole/coroutine/client/destruct.xml | 10 +- .../swoole/coroutine/client/getpeername.xml | 10 +- .../swoole/coroutine/client/getsockname.xml | 10 +- .../swoole/coroutine/client/isconnected.xml | 10 +- .../swoole/swoole/coroutine/client/recv.xml | 10 +- .../swoole/swoole/coroutine/client/send.xml | 10 +- .../swoole/coroutine/client/sendfile.xml | 10 +- .../swoole/swoole/coroutine/client/sendto.xml | 10 +- .../swoole/swoole/coroutine/client/set.xml | 10 +- reference/swoole/swoole/coroutine/create.xml | 10 +- reference/swoole/swoole/coroutine/getuid.xml | 10 +- .../swoole/coroutine/http/client/addfile.xml | 10 +- .../swoole/coroutine/http/client/close.xml | 10 +- .../coroutine/http/client/construct.xml | 6 +- .../swoole/coroutine/http/client/destruct.xml | 10 +- .../swoole/coroutine/http/client/execute.xml | 10 +- .../swoole/coroutine/http/client/get.xml | 10 +- .../swoole/coroutine/http/client/getdefer.xml | 10 +- .../coroutine/http/client/isconnected.xml | 10 +- .../swoole/coroutine/http/client/post.xml | 10 +- .../swoole/coroutine/http/client/recv.xml | 10 +- .../swoole/coroutine/http/client/set.xml | 10 +- .../coroutine/http/client/setcookies.xml | 10 +- .../swoole/coroutine/http/client/setdata.xml | 10 +- .../swoole/coroutine/http/client/setdefer.xml | 10 +- .../coroutine/http/client/setheaders.xml | 10 +- .../coroutine/http/client/setmethod.xml | 10 +- .../swoole/coroutine/lock/construct.xml | 8 +- .../swoole/swoole/coroutine/lock/lock.xml | 4 +- .../swoole/swoole/coroutine/lock/trylock.xml | 4 +- .../swoole/swoole/coroutine/lock/unlock.xml | 8 +- .../swoole/swoole/coroutine/mysql/close.xml | 10 +- .../swoole/swoole/coroutine/mysql/connect.xml | 10 +- .../swoole/coroutine/mysql/construct.xml | 6 +- .../swoole/coroutine/mysql/destruct.xml | 10 +- .../swoole/coroutine/mysql/getdefer.xml | 10 +- .../swoole/swoole/coroutine/mysql/query.xml | 10 +- .../swoole/swoole/coroutine/mysql/recv.xml | 10 +- .../swoole/coroutine/mysql/setdefer.xml | 10 +- reference/swoole/swoole/coroutine/resume.xml | 10 +- reference/swoole/swoole/coroutine/suspend.xml | 10 +- .../swoole/swoole/http/client/addfile.xml | 40 +- reference/swoole/swoole/http/client/close.xml | 10 +- .../swoole/swoole/http/client/construct.xml | 18 +- .../swoole/swoole/http/client/destruct.xml | 10 +- .../swoole/swoole/http/client/download.xml | 34 +- .../swoole/swoole/http/client/execute.xml | 22 +- reference/swoole/swoole/http/client/get.xml | 22 +- .../swoole/swoole/http/client/isconnected.xml | 10 +- reference/swoole/swoole/http/client/on.xml | 22 +- reference/swoole/swoole/http/client/post.xml | 28 +- reference/swoole/swoole/http/client/push.xml | 28 +- reference/swoole/swoole/http/client/set.xml | 16 +- .../swoole/swoole/http/client/setcookies.xml | 16 +- .../swoole/swoole/http/client/setdata.xml | 16 +- .../swoole/swoole/http/client/setheaders.xml | 16 +- .../swoole/swoole/http/client/setmethod.xml | 16 +- .../swoole/swoole/http/client/upgrade.xml | 22 +- .../swoole/swoole/http/request/destruct.xml | 10 +- .../swoole/swoole/http/request/rawcontent.xml | 10 +- .../swoole/swoole/http/response/cookie.xml | 52 +-- .../swoole/swoole/http/response/destruct.xml | 10 +- reference/swoole/swoole/http/response/end.xml | 16 +- .../swoole/swoole/http/response/gzip.xml | 16 +- .../swoole/swoole/http/response/header.xml | 28 +- .../swoole/http/response/initheader.xml | 10 +- .../swoole/swoole/http/response/rawcookie.xml | 52 +-- .../swoole/swoole/http/response/sendfile.xml | 22 +- .../swoole/swoole/http/response/status.xml | 16 +- .../swoole/swoole/http/response/write.xml | 16 +- reference/swoole/swoole/http/server/on.xml | 22 +- reference/swoole/swoole/http/server/start.xml | 10 +- reference/swoole/swoole/lock/construct.xml | 14 +- reference/swoole/swoole/lock/destruct.xml | 10 +- reference/swoole/swoole/lock/lock-read.xml | 10 +- reference/swoole/swoole/lock/lock.xml | 10 +- reference/swoole/swoole/lock/trylock-read.xml | 10 +- reference/swoole/swoole/lock/trylock.xml | 10 +- reference/swoole/swoole/lock/unlock.xml | 10 +- reference/swoole/swoole/mmap/open.xml | 28 +- reference/swoole/swoole/mysql/close.xml | 10 +- reference/swoole/swoole/mysql/connect.xml | 22 +- reference/swoole/swoole/mysql/construct.xml | 6 +- reference/swoole/swoole/mysql/destruct.xml | 10 +- reference/swoole/swoole/mysql/getbuffer.xml | 10 +- reference/swoole/swoole/mysql/on.xml | 22 +- reference/swoole/swoole/mysql/query.xml | 22 +- reference/swoole/swoole/process/alarm.xml | 16 +- reference/swoole/swoole/process/close.xml | 10 +- reference/swoole/swoole/process/construct.xml | 24 +- reference/swoole/swoole/process/daemon.xml | 22 +- reference/swoole/swoole/process/destruct.xml | 10 +- reference/swoole/swoole/process/exec.xml | 22 +- reference/swoole/swoole/process/exit.xml | 16 +- reference/swoole/swoole/process/freequeue.xml | 10 +- reference/swoole/swoole/process/kill.xml | 16 +- reference/swoole/swoole/process/name.xml | 12 +- reference/swoole/swoole/process/pop.xml | 16 +- reference/swoole/swoole/process/push.xml | 16 +- reference/swoole/swoole/process/read.xml | 16 +- reference/swoole/swoole/process/signal.xml | 20 +- reference/swoole/swoole/process/start.xml | 10 +- reference/swoole/swoole/process/statqueue.xml | 8 +- reference/swoole/swoole/process/usequeue.xml | 22 +- reference/swoole/swoole/process/wait.xml | 16 +- reference/swoole/swoole/process/write.xml | 16 +- .../swoole/swoole/redis/server/format.xml | 22 +- .../swoole/swoole/redis/server/sethandler.xml | 34 +- .../swoole/swoole/redis/server/start.xml | 10 +- .../swoole/swoole/runtime/enableCoroutine.xml | 12 +- .../swoole/swoole/runtime/getHookFlags.xml | 12 +- .../swoole/swoole/runtime/setHookFlags.xml | 12 +- reference/swoole/swoole/serialize/pack.xml | 22 +- reference/swoole/swoole/serialize/unpack.xml | 22 +- .../swoole/swoole/server/addlistener.xml | 28 +- reference/swoole/swoole/server/addprocess.xml | 16 +- reference/swoole/swoole/server/after.xml | 28 +- reference/swoole/swoole/server/bind.xml | 22 +- reference/swoole/swoole/server/cleartimer.xml | 22 +- reference/swoole/swoole/server/close.xml | 22 +- reference/swoole/swoole/server/confirm.xml | 16 +- .../swoole/swoole/server/connection-info.xml | 22 +- .../swoole/swoole/server/connection-list.xml | 22 +- reference/swoole/swoole/server/construct.xml | 30 +- reference/swoole/swoole/server/defer.xml | 16 +- reference/swoole/swoole/server/exist.xml | 16 +- reference/swoole/swoole/server/finish.xml | 16 +- .../swoole/swoole/server/getclientinfo.xml | 20 +- .../swoole/swoole/server/getclientlist.xml | 22 +- .../swoole/swoole/server/getlasterror.xml | 10 +- reference/swoole/swoole/server/heartbeat.xml | 16 +- reference/swoole/swoole/server/listen.xml | 28 +- reference/swoole/swoole/server/on.xml | 22 +- reference/swoole/swoole/server/pause.xml | 16 +- .../swoole/swoole/server/port/construct.xml | 6 +- .../swoole/swoole/server/port/destruct.xml | 10 +- reference/swoole/swoole/server/port/on.xml | 22 +- reference/swoole/swoole/server/port/set.xml | 16 +- reference/swoole/swoole/server/protect.xml | 22 +- reference/swoole/swoole/server/reload.xml | 10 +- reference/swoole/swoole/server/resume.xml | 16 +- reference/swoole/swoole/server/send.xml | 28 +- reference/swoole/swoole/server/sendfile.xml | 28 +- .../swoole/swoole/server/sendmessage.xml | 22 +- reference/swoole/swoole/server/sendto.xml | 34 +- reference/swoole/swoole/server/sendwait.xml | 22 +- reference/swoole/swoole/server/set.xml | 16 +- reference/swoole/swoole/server/shutdown.xml | 10 +- reference/swoole/swoole/server/start.xml | 10 +- reference/swoole/swoole/server/stats.xml | 10 +- reference/swoole/swoole/server/stop.xml | 16 +- reference/swoole/swoole/server/task.xml | 28 +- reference/swoole/swoole/server/taskwait.xml | 28 +- .../swoole/swoole/server/taskwaitmulti.xml | 22 +- reference/swoole/swoole/server/tick.xml | 22 +- reference/swoole/swoole/table/column.xml | 22 +- reference/swoole/swoole/table/construct.xml | 12 +- reference/swoole/swoole/table/count.xml | 10 +- reference/swoole/swoole/table/create.xml | 10 +- reference/swoole/swoole/table/current.xml | 10 +- reference/swoole/swoole/table/decr.xml | 22 +- reference/swoole/swoole/table/del.xml | 16 +- reference/swoole/swoole/table/destroy.xml | 10 +- reference/swoole/swoole/table/exist.xml | 16 +- reference/swoole/swoole/table/get.xml | 22 +- reference/swoole/swoole/table/incr.xml | 22 +- reference/swoole/swoole/table/key.xml | 10 +- reference/swoole/swoole/table/next.xml | 10 +- reference/swoole/swoole/table/rewind.xml | 10 +- reference/swoole/swoole/table/set.xml | 18 +- reference/swoole/swoole/table/valid.xml | 10 +- .../swoole/swoole/websocket/server/exist.xml | 16 +- .../swoole/swoole/websocket/server/on.xml | 22 +- .../swoole/swoole/websocket/server/pack.xml | 34 +- .../swoole/swoole/websocket/server/push.xml | 34 +- .../swoole/swoole/websocket/server/unpack.xml | 16 +- reference/sync/book.xml | 2 +- reference/sync/configure.xml | 2 +- reference/sync/setup.xml | 2 +- reference/sync/syncevent.xml | 2 +- reference/sync/syncevent/construct.xml | 2 +- reference/sync/syncevent/fire.xml | 2 +- reference/sync/syncevent/reset.xml | 2 +- reference/sync/syncevent/wait.xml | 2 +- reference/sync/syncmutex.xml | 2 +- reference/sync/syncmutex/construct.xml | 2 +- reference/sync/syncmutex/lock.xml | 2 +- reference/sync/syncmutex/unlock.xml | 2 +- reference/sync/syncreaderwriter.xml | 2 +- reference/sync/syncreaderwriter/construct.xml | 2 +- reference/sync/syncreaderwriter/readlock.xml | 2 +- .../sync/syncreaderwriter/readunlock.xml | 2 +- reference/sync/syncreaderwriter/writelock.xml | 2 +- .../sync/syncreaderwriter/writeunlock.xml | 2 +- reference/sync/syncsemaphore.xml | 2 +- reference/sync/syncsemaphore/construct.xml | 2 +- reference/sync/syncsemaphore/lock.xml | 2 +- reference/sync/syncsemaphore/unlock.xml | 2 +- reference/sync/syncsharedmemory.xml | 2 +- reference/sync/syncsharedmemory/construct.xml | 2 +- reference/sync/syncsharedmemory/first.xml | 2 +- reference/sync/syncsharedmemory/read.xml | 2 +- reference/sync/syncsharedmemory/size.xml | 2 +- reference/sync/syncsharedmemory/write.xml | 2 +- reference/tcpwrap/book.xml | 4 +- reference/tcpwrap/configure.xml | 8 +- reference/tcpwrap/functions/tcpwrap-check.xml | 44 +- reference/trader/book.xml | 16 +- reference/trader/configure.xml | 6 +- reference/trader/functions/trader-acos.xml | 12 +- reference/trader/functions/trader-ad.xml | 22 +- reference/trader/functions/trader-add.xml | 18 +- reference/trader/functions/trader-adosc.xml | 30 +- reference/trader/functions/trader-adx.xml | 22 +- reference/trader/functions/trader-adxr.xml | 22 +- reference/trader/functions/trader-apo.xml | 22 +- reference/trader/functions/trader-aroon.xml | 18 +- .../trader/functions/trader-aroonosc.xml | 18 +- reference/trader/functions/trader-asin.xml | 12 +- reference/trader/functions/trader-atan.xml | 12 +- reference/trader/functions/trader-atr.xml | 22 +- .../trader/functions/trader-avgprice.xml | 22 +- reference/trader/functions/trader-bbands.xml | 26 +- reference/trader/functions/trader-beta.xml | 18 +- reference/trader/functions/trader-bop.xml | 22 +- reference/trader/functions/trader-cci.xml | 22 +- .../trader/functions/trader-cdl2crows.xml | 22 +- .../functions/trader-cdl3blackcrows.xml | 22 +- .../trader/functions/trader-cdl3inside.xml | 22 +- .../functions/trader-cdl3linestrike.xml | 22 +- .../trader/functions/trader-cdl3outside.xml | 22 +- .../functions/trader-cdl3starsinsouth.xml | 22 +- .../functions/trader-cdl3whitesoldiers.xml | 22 +- .../functions/trader-cdlabandonedbaby.xml | 26 +- .../functions/trader-cdladvanceblock.xml | 22 +- .../trader/functions/trader-cdlbelthold.xml | 22 +- .../trader/functions/trader-cdlbreakaway.xml | 22 +- .../functions/trader-cdlclosingmarubozu.xml | 22 +- .../functions/trader-cdlconcealbabyswall.xml | 22 +- .../functions/trader-cdlcounterattack.xml | 22 +- .../functions/trader-cdldarkcloudcover.xml | 26 +- reference/trader/functions/trader-cdldoji.xml | 22 +- .../trader/functions/trader-cdldojistar.xml | 22 +- .../functions/trader-cdldragonflydoji.xml | 22 +- .../trader/functions/trader-cdlengulfing.xml | 22 +- .../functions/trader-cdleveningdojistar.xml | 26 +- .../functions/trader-cdleveningstar.xml | 26 +- .../functions/trader-cdlgapsidesidewhite.xml | 22 +- .../functions/trader-cdlgravestonedoji.xml | 22 +- .../trader/functions/trader-cdlhammer.xml | 22 +- .../trader/functions/trader-cdlhangingman.xml | 22 +- .../trader/functions/trader-cdlharami.xml | 22 +- .../functions/trader-cdlharamicross.xml | 22 +- .../trader/functions/trader-cdlhighwave.xml | 22 +- .../trader/functions/trader-cdlhikkake.xml | 22 +- .../trader/functions/trader-cdlhikkakemod.xml | 22 +- .../functions/trader-cdlhomingpigeon.xml | 22 +- .../functions/trader-cdlidentical3crows.xml | 22 +- .../trader/functions/trader-cdlinneck.xml | 22 +- .../functions/trader-cdlinvertedhammer.xml | 22 +- .../trader/functions/trader-cdlkicking.xml | 22 +- .../functions/trader-cdlkickingbylength.xml | 22 +- .../functions/trader-cdlladderbottom.xml | 22 +- .../functions/trader-cdllongleggeddoji.xml | 22 +- .../trader/functions/trader-cdllongline.xml | 22 +- .../trader/functions/trader-cdlmarubozu.xml | 22 +- .../functions/trader-cdlmatchinglow.xml | 22 +- .../trader/functions/trader-cdlmathold.xml | 26 +- .../functions/trader-cdlmorningdojistar.xml | 26 +- .../functions/trader-cdlmorningstar.xml | 26 +- .../trader/functions/trader-cdlonneck.xml | 22 +- .../trader/functions/trader-cdlpiercing.xml | 22 +- .../functions/trader-cdlrickshawman.xml | 22 +- .../functions/trader-cdlrisefall3methods.xml | 22 +- .../functions/trader-cdlseparatinglines.xml | 22 +- .../functions/trader-cdlshootingstar.xml | 22 +- .../trader/functions/trader-cdlshortline.xml | 22 +- .../functions/trader-cdlspinningtop.xml | 22 +- .../functions/trader-cdlstalledpattern.xml | 22 +- .../functions/trader-cdlsticksandwich.xml | 22 +- .../trader/functions/trader-cdltakuri.xml | 22 +- .../trader/functions/trader-cdltasukigap.xml | 22 +- .../trader/functions/trader-cdlthrusting.xml | 22 +- .../trader/functions/trader-cdltristar.xml | 22 +- .../functions/trader-cdlunique3river.xml | 22 +- .../functions/trader-cdlupsidegap2crows.xml | 22 +- .../functions/trader-cdlxsidegap3methods.xml | 22 +- reference/trader/functions/trader-ceil.xml | 12 +- reference/trader/functions/trader-cmo.xml | 14 +- reference/trader/functions/trader-correl.xml | 18 +- reference/trader/functions/trader-cos.xml | 12 +- reference/trader/functions/trader-cosh.xml | 12 +- reference/trader/functions/trader-dema.xml | 14 +- reference/trader/functions/trader-div.xml | 18 +- reference/trader/functions/trader-dx.xml | 22 +- reference/trader/functions/trader-ema.xml | 14 +- reference/trader/functions/trader-errno.xml | 8 +- reference/trader/functions/trader-exp.xml | 12 +- reference/trader/functions/trader-floor.xml | 12 +- .../trader/functions/trader-get-compat.xml | 8 +- .../functions/trader-get-unstable-period.xml | 10 +- .../trader/functions/trader-ht-dcperiod.xml | 10 +- .../trader/functions/trader-ht-dcphase.xml | 10 +- .../trader/functions/trader-ht-phasor.xml | 10 +- reference/trader/functions/trader-ht-sine.xml | 10 +- .../trader/functions/trader-ht-trendline.xml | 10 +- .../trader/functions/trader-ht-trendmode.xml | 10 +- reference/trader/functions/trader-kama.xml | 14 +- .../functions/trader-linearreg-angle.xml | 14 +- .../functions/trader-linearreg-intercept.xml | 14 +- .../functions/trader-linearreg-slope.xml | 14 +- .../trader/functions/trader-linearreg.xml | 14 +- reference/trader/functions/trader-ln.xml | 12 +- reference/trader/functions/trader-log10.xml | 12 +- reference/trader/functions/trader-ma.xml | 18 +- reference/trader/functions/trader-macd.xml | 22 +- reference/trader/functions/trader-macdext.xml | 34 +- reference/trader/functions/trader-macdfix.xml | 14 +- reference/trader/functions/trader-mama.xml | 18 +- reference/trader/functions/trader-mavp.xml | 26 +- reference/trader/functions/trader-max.xml | 14 +- .../trader/functions/trader-maxindex.xml | 14 +- .../trader/functions/trader-medprice.xml | 14 +- reference/trader/functions/trader-mfi.xml | 26 +- .../trader/functions/trader-midpoint.xml | 14 +- .../trader/functions/trader-midprice.xml | 18 +- reference/trader/functions/trader-min.xml | 14 +- .../trader/functions/trader-minindex.xml | 14 +- reference/trader/functions/trader-minmax.xml | 14 +- .../trader/functions/trader-minmaxindex.xml | 14 +- .../trader/functions/trader-minus-di.xml | 22 +- .../trader/functions/trader-minus-dm.xml | 18 +- reference/trader/functions/trader-mom.xml | 14 +- reference/trader/functions/trader-mult.xml | 18 +- reference/trader/functions/trader-natr.xml | 22 +- reference/trader/functions/trader-obv.xml | 14 +- reference/trader/functions/trader-plus-di.xml | 22 +- reference/trader/functions/trader-plus-dm.xml | 18 +- reference/trader/functions/trader-ppo.xml | 22 +- reference/trader/functions/trader-roc.xml | 14 +- reference/trader/functions/trader-rocp.xml | 14 +- reference/trader/functions/trader-rocr.xml | 14 +- reference/trader/functions/trader-rocr100.xml | 14 +- reference/trader/functions/trader-rsi.xml | 14 +- reference/trader/functions/trader-sar.xml | 22 +- reference/trader/functions/trader-sarext.xml | 46 +- .../trader/functions/trader-set-compat.xml | 12 +- .../functions/trader-set-unstable-period.xml | 20 +- reference/trader/functions/trader-sin.xml | 12 +- reference/trader/functions/trader-sinh.xml | 12 +- reference/trader/functions/trader-sma.xml | 14 +- reference/trader/functions/trader-sqrt.xml | 12 +- reference/trader/functions/trader-stddev.xml | 20 +- reference/trader/functions/trader-stoch.xml | 38 +- reference/trader/functions/trader-stochf.xml | 30 +- .../trader/functions/trader-stochrsi.xml | 26 +- reference/trader/functions/trader-sub.xml | 18 +- reference/trader/functions/trader-sum.xml | 14 +- reference/trader/functions/trader-t3.xml | 18 +- reference/trader/functions/trader-tan.xml | 12 +- reference/trader/functions/trader-tanh.xml | 12 +- reference/trader/functions/trader-tema.xml | 14 +- reference/trader/functions/trader-trange.xml | 18 +- reference/trader/functions/trader-trima.xml | 14 +- reference/trader/functions/trader-trix.xml | 14 +- reference/trader/functions/trader-tsf.xml | 14 +- .../trader/functions/trader-typprice.xml | 18 +- reference/trader/functions/trader-ultosc.xml | 30 +- reference/trader/functions/trader-var.xml | 20 +- .../trader/functions/trader-wclprice.xml | 18 +- reference/trader/functions/trader-willr.xml | 22 +- reference/trader/functions/trader-wma.xml | 14 +- reference/trader/ini.xml | 8 +- reference/trader/setup.xml | 14 +- reference/ui/configure.xml | 8 +- .../ui.draw.text.font.fontfamilies.xml | 8 +- reference/ui/functions/ui.quit.xml | 10 +- reference/ui/functions/ui.run.xml | 14 +- reference/ui/setup.xml | 28 +- reference/ui/ui.area.xml | 10 +- reference/ui/ui.control.xml | 6 +- reference/ui/ui.controls.box.xml | 12 +- reference/ui/ui.controls.button.xml | 10 +- reference/ui/ui.controls.check.xml | 10 +- reference/ui/ui.controls.colorbutton.xml | 10 +- reference/ui/ui.controls.combo.xml | 10 +- reference/ui/ui.controls.editablecombo.xml | 10 +- reference/ui/ui.controls.entry.xml | 10 +- reference/ui/ui.controls.form.xml | 14 +- reference/ui/ui.controls.grid.xml | 24 +- reference/ui/ui.controls.group.xml | 14 +- reference/ui/ui.controls.label.xml | 10 +- reference/ui/ui.controls.multilineentry.xml | 8 +- reference/ui/ui.controls.picker.xml | 10 +- reference/ui/ui.controls.progress.xml | 10 +- reference/ui/ui.controls.radio.xml | 10 +- reference/ui/ui.controls.separator.xml | 8 +- reference/ui/ui.controls.slider.xml | 10 +- reference/ui/ui.controls.spin.xml | 10 +- reference/ui/ui.controls.tab.xml | 14 +- reference/ui/ui.draw.brush.gradient.xml | 8 +- reference/ui/ui.draw.brush.lineargradient.xml | 10 +- reference/ui/ui.draw.brush.radialgradient.xml | 10 +- reference/ui/ui.draw.brush.xml | 10 +- reference/ui/ui.draw.color.xml | 20 +- reference/ui/ui.draw.line.cap.xml | 4 +- reference/ui/ui.draw.line.join.xml | 4 +- reference/ui/ui.draw.matrix.xml | 6 +- reference/ui/ui.draw.path.xml | 12 +- reference/ui/ui.draw.pen.xml | 6 +- reference/ui/ui.draw.stroke.xml | 6 +- reference/ui/ui.draw.text.font.descriptor.xml | 6 +- reference/ui/ui.draw.text.font.italic.xml | 4 +- reference/ui/ui.draw.text.font.stretch.xml | 4 +- reference/ui/ui.draw.text.font.weight.xml | 4 +- reference/ui/ui.draw.text.font.xml | 6 +- reference/ui/ui.draw.text.layout.xml | 8 +- .../ui.exception.invalidargumentexception.xml | 10 +- .../ui/ui.exception.runtimeexception.xml | 10 +- reference/ui/ui.executor.xml | 6 +- reference/ui/ui.key.xml | 4 +- reference/ui/ui.menu.xml | 6 +- reference/ui/ui.menuitem.xml | 6 +- reference/ui/ui.point.xml | 16 +- reference/ui/ui.size.xml | 14 +- reference/ui/ui.window.xml | 14 +- reference/ui/ui/area/ondraw.xml | 20 +- reference/ui/ui/area/onkey.xml | 22 +- reference/ui/ui/area/onmouse.xml | 16 +- reference/ui/ui/area/redraw.xml | 10 +- reference/ui/ui/area/scrollto.xml | 12 +- reference/ui/ui/area/setsize.xml | 8 +- reference/ui/ui/control/destroy.xml | 10 +- reference/ui/ui/control/disable.xml | 10 +- reference/ui/ui/control/enable.xml | 10 +- reference/ui/ui/control/getparent.xml | 10 +- reference/ui/ui/control/gettoplevel.xml | 10 +- reference/ui/ui/control/hide.xml | 10 +- reference/ui/ui/control/isenabled.xml | 10 +- reference/ui/ui/control/isvisible.xml | 10 +- reference/ui/ui/control/setparent.xml | 14 +- reference/ui/ui/control/show.xml | 10 +- reference/ui/ui/controls/box/append.xml | 16 +- reference/ui/ui/controls/box/construct.xml | 8 +- reference/ui/ui/controls/box/delete.xml | 12 +- .../ui/ui/controls/box/getorientation.xml | 4 +- reference/ui/ui/controls/box/ispadded.xml | 4 +- reference/ui/ui/controls/box/setpadded.xml | 10 +- reference/ui/ui/controls/button/construct.xml | 8 +- reference/ui/ui/controls/button/gettext.xml | 8 +- reference/ui/ui/controls/button/onclick.xml | 4 +- reference/ui/ui/controls/button/settext.xml | 8 +- reference/ui/ui/controls/check/construct.xml | 8 +- reference/ui/ui/controls/check/gettext.xml | 8 +- reference/ui/ui/controls/check/ischecked.xml | 4 +- reference/ui/ui/controls/check/ontoggle.xml | 4 +- reference/ui/ui/controls/check/setchecked.xml | 8 +- reference/ui/ui/controls/check/settext.xml | 8 +- .../ui/ui/controls/colorbutton/getcolor.xml | 10 +- .../ui/ui/controls/colorbutton/onchange.xml | 4 +- .../ui/ui/controls/colorbutton/setcolor.xml | 8 +- reference/ui/ui/controls/combo/append.xml | 8 +- .../ui/ui/controls/combo/getselected.xml | 4 +- reference/ui/ui/controls/combo/onselected.xml | 4 +- .../ui/ui/controls/combo/setselected.xml | 8 +- .../ui/ui/controls/editablecombo/append.xml | 8 +- .../ui/ui/controls/editablecombo/gettext.xml | 4 +- .../ui/ui/controls/editablecombo/onchange.xml | 4 +- .../ui/ui/controls/editablecombo/settext.xml | 8 +- reference/ui/ui/controls/entry/construct.xml | 8 +- reference/ui/ui/controls/entry/gettext.xml | 8 +- reference/ui/ui/controls/entry/isreadonly.xml | 10 +- reference/ui/ui/controls/entry/onchange.xml | 4 +- .../ui/ui/controls/entry/setreadonly.xml | 10 +- reference/ui/ui/controls/entry/settext.xml | 8 +- reference/ui/ui/controls/form/append.xml | 20 +- reference/ui/ui/controls/form/delete.xml | 8 +- reference/ui/ui/controls/form/ispadded.xml | 4 +- reference/ui/ui/controls/form/setpadded.xml | 10 +- reference/ui/ui/controls/grid/append.xml | 62 +-- reference/ui/ui/controls/grid/ispadded.xml | 4 +- reference/ui/ui/controls/grid/setpadded.xml | 10 +- reference/ui/ui/controls/group/append.xml | 8 +- reference/ui/ui/controls/group/construct.xml | 8 +- reference/ui/ui/controls/group/gettitle.xml | 8 +- reference/ui/ui/controls/group/hasmargin.xml | 4 +- reference/ui/ui/controls/group/setmargin.xml | 10 +- reference/ui/ui/controls/group/settitle.xml | 8 +- reference/ui/ui/controls/label/construct.xml | 8 +- reference/ui/ui/controls/label/gettext.xml | 10 +- reference/ui/ui/controls/label/settext.xml | 8 +- .../ui/ui/controls/multilineentry/append.xml | 8 +- .../ui/controls/multilineentry/construct.xml | 8 +- .../ui/ui/controls/multilineentry/gettext.xml | 4 +- .../ui/controls/multilineentry/isreadonly.xml | 4 +- .../ui/controls/multilineentry/onchange.xml | 4 +- .../controls/multilineentry/setreadonly.xml | 10 +- .../ui/ui/controls/multilineentry/settext.xml | 8 +- reference/ui/ui/controls/picker/construct.xml | 8 +- .../ui/ui/controls/progress/getvalue.xml | 4 +- .../ui/ui/controls/progress/setvalue.xml | 8 +- reference/ui/ui/controls/radio/append.xml | 8 +- .../ui/ui/controls/radio/getselected.xml | 4 +- reference/ui/ui/controls/radio/onselected.xml | 4 +- .../ui/ui/controls/radio/setselected.xml | 8 +- .../ui/ui/controls/separator/construct.xml | 4 +- reference/ui/ui/controls/slider/construct.xml | 12 +- reference/ui/ui/controls/slider/getvalue.xml | 4 +- reference/ui/ui/controls/slider/onchange.xml | 4 +- reference/ui/ui/controls/slider/setvalue.xml | 8 +- reference/ui/ui/controls/spin/construct.xml | 12 +- reference/ui/ui/controls/spin/getvalue.xml | 4 +- reference/ui/ui/controls/spin/onchange.xml | 4 +- reference/ui/ui/controls/spin/setvalue.xml | 8 +- reference/ui/ui/controls/tab/append.xml | 16 +- reference/ui/ui/controls/tab/delete.xml | 12 +- reference/ui/ui/controls/tab/hasmargin.xml | 14 +- reference/ui/ui/controls/tab/insertat.xml | 16 +- reference/ui/ui/controls/tab/pages.xml | 8 +- reference/ui/ui/controls/tab/setmargin.xml | 12 +- .../ui/ui/draw/brush.gradient/addstop.xml | 12 +- .../ui/ui/draw/brush.gradient/delstop.xml | 14 +- .../ui/ui/draw/brush.gradient/setstop.xml | 20 +- .../draw/brush.lineargradient/construct.xml | 18 +- .../draw/brush.radialgradient/construct.xml | 24 +- reference/ui/ui/draw/brush/construct.xml | 8 +- reference/ui/ui/draw/brush/getcolor.xml | 8 +- reference/ui/ui/draw/brush/setcolor.xml | 14 +- reference/ui/ui/draw/color/construct.xml | 10 +- reference/ui/ui/draw/color/getchannel.xml | 12 +- reference/ui/ui/draw/color/setchannel.xml | 18 +- reference/ui/ui/draw/matrix/invert.xml | 4 +- reference/ui/ui/draw/matrix/isinvertible.xml | 4 +- reference/ui/ui/draw/matrix/multiply.xml | 8 +- reference/ui/ui/draw/matrix/rotate.xml | 16 +- reference/ui/ui/draw/matrix/scale.xml | 16 +- reference/ui/ui/draw/matrix/skew.xml | 16 +- reference/ui/ui/draw/matrix/translate.xml | 10 +- reference/ui/ui/draw/path/addrectangle.xml | 12 +- reference/ui/ui/draw/path/arcto.xml | 32 +- reference/ui/ui/draw/path/bezierto.xml | 26 +- reference/ui/ui/draw/path/closefigure.xml | 4 +- reference/ui/ui/draw/path/construct.xml | 8 +- reference/ui/ui/draw/path/end.xml | 4 +- reference/ui/ui/draw/path/lineto.xml | 38 +- reference/ui/ui/draw/path/newfigure.xml | 8 +- .../ui/ui/draw/path/newfigurewitharc.xml | 42 +- reference/ui/ui/draw/pen/clip.xml | 8 +- reference/ui/ui/draw/pen/fill.xml | 12 +- reference/ui/ui/draw/pen/restore.xml | 4 +- reference/ui/ui/draw/pen/save.xml | 4 +- reference/ui/ui/draw/pen/stroke.xml | 16 +- reference/ui/ui/draw/pen/transform.xml | 8 +- reference/ui/ui/draw/pen/write.xml | 12 +- reference/ui/ui/draw/stroke/construct.xml | 20 +- reference/ui/ui/draw/stroke/getcap.xml | 8 +- reference/ui/ui/draw/stroke/getjoin.xml | 8 +- reference/ui/ui/draw/stroke/getmiterlimit.xml | 8 +- reference/ui/ui/draw/stroke/getthickness.xml | 8 +- reference/ui/ui/draw/stroke/setcap.xml | 8 +- reference/ui/ui/draw/stroke/setjoin.xml | 14 +- reference/ui/ui/draw/stroke/setmiterlimit.xml | 8 +- reference/ui/ui/draw/stroke/setthickness.xml | 8 +- .../draw/text/font.descriptor/construct.xml | 26 +- .../draw/text/font.descriptor/getfamily.xml | 10 +- .../draw/text/font.descriptor/getitalic.xml | 10 +- .../ui/draw/text/font.descriptor/getsize.xml | 10 +- .../draw/text/font.descriptor/getstretch.xml | 10 +- .../draw/text/font.descriptor/getweight.xml | 10 +- reference/ui/ui/draw/text/font/construct.xml | 8 +- reference/ui/ui/draw/text/font/getascent.xml | 10 +- reference/ui/ui/draw/text/font/getdescent.xml | 10 +- reference/ui/ui/draw/text/font/getleading.xml | 10 +- .../draw/text/font/getunderlineposition.xml | 10 +- .../draw/text/font/getunderlinethickness.xml | 10 +- .../ui/ui/draw/text/layout/construct.xml | 16 +- reference/ui/ui/draw/text/layout/setcolor.xml | 16 +- reference/ui/ui/draw/text/layout/setwidth.xml | 8 +- reference/ui/ui/executor/construct.xml | 16 +- reference/ui/ui/executor/kill.xml | 10 +- reference/ui/ui/executor/onexecute.xml | 10 +- reference/ui/ui/executor/setinterval.xml | 20 +- reference/ui/ui/menu/append.xml | 16 +- reference/ui/ui/menu/appendabout.xml | 12 +- reference/ui/ui/menu/appendcheck.xml | 16 +- reference/ui/ui/menu/appendpreferences.xml | 12 +- reference/ui/ui/menu/appendquit.xml | 12 +- reference/ui/ui/menu/appendseparator.xml | 4 +- reference/ui/ui/menu/construct.xml | 8 +- reference/ui/ui/menuitem/disable.xml | 4 +- reference/ui/ui/menuitem/enable.xml | 4 +- reference/ui/ui/menuitem/ischecked.xml | 4 +- reference/ui/ui/menuitem/onclick.xml | 4 +- reference/ui/ui/menuitem/setchecked.xml | 8 +- reference/ui/ui/point/at.xml | 16 +- reference/ui/ui/point/construct.xml | 12 +- reference/ui/ui/point/getx.xml | 8 +- reference/ui/ui/point/gety.xml | 8 +- reference/ui/ui/point/setx.xml | 14 +- reference/ui/ui/point/sety.xml | 14 +- reference/ui/ui/size/construct.xml | 14 +- reference/ui/ui/size/getheight.xml | 8 +- reference/ui/ui/size/getwidth.xml | 8 +- reference/ui/ui/size/of.xml | 16 +- reference/ui/ui/size/setheight.xml | 14 +- reference/ui/ui/size/setwidth.xml | 14 +- reference/ui/ui/window/add.xml | 14 +- reference/ui/ui/window/construct.xml | 18 +- reference/ui/ui/window/error.xml | 12 +- reference/ui/ui/window/getsize.xml | 10 +- reference/ui/ui/window/gettitle.xml | 10 +- reference/ui/ui/window/hasborders.xml | 10 +- reference/ui/ui/window/hasmargin.xml | 10 +- reference/ui/ui/window/isfullscreen.xml | 6 +- reference/ui/ui/window/msg.xml | 12 +- reference/ui/ui/window/onclosing.xml | 12 +- reference/ui/ui/window/open.xml | 8 +- reference/ui/ui/window/save.xml | 8 +- reference/ui/ui/window/setborders.xml | 10 +- reference/ui/ui/window/setfullscreen.xml | 10 +- reference/ui/ui/window/setmargin.xml | 10 +- reference/ui/ui/window/setsize.xml | 16 +- reference/ui/ui/window/settitle.xml | 8 +- reference/uopz/book.xml | 12 +- reference/uopz/configure.xml | 8 +- reference/uopz/constants.xml | 12 +- .../uopz/functions/uopz-add-function.xml | 34 +- reference/uopz/functions/uopz-allow-exit.xml | 16 +- reference/uopz/functions/uopz-backup.xml | 18 +- reference/uopz/functions/uopz-compose.xml | 28 +- reference/uopz/functions/uopz-copy.xml | 16 +- .../uopz/functions/uopz-del-function.xml | 26 +- reference/uopz/functions/uopz-delete.xml | 18 +- reference/uopz/functions/uopz-extend.xml | 18 +- reference/uopz/functions/uopz-flags.xml | 24 +- reference/uopz/functions/uopz-function.xml | 26 +- .../uopz/functions/uopz-get-exit-status.xml | 14 +- reference/uopz/functions/uopz-get-hook.xml | 16 +- reference/uopz/functions/uopz-get-mock.xml | 12 +- .../uopz/functions/uopz-get-property.xml | 20 +- reference/uopz/functions/uopz-get-return.xml | 16 +- reference/uopz/functions/uopz-get-static.xml | 16 +- reference/uopz/functions/uopz-implement.xml | 20 +- reference/uopz/functions/uopz-overload.xml | 20 +- reference/uopz/functions/uopz-redefine.xml | 20 +- reference/uopz/functions/uopz-rename.xml | 26 +- reference/uopz/functions/uopz-restore.xml | 18 +- reference/uopz/functions/uopz-set-hook.xml | 20 +- reference/uopz/functions/uopz-set-mock.xml | 28 +- .../uopz/functions/uopz-set-property.xml | 24 +- reference/uopz/functions/uopz-set-return.xml | 28 +- reference/uopz/functions/uopz-undefine.xml | 16 +- reference/uopz/functions/uopz-unset-hook.xml | 16 +- reference/uopz/functions/uopz-unset-mock.xml | 18 +- .../uopz/functions/uopz-unset-return.xml | 16 +- reference/uopz/functions/uopz_set_static.xml | 20 +- reference/uopz/setup.xml | 28 +- reference/v8js/book.xml | 4 +- reference/v8js/configure.xml | 6 +- reference/v8js/examples.xml | 4 +- reference/v8js/ini.xml | 8 +- reference/v8js/setup.xml | 4 +- reference/v8js/v8js.xml | 14 +- reference/v8js/v8js/construct.xml | 22 +- reference/v8js/v8js/executestring.xml | 24 +- reference/v8js/v8js/getextensions.xml | 8 +- reference/v8js/v8js/getpendingexception.xml | 12 +- reference/v8js/v8js/registerextension.xml | 24 +- reference/v8js/v8jsexception.xml | 22 +- .../v8js/v8jsexception/getjsfilename.xml | 8 +- .../v8js/v8jsexception/getjslinenumber.xml | 8 +- .../v8js/v8jsexception/getjssourceline.xml | 8 +- reference/v8js/v8jsexception/getjstrace.xml | 8 +- reference/var_representation/constants.xml | 2 +- .../functions/var-representation.xml | 16 +- reference/var_representation/setup.xml | 12 +- reference/varnish/book.xml | 4 +- reference/varnish/configure.xml | 6 +- reference/varnish/examples.xml | 16 +- reference/varnish/setup.xml | 12 +- reference/varnish/varnishadmin.xml | 6 +- reference/varnish/varnishadmin/auth.xml | 8 +- reference/varnish/varnishadmin/ban.xml | 14 +- reference/varnish/varnishadmin/banurl.xml | 14 +- reference/varnish/varnishadmin/clearpanic.xml | 10 +- reference/varnish/varnishadmin/connect.xml | 8 +- reference/varnish/varnishadmin/construct.xml | 12 +- reference/varnish/varnishadmin/disconnect.xml | 8 +- reference/varnish/varnishadmin/getpanic.xml | 12 +- reference/varnish/varnishadmin/getparams.xml | 8 +- reference/varnish/varnishadmin/isrunning.xml | 8 +- reference/varnish/varnishadmin/setcompat.xml | 12 +- reference/varnish/varnishadmin/sethost.xml | 12 +- reference/varnish/varnishadmin/setident.xml | 12 +- reference/varnish/varnishadmin/setparam.xml | 16 +- reference/varnish/varnishadmin/setport.xml | 12 +- reference/varnish/varnishadmin/setsecret.xml | 12 +- reference/varnish/varnishadmin/settimeout.xml | 12 +- reference/varnish/varnishadmin/start.xml | 8 +- reference/varnish/varnishadmin/stop.xml | 8 +- reference/varnish/varnishexception.xml | 10 +- reference/varnish/varnishlog.xml | 108 ++--- reference/varnish/varnishlog/construct.xml | 12 +- reference/varnish/varnishlog/getline.xml | 8 +- reference/varnish/varnishlog/gettagname.xml | 12 +- reference/varnish/varnishstat.xml | 6 +- reference/varnish/varnishstat/construct.xml | 12 +- reference/varnish/varnishstat/getsnapshot.xml | 8 +- reference/wddx/book.xml | 8 +- reference/wddx/configure.xml | 12 +- reference/wddx/examples.xml | 18 +- reference/wddx/functions/wddx-add-vars.xml | 22 +- reference/wddx/functions/wddx-deserialize.xml | 18 +- reference/wddx/functions/wddx-packet-end.xml | 14 +- .../wddx/functions/wddx-packet-start.xml | 14 +- .../wddx/functions/wddx-serialize-value.xml | 18 +- .../wddx/functions/wddx-serialize-vars.xml | 18 +- reference/wddx/setup.xml | 8 +- reference/win32service/book.xml | 10 +- reference/win32service/constants.xml | 44 +- .../win32-add-right-access-service.xml | 42 +- .../functions/win32-add-service-env-var.xml | 38 +- .../functions/win32-continue-service.xml | 50 +-- .../functions/win32-create-service.xml | 256 +++++------ .../functions/win32-delete-service.xml | 46 +- .../win32-get-last-control-message.xml | 50 +-- .../functions/win32-get-service-env-vars.xml | 24 +- .../functions/win32-pause-service.xml | 40 +- .../functions/win32-query-service-status.xml | 72 ++-- .../win32-read-all-rights-access-service.xml | 28 +- .../win32-read-right-access-service.xml | 38 +- .../win32-remove-right-access-service.xml | 38 +- .../win32-remove-service-env-var.xml | 34 +- .../functions/win32-send-custom-control.xml | 56 +-- .../functions/win32-set-service-exit-code.xml | 46 +- .../functions/win32-set-service-exit-mode.xml | 36 +- .../win32-set-service-pause-resume-state.xml | 30 +- .../functions/win32-set-service-status.xml | 54 +-- .../win32-start-service-ctrl-dispatcher.xml | 58 +-- .../functions/win32-start-service.xml | 42 +- .../functions/win32-stop-service.xml | 40 +- .../win32service/rightinfo/construct.xml | 4 +- .../win32service/rightinfo/get-domain.xml | 8 +- .../rightinfo/get-full-username.xml | 4 +- .../win32service/rightinfo/get-rights.xml | 16 +- .../win32service/rightinfo/get-username.xml | 8 +- .../win32service/rightinfo/is-deny-access.xml | 8 +- .../rightinfo/is-grant-access.xml | 8 +- reference/win32service/setup.xml | 24 +- .../win32service/win32serviceexception.xml | 4 +- .../win32service/win32servicerightinfo.xml | 4 +- reference/wincache/book.xml | 32 +- .../functions/wincache-fcache-fileinfo.xml | 14 +- .../functions/wincache-fcache-meminfo.xml | 8 +- .../wincache/functions/wincache-lock.xml | 26 +- .../functions/wincache-ocache-fileinfo.xml | 16 +- .../functions/wincache-ocache-meminfo.xml | 8 +- .../functions/wincache-refresh-if-changed.xml | 36 +- .../functions/wincache-rplist-fileinfo.xml | 18 +- .../functions/wincache-rplist-meminfo.xml | 8 +- .../functions/wincache-scache-info.xml | 16 +- .../functions/wincache-scache-meminfo.xml | 22 +- .../functions/wincache-ucache-add.xml | 56 +-- .../functions/wincache-ucache-cas.xml | 36 +- .../functions/wincache-ucache-clear.xml | 26 +- .../functions/wincache-ucache-dec.xml | 30 +- .../functions/wincache-ucache-delete.xml | 40 +- .../functions/wincache-ucache-exists.xml | 18 +- .../functions/wincache-ucache-get.xml | 44 +- .../functions/wincache-ucache-inc.xml | 30 +- .../functions/wincache-ucache-info.xml | 50 +-- .../functions/wincache-ucache-meminfo.xml | 22 +- .../functions/wincache-ucache-set.xml | 44 +- .../wincache/functions/wincache-unlock.xml | 20 +- reference/wincache/ini.xml | 132 +++--- reference/wincache/setup.xml | 44 +- reference/wincache/win32build.xml | 32 +- reference/wkhtmltox/book.xml | 6 +- reference/wkhtmltox/configure.xml | 4 +- reference/wkhtmltox/ini.xml | 8 +- reference/wkhtmltox/setup.xml | 12 +- .../wkhtmltox/wkhtmltox.image.converter.xml | 6 +- .../wkhtmltox/wkhtmltox.pdf.converter.xml | 4 +- reference/wkhtmltox/wkhtmltox.pdf.object.xml | 6 +- .../wkhtmltox/image/converter/construct.xml | 10 +- .../wkhtmltox/image/converter/convert.xml | 8 +- .../wkhtmltox/image/converter/getversion.xml | 12 +- .../wkhtmltox/wkhtmltox/pdf/converter/add.xml | 10 +- .../wkhtmltox/pdf/converter/construct.xml | 6 +- .../wkhtmltox/pdf/converter/convert.xml | 8 +- .../wkhtmltox/pdf/converter/getversion.xml | 8 +- .../wkhtmltox/pdf/object/construct.xml | 10 +- reference/xattr/book.xml | 10 +- reference/xattr/configure.xml | 8 +- reference/xattr/constants.xml | 8 +- reference/xattr/functions/xattr-get.xml | 20 +- reference/xattr/functions/xattr-list.xml | 16 +- reference/xattr/functions/xattr-remove.xml | 16 +- reference/xattr/functions/xattr-set.xml | 26 +- reference/xattr/functions/xattr-supported.xml | 18 +- reference/xattr/setup.xml | 8 +- reference/xdiff/book.xml | 26 +- reference/xdiff/configure.xml | 8 +- reference/xdiff/constants.xml | 4 +- .../xdiff/functions/xdiff-file-bdiff-size.xml | 20 +- .../xdiff/functions/xdiff-file-bdiff.xml | 30 +- .../xdiff/functions/xdiff-file-bpatch.xml | 34 +- .../functions/xdiff-file-diff-binary.xml | 34 +- reference/xdiff/functions/xdiff-file-diff.xml | 42 +- .../xdiff/functions/xdiff-file-merge3.xml | 34 +- .../functions/xdiff-file-patch-binary.xml | 38 +- .../xdiff/functions/xdiff-file-patch.xml | 44 +- .../xdiff/functions/xdiff-file-rabdiff.xml | 36 +- .../functions/xdiff-string-bdiff-size.xml | 20 +- .../xdiff/functions/xdiff-string-bdiff.xml | 18 +- .../xdiff/functions/xdiff-string-bpatch.xml | 20 +- .../functions/xdiff-string-diff-binary.xml | 22 +- .../xdiff/functions/xdiff-string-diff.xml | 40 +- .../xdiff/functions/xdiff-string-merge3.xml | 30 +- .../functions/xdiff-string-patch-binary.xml | 24 +- .../xdiff/functions/xdiff-string-patch.xml | 44 +- .../xdiff/functions/xdiff-string-rabdiff.xml | 24 +- reference/xdiff/setup.xml | 8 +- reference/xhprof/book.xml | 24 +- reference/xhprof/configure.xml | 4 +- reference/xhprof/examples.xml | 4 +- reference/xhprof/functions/xhprof-disable.xml | 8 +- reference/xhprof/functions/xhprof-enable.xml | 18 +- .../functions/xhprof-sample-disable.xml | 8 +- .../xhprof/functions/xhprof-sample-enable.xml | 8 +- reference/xhprof/ini.xml | 6 +- reference/xhprof/setup.xml | 8 +- reference/xlswriter/book.xml | 4 +- reference/xlswriter/configure.xml | 4 +- reference/xlswriter/setup.xml | 16 +- reference/xlswriter/xlsx-format.xml | 36 +- reference/xlswriter/xlsx-format/align.xml | 16 +- reference/xlswriter/xlsx-format/bold.xml | 12 +- reference/xlswriter/xlsx-format/italic.xml | 12 +- reference/xlswriter/xlsx-format/underline.xml | 16 +- reference/xlswriter/xlsx-kernel.xml | 4 +- reference/xlswriter/xlsx-kernel/add-sheet.xml | 12 +- .../xlswriter/xlsx-kernel/auto-filter.xml | 12 +- .../xlswriter/xlsx-kernel/const-memory.xml | 16 +- reference/xlswriter/xlsx-kernel/construct.xml | 8 +- reference/xlswriter/xlsx-kernel/data.xml | 12 +- reference/xlswriter/xlsx-kernel/file-name.xml | 16 +- .../xlswriter/xlsx-kernel/get-handle.xml | 8 +- reference/xlswriter/xlsx-kernel/header.xml | 12 +- .../xlswriter/xlsx-kernel/insert-formula.xml | 20 +- .../xlswriter/xlsx-kernel/insert-image.xml | 20 +- .../xlswriter/xlsx-kernel/insert-text.xml | 24 +- .../xlswriter/xlsx-kernel/merge-cells.xml | 16 +- reference/xlswriter/xlsx-kernel/output.xml | 10 +- .../xlswriter/xlsx-kernel/set-column.xml | 20 +- reference/xlswriter/xlsx-kernel/set-row.xml | 20 +- reference/xmldiff/book.xml | 4 +- reference/xmldiff/configure.xml | 8 +- reference/xmldiff/setup.xml | 14 +- reference/xmldiff/xmldiff-base/construct.xml | 8 +- reference/xmldiff/xmldiff-base/diff.xml | 22 +- reference/xmldiff/xmldiff-base/merge.xml | 22 +- reference/xmldiff/xmldiff-dom/diff.xml | 18 +- reference/xmldiff/xmldiff-dom/merge.xml | 22 +- reference/xmldiff/xmldiff-file/diff.xml | 20 +- reference/xmldiff/xmldiff-file/merge.xml | 18 +- reference/xmldiff/xmldiff-memory/diff.xml | 20 +- reference/xmldiff/xmldiff-memory/merge.xml | 20 +- reference/xmldiff/xmldiff.base.xml | 6 +- reference/xmldiff/xmldiff.dom.xml | 10 +- reference/xmldiff/xmldiff.exception.xml | 8 +- reference/xmldiff/xmldiff.file.xml | 10 +- reference/xmldiff/xmldiff.memory.xml | 10 +- reference/xmlrpc/book.xml | 4 +- reference/xmlrpc/configure.xml | 4 +- reference/xmlrpc/functions/xmlrpc-decode.xml | 18 +- .../functions/xmlrpc-encode-request.xml | 26 +- .../xmlrpc/functions/xmlrpc-get-type.xml | 14 +- .../xmlrpc/functions/xmlrpc-is-fault.xml | 14 +- .../xmlrpc/functions/xmlrpc-set-type.xml | 24 +- reference/xmlrpc/setup.xml | 4 +- reference/yac/yac.xml | 4 +- reference/yaconf/configure.xml | 6 +- reference/yaconf/setup.xml | 20 +- reference/yaconf/yaconf.xml | 4 +- reference/yaf/appconfig.xml | 86 ++-- reference/yaf/book.xml | 8 +- reference/yaf/configure.xml | 6 +- reference/yaf/setup.xml | 12 +- reference/yaf/yaf-action-abstract.xml | 14 +- reference/yaf/yaf-bootstrap-abstract.xml | 20 +- reference/yaf/yaf-config-abstract.xml | 8 +- reference/yaf/yaf-config-ini.xml | 24 +- reference/yaf/yaf-config-simple.xml | 14 +- reference/yaf/yaf-controller-abstract.xml | 24 +- reference/yaf/yaf-dispatcher.xml | 16 +- .../yaf/yaf-exception-dispatchfailed.xml | 8 +- .../yaf/yaf-exception-loadfailed-action.xml | 8 +- .../yaf-exception-loadfailed-controller.xml | 8 +- .../yaf/yaf-exception-loadfailed-module.xml | 8 +- .../yaf/yaf-exception-loadfailed-view.xml | 8 +- reference/yaf/yaf-exception-loadfailed.xml | 6 +- reference/yaf/yaf-exception-routerfailed.xml | 8 +- reference/yaf/yaf-exception-startuperror.xml | 8 +- reference/yaf/yaf-exception-typeerror.xml | 8 +- reference/yaf/yaf-exception.xml | 8 +- reference/yaf/yaf-loader.xml | 60 +-- reference/yaf/yaf-plugin-abstract.xml | 8 +- reference/yaf/yaf-registry.xml | 8 +- reference/yaf/yaf-request-abstract.xml | 26 +- reference/yaf/yaf-request-http.xml | 32 +- reference/yaf/yaf-request-simple.xml | 30 +- reference/yaf/yaf-response-cli.xml | 12 +- reference/yaf/yaf-response-http.xml | 14 +- reference/yaf/yaf-route-interface.xml | 2 +- reference/yaf/yaf-route-map.xml | 10 +- reference/yaf/yaf-route-regex.xml | 18 +- reference/yaf/yaf-route-rewrite.xml | 16 +- reference/yaf/yaf-route-simple.xml | 12 +- reference/yaf/yaf-route-static.xml | 4 +- reference/yaf/yaf-route-supervar.xml | 8 +- reference/yaf/yaf-router.xml | 28 +- reference/yaf/yaf-session.xml | 12 +- reference/yaf/yaf-view-interface.xml | 8 +- reference/yaf/yaf-view-simple.xml | 14 +- reference/yaf/yaf_action_abstract/execute.xml | 10 +- .../yaf/yaf_application/getdispatcher.xml | 6 +- .../yaf/yaf_dispatcher/registerplugin.xml | 4 +- reference/yaf/yaf_dispatcher/setview.xml | 32 +- .../yaf_request_abstract/setactionname.xml | 10 +- .../yaf/yaf_request_abstract/setbaseuri.xml | 4 +- .../setcontrollername.xml | 14 +- .../yaf_request_abstract/setmodulename.xml | 14 +- reference/yaf/yaf_request_http/construct.xml | 8 +- .../yaf/yaf_request_simple/construct.xml | 8 +- .../yaf/yaf_route_interface/assemble.xml | 22 +- reference/yaf/yaf_route_interface/route.xml | 20 +- reference/yaf/yaf_route_map/assemble.xml | 26 +- reference/yaf/yaf_route_regex/assemble.xml | 20 +- reference/yaf/yaf_route_regex/construct.xml | 4 +- reference/yaf/yaf_route_rewrite/assemble.xml | 20 +- reference/yaf/yaf_route_rewrite/construct.xml | 36 +- reference/yaf/yaf_route_simple/assemble.xml | 26 +- reference/yaf/yaf_route_static/assemble.xml | 26 +- reference/yaf/yaf_route_supervar/assemble.xml | 26 +- reference/yaf/yaf_router/addconfig.xml | 12 +- reference/yaf/yaf_router/addroute.xml | 28 +- reference/yaf/yaf_router/construct.xml | 8 +- reference/yaf/yaf_router/getcurrentroute.xml | 18 +- reference/yaf/yaf_router/getroute.xml | 12 +- reference/yaf/yaf_router/getroutes.xml | 8 +- reference/yaml/book.xml | 4 +- reference/yaml/callbacks.xml | 10 +- reference/yaml/constants.xml | 4 +- reference/yaml/functions/yaml-emit-file.xml | 28 +- reference/yaml/functions/yaml-emit.xml | 24 +- reference/yaml/functions/yaml-parse-file.xml | 24 +- reference/yaml/functions/yaml-parse-url.xml | 28 +- reference/yaml/functions/yaml-parse.xml | 28 +- reference/yaml/ini.xml | 24 +- reference/yaml/setup.xml | 12 +- reference/yaz/book.xml | 16 +- reference/yaz/configure.xml | 20 +- reference/yaz/examples.xml | 10 +- reference/yaz/functions/yaz-addinfo.xml | 18 +- reference/yaz/functions/yaz-ccl-conf.xml | 44 +- reference/yaz/functions/yaz-ccl-parse.xml | 58 +-- reference/yaz/functions/yaz-close.xml | 16 +- reference/yaz/functions/yaz-connect.xml | 100 ++--- reference/yaz/functions/yaz-database.xml | 22 +- reference/yaz/functions/yaz-element.xml | 28 +- reference/yaz/functions/yaz-errno.xml | 22 +- reference/yaz/functions/yaz-error.xml | 12 +- reference/yaz/functions/yaz-es-result.xml | 12 +- reference/yaz/functions/yaz-es.xml | 26 +- reference/yaz/functions/yaz-get-option.xml | 18 +- reference/yaz/functions/yaz-hits.xml | 34 +- reference/yaz/functions/yaz-itemorder.xml | 30 +- reference/yaz/functions/yaz-present.xml | 18 +- reference/yaz/functions/yaz-range.xml | 28 +- reference/yaz/functions/yaz-record.xml | 106 ++--- reference/yaz/functions/yaz-scan-result.xml | 42 +- reference/yaz/functions/yaz-scan.xml | 48 +-- reference/yaz/functions/yaz-schema.xml | 28 +- reference/yaz/functions/yaz-search.xml | 56 +-- reference/yaz/functions/yaz-set-option.xml | 36 +- reference/yaz/functions/yaz-sort.xml | 52 +-- reference/yaz/functions/yaz-syntax.xml | 24 +- reference/yaz/functions/yaz-wait.xml | 26 +- reference/yaz/setup.xml | 4 +- reference/zmq/book.xml | 4 +- reference/zmq/setup.xml | 12 +- reference/zmq/zmq.xml | 128 +++--- reference/zmq/zmq/construct.xml | 8 +- reference/zmq/zmqcontext.xml | 6 +- reference/zmq/zmqcontext/construct.xml | 26 +- reference/zmq/zmqcontext/getopt.xml | 16 +- reference/zmq/zmqcontext/getsocket.xml | 32 +- reference/zmq/zmqcontext/ispersistent.xml | 8 +- reference/zmq/zmqcontext/setopt.xml | 16 +- reference/zmq/zmqcontextexception.xml | 12 +- reference/zmq/zmqdevice.xml | 6 +- reference/zmq/zmqdevice/construct.xml | 20 +- reference/zmq/zmqdevice/getidletimeout.xml | 8 +- reference/zmq/zmqdevice/gettimertimeout.xml | 8 +- reference/zmq/zmqdevice/run.xml | 8 +- reference/zmq/zmqdevice/setidlecallback.xml | 22 +- reference/zmq/zmqdevice/setidletimeout.xml | 12 +- reference/zmq/zmqdevice/settimercallback.xml | 14 +- reference/zmq/zmqdevice/settimertimeout.xml | 12 +- reference/zmq/zmqdeviceexception.xml | 12 +- reference/zmq/zmqexception.xml | 12 +- reference/zmq/zmqpoll.xml | 6 +- reference/zmq/zmqpoll/add.xml | 20 +- reference/zmq/zmqpoll/clear.xml | 8 +- reference/zmq/zmqpoll/count.xml | 8 +- reference/zmq/zmqpoll/getlasterrors.xml | 10 +- reference/zmq/zmqpoll/poll.xml | 38 +- reference/zmq/zmqpoll/remove.xml | 14 +- reference/zmq/zmqpollexception.xml | 12 +- reference/zmq/zmqsocket.xml | 6 +- reference/zmq/zmqsocket/bind.xml | 18 +- reference/zmq/zmqsocket/connect.xml | 28 +- reference/zmq/zmqsocket/construct.xml | 38 +- reference/zmq/zmqsocket/disconnect.xml | 12 +- reference/zmq/zmqsocket/getendpoints.xml | 10 +- reference/zmq/zmqsocket/getpersistentid.xml | 8 +- reference/zmq/zmqsocket/getsockettype.xml | 8 +- reference/zmq/zmqsocket/getsockopt.xml | 16 +- reference/zmq/zmqsocket/ispersistent.xml | 8 +- reference/zmq/zmqsocket/recv.xml | 30 +- reference/zmq/zmqsocket/recvmulti.xml | 18 +- reference/zmq/zmqsocket/send.xml | 22 +- reference/zmq/zmqsocket/sendmulti.xml | 22 +- reference/zmq/zmqsocket/setsockopt.xml | 16 +- reference/zmq/zmqsocket/unbind.xml | 14 +- reference/zmq/zmqsocketexception.xml | 12 +- reference/zookeeper/book.xml | 8 +- reference/zookeeper/configure.xml | 18 +- .../functions/zookeeper_dispatch.xml | 28 +- reference/zookeeper/ini.xml | 8 +- reference/zookeeper/setup.xml | 4 +- reference/zookeeper/zookeeper.xml | 148 +++---- reference/zookeeper/zookeeper/addauth.xml | 32 +- reference/zookeeper/zookeeper/close.xml | 8 +- reference/zookeeper/zookeeper/connect.xml | 28 +- reference/zookeeper/zookeeper/construct.xml | 24 +- reference/zookeeper/zookeeper/create.xml | 36 +- reference/zookeeper/zookeeper/delete.xml | 24 +- reference/zookeeper/zookeeper/exists.xml | 24 +- reference/zookeeper/zookeeper/get.xml | 36 +- reference/zookeeper/zookeeper/getacl.xml | 20 +- reference/zookeeper/zookeeper/getchildren.xml | 24 +- reference/zookeeper/zookeeper/getclientid.xml | 16 +- reference/zookeeper/zookeeper/getconfig.xml | 4 +- .../zookeeper/zookeeper/getrecvtimeout.xml | 12 +- reference/zookeeper/zookeeper/getstate.xml | 12 +- .../zookeeper/zookeeper/isrecoverable.xml | 16 +- reference/zookeeper/zookeeper/set.xml | 32 +- reference/zookeeper/zookeeper/setacl.xml | 28 +- .../zookeeper/zookeeper/setdebuglevel.xml | 20 +- .../zookeeper/setdeterministicconnorder.xml | 20 +- .../zookeeper/zookeeper/setlogstream.xml | 20 +- reference/zookeeper/zookeeper/setwatcher.xml | 16 +- .../zookeeperauthenticationexception.xml | 18 +- reference/zookeeper/zookeeperconfig.xml | 16 +- reference/zookeeper/zookeeperconfig/add.xml | 24 +- reference/zookeeper/zookeeperconfig/get.xml | 20 +- .../zookeeper/zookeeperconfig/remove.xml | 24 +- reference/zookeeper/zookeeperconfig/set.xml | 24 +- .../zookeeperconnectionexception.xml | 18 +- reference/zookeeper/zookeeperexception.xml | 18 +- .../zookeepermarshallingexception.xml | 18 +- .../zookeeper/zookeepernonodeexception.xml | 18 +- .../zookeeperoperationtimeoutexception.xml | 18 +- .../zookeeper/zookeepersessionexception.xml | 18 +- 4920 files changed, 26993 insertions(+), 26993 deletions(-) diff --git a/contributors.xml b/contributors.xml index 14a455ac5..026d0cecf 100644 --- a/contributors.xml +++ b/contributors.xml @@ -1,7 +1,7 @@ -
+
&Credit.Authors.and.Contributors; &Credit.Introduction; @@ -9,7 +9,7 @@
&Credit.Authors.and.Editors; - + &Credit.Past.Authors.Text; Mehdi Achour, Bill Abt, @@ -68,9 +68,9 @@ Jim Winstead, Jeroen van Wolffelaar&listendand; Andrei Zmievski. - + - + &Credit.Past.Editors.Text; Stig Bakken, Peter Cowburn, @@ -78,22 +78,22 @@ Hartmut Holzgraefe, Philip Olson&listendand; Egon Schmid. - +
&Credit.Note.Editors.Title; - + &Credit.Note.Editors.Active; Daniel Brown, Nuno Lopes, Felipe Pena, Thiago Pojda&listendand; Maciek Sokolewicz. - + - + &Credit.Note.Editors.Inactive; Mehdi Achour, Daniel Beckham, @@ -133,7 +133,7 @@ Jim Winstead, Jared Wyles&listendand; Jeroen van Wolffelaar. - +
diff --git a/reference/apcu/apcuiterator.xml b/reference/apcu/apcuiterator.xml index 924907b12..7f921d666 100644 --- a/reference/apcu/apcuiterator.xml +++ b/reference/apcu/apcuiterator.xml @@ -1,6 +1,6 @@ - + The APCUIterator class APCUIterator diff --git a/reference/apcu/apcuiterator/construct.xml b/reference/apcu/apcuiterator/construct.xml index dee6e7e69..c1a1f5583 100644 --- a/reference/apcu/apcuiterator/construct.xml +++ b/reference/apcu/apcuiterator/construct.xml @@ -1,6 +1,6 @@ - + APCUIterator::__construct Constructs an APCUIterator iterator object diff --git a/reference/apcu/apcuiterator/current.xml b/reference/apcu/apcuiterator/current.xml index 5cce4dd5f..b861fd0be 100644 --- a/reference/apcu/apcuiterator/current.xml +++ b/reference/apcu/apcuiterator/current.xml @@ -1,6 +1,6 @@ - + APCUIterator::current Get current item diff --git a/reference/apcu/apcuiterator/gettotalcount.xml b/reference/apcu/apcuiterator/gettotalcount.xml index 719580b17..8b01c1a73 100644 --- a/reference/apcu/apcuiterator/gettotalcount.xml +++ b/reference/apcu/apcuiterator/gettotalcount.xml @@ -1,6 +1,6 @@ - + APCUIterator::getTotalCount Get total count diff --git a/reference/apcu/apcuiterator/gettotalhits.xml b/reference/apcu/apcuiterator/gettotalhits.xml index 34554fc8c..21ce52ee1 100644 --- a/reference/apcu/apcuiterator/gettotalhits.xml +++ b/reference/apcu/apcuiterator/gettotalhits.xml @@ -1,6 +1,6 @@ - + APCUIterator::getTotalHits Get total cache hits diff --git a/reference/apcu/apcuiterator/gettotalsize.xml b/reference/apcu/apcuiterator/gettotalsize.xml index 7e45a4553..87e12a1fc 100644 --- a/reference/apcu/apcuiterator/gettotalsize.xml +++ b/reference/apcu/apcuiterator/gettotalsize.xml @@ -1,6 +1,6 @@ - + APCUIterator::getTotalSize Get total cache size diff --git a/reference/apcu/apcuiterator/key.xml b/reference/apcu/apcuiterator/key.xml index d48684001..6fb159733 100644 --- a/reference/apcu/apcuiterator/key.xml +++ b/reference/apcu/apcuiterator/key.xml @@ -1,6 +1,6 @@ - + APCUIterator::key Get iterator key diff --git a/reference/apcu/apcuiterator/next.xml b/reference/apcu/apcuiterator/next.xml index f24b7fd7c..2e2c72a6f 100644 --- a/reference/apcu/apcuiterator/next.xml +++ b/reference/apcu/apcuiterator/next.xml @@ -1,6 +1,6 @@ - + APCUIterator::next Move pointer to next item diff --git a/reference/apcu/apcuiterator/rewind.xml b/reference/apcu/apcuiterator/rewind.xml index 1204b4a97..42a678f4f 100644 --- a/reference/apcu/apcuiterator/rewind.xml +++ b/reference/apcu/apcuiterator/rewind.xml @@ -1,6 +1,6 @@ - + APCUIterator::rewind Rewinds iterator diff --git a/reference/apcu/apcuiterator/valid.xml b/reference/apcu/apcuiterator/valid.xml index 9a5c27755..fd98ec821 100644 --- a/reference/apcu/apcuiterator/valid.xml +++ b/reference/apcu/apcuiterator/valid.xml @@ -1,6 +1,6 @@ - + APCUIterator::valid Checks if current position is valid diff --git a/reference/apcu/book.xml b/reference/apcu/book.xml index 9d72f0fee..c6d118c67 100644 --- a/reference/apcu/book.xml +++ b/reference/apcu/book.xml @@ -1,6 +1,6 @@ - + APC User Cache APCu diff --git a/reference/apcu/constants.xml b/reference/apcu/constants.xml index 6f53dbd84..51b898a82 100644 --- a/reference/apcu/constants.xml +++ b/reference/apcu/constants.xml @@ -1,5 +1,5 @@ - + &reftitle.constants; &extension.constants; diff --git a/reference/apcu/functions/apcu-add.xml b/reference/apcu/functions/apcu-add.xml index 5ec172f31..f5904065f 100644 --- a/reference/apcu/functions/apcu-add.xml +++ b/reference/apcu/functions/apcu-add.xml @@ -1,6 +1,6 @@ - + apcu_add diff --git a/reference/apcu/functions/apcu-cache-info.xml b/reference/apcu/functions/apcu-cache-info.xml index 3ac7c291c..5e505850b 100644 --- a/reference/apcu/functions/apcu-cache-info.xml +++ b/reference/apcu/functions/apcu-cache-info.xml @@ -1,6 +1,6 @@ - + apcu_cache_info diff --git a/reference/apcu/functions/apcu-cas.xml b/reference/apcu/functions/apcu-cas.xml index c7ed9635a..a48200b5f 100644 --- a/reference/apcu/functions/apcu-cas.xml +++ b/reference/apcu/functions/apcu-cas.xml @@ -1,6 +1,6 @@ - + apcu_cas Updates an old value with a new value diff --git a/reference/apcu/functions/apcu-clear-cache.xml b/reference/apcu/functions/apcu-clear-cache.xml index afdb45ef8..e9ac0c3e4 100644 --- a/reference/apcu/functions/apcu-clear-cache.xml +++ b/reference/apcu/functions/apcu-clear-cache.xml @@ -1,6 +1,6 @@ - + apcu_clear_cache diff --git a/reference/apcu/functions/apcu-dec.xml b/reference/apcu/functions/apcu-dec.xml index 02fa81a20..b96abdeff 100644 --- a/reference/apcu/functions/apcu-dec.xml +++ b/reference/apcu/functions/apcu-dec.xml @@ -1,6 +1,6 @@ - + apcu_dec Decrease a stored number diff --git a/reference/apcu/functions/apcu-delete.xml b/reference/apcu/functions/apcu-delete.xml index edf55339e..8fe9a9240 100644 --- a/reference/apcu/functions/apcu-delete.xml +++ b/reference/apcu/functions/apcu-delete.xml @@ -1,6 +1,6 @@ - + apcu_delete diff --git a/reference/apcu/functions/apcu-enabled.xml b/reference/apcu/functions/apcu-enabled.xml index 444becf25..3a5f7dd6b 100644 --- a/reference/apcu/functions/apcu-enabled.xml +++ b/reference/apcu/functions/apcu-enabled.xml @@ -1,6 +1,6 @@ - + apcu_enabled Whether APCu is usable in the current environment diff --git a/reference/apcu/functions/apcu-entry.xml b/reference/apcu/functions/apcu-entry.xml index 7abe69894..9ee85ceaf 100644 --- a/reference/apcu/functions/apcu-entry.xml +++ b/reference/apcu/functions/apcu-entry.xml @@ -1,6 +1,6 @@ - + apcu_entry diff --git a/reference/apcu/functions/apcu-exists.xml b/reference/apcu/functions/apcu-exists.xml index 61a81f2b7..0affa1dee 100644 --- a/reference/apcu/functions/apcu-exists.xml +++ b/reference/apcu/functions/apcu-exists.xml @@ -1,6 +1,6 @@ - + apcu_exists Checks if entry exists diff --git a/reference/apcu/functions/apcu-fetch.xml b/reference/apcu/functions/apcu-fetch.xml index 1555e9862..d394f819c 100644 --- a/reference/apcu/functions/apcu-fetch.xml +++ b/reference/apcu/functions/apcu-fetch.xml @@ -1,6 +1,6 @@ - + apcu_fetch diff --git a/reference/apcu/functions/apcu-inc.xml b/reference/apcu/functions/apcu-inc.xml index af7b0465b..ab70cdb01 100644 --- a/reference/apcu/functions/apcu-inc.xml +++ b/reference/apcu/functions/apcu-inc.xml @@ -1,6 +1,6 @@ - + apcu_inc Increase a stored number diff --git a/reference/apcu/functions/apcu-key-info.xml b/reference/apcu/functions/apcu-key-info.xml index cfaf160e5..0b8e0a047 100644 --- a/reference/apcu/functions/apcu-key-info.xml +++ b/reference/apcu/functions/apcu-key-info.xml @@ -1,6 +1,6 @@ - + apcu_key_info diff --git a/reference/apcu/functions/apcu-sma-info.xml b/reference/apcu/functions/apcu-sma-info.xml index 135779b92..56449afdc 100644 --- a/reference/apcu/functions/apcu-sma-info.xml +++ b/reference/apcu/functions/apcu-sma-info.xml @@ -1,6 +1,6 @@ - + apcu_sma_info diff --git a/reference/apcu/functions/apcu-store.xml b/reference/apcu/functions/apcu-store.xml index 0bd00e37a..de0a45606 100644 --- a/reference/apcu/functions/apcu-store.xml +++ b/reference/apcu/functions/apcu-store.xml @@ -1,6 +1,6 @@ - + apcu_store diff --git a/reference/apcu/ini.xml b/reference/apcu/ini.xml index e2eb1ef01..ebbff001a 100644 --- a/reference/apcu/ini.xml +++ b/reference/apcu/ini.xml @@ -1,6 +1,6 @@ -
+
&reftitle.runtime; &extension.runtime; diff --git a/reference/apcu/setup.xml b/reference/apcu/setup.xml index e6263aa74..6b5e2cf6b 100644 --- a/reference/apcu/setup.xml +++ b/reference/apcu/setup.xml @@ -1,6 +1,6 @@ - + &reftitle.setup;
diff --git a/reference/cmark/book.xml b/reference/cmark/book.xml index 2b81863ae..4a13881af 100644 --- a/reference/cmark/book.xml +++ b/reference/cmark/book.xml @@ -1,6 +1,6 @@ - + CommonMark CommonMark diff --git a/reference/cmark/commonmark.cql.xml b/reference/cmark/commonmark.cql.xml index c839f164b..de82f5ba6 100644 --- a/reference/cmark/commonmark.cql.xml +++ b/reference/cmark/commonmark.cql.xml @@ -1,6 +1,6 @@ - + The CommonMark\CQL class CommonMark\CQL diff --git a/reference/cmark/commonmark.interfaces.ivisitable.xml b/reference/cmark/commonmark.interfaces.ivisitable.xml index 1cc72f649..791e88758 100644 --- a/reference/cmark/commonmark.interfaces.ivisitable.xml +++ b/reference/cmark/commonmark.interfaces.ivisitable.xml @@ -1,6 +1,6 @@ - + The CommonMark\Interfaces\IVisitable interface CommonMark\Interfaces\IVisitable diff --git a/reference/cmark/commonmark.interfaces.ivisitor.xml b/reference/cmark/commonmark.interfaces.ivisitor.xml index 67b524ba7..f4ed8f284 100644 --- a/reference/cmark/commonmark.interfaces.ivisitor.xml +++ b/reference/cmark/commonmark.interfaces.ivisitor.xml @@ -1,6 +1,6 @@ - + The CommonMark\Interfaces\IVisitor interface CommonMark\Interfaces\IVisitor diff --git a/reference/cmark/commonmark.node.blockquote.xml b/reference/cmark/commonmark.node.blockquote.xml index cdc4f3492..917c5b2ae 100644 --- a/reference/cmark/commonmark.node.blockquote.xml +++ b/reference/cmark/commonmark.node.blockquote.xml @@ -21,7 +21,7 @@ final CommonMark\Node\BlockQuote - + extends CommonMark\Node @@ -30,7 +30,7 @@ CommonMark\Interfaces\IVisitable - + Traversable @@ -38,7 +38,7 @@ &InheritedProperties; - + &InheritedMethods; diff --git a/reference/cmark/commonmark.node.bulletlist.xml b/reference/cmark/commonmark.node.bulletlist.xml index cc64e15a8..84bdda483 100644 --- a/reference/cmark/commonmark.node.bulletlist.xml +++ b/reference/cmark/commonmark.node.bulletlist.xml @@ -21,7 +21,7 @@ final CommonMark\Node\BulletList - + extends CommonMark\Node @@ -30,7 +30,7 @@ CommonMark\Interfaces\IVisitable - + Traversable @@ -54,7 +54,7 @@ &Constructor; - + &InheritedMethods; diff --git a/reference/cmark/commonmark.node.code.xml b/reference/cmark/commonmark.node.code.xml index d484612f4..9dc7e8bf9 100644 --- a/reference/cmark/commonmark.node.code.xml +++ b/reference/cmark/commonmark.node.code.xml @@ -21,7 +21,7 @@ final CommonMark\Node\Code - + extends CommonMark\Node\Text @@ -30,7 +30,7 @@ CommonMark\Interfaces\IVisitable - + Traversable diff --git a/reference/cmark/commonmark.node.codeblock.xml b/reference/cmark/commonmark.node.codeblock.xml index 19b66f9cd..23b3e5071 100644 --- a/reference/cmark/commonmark.node.codeblock.xml +++ b/reference/cmark/commonmark.node.codeblock.xml @@ -21,7 +21,7 @@ final CommonMark\Node\CodeBlock - + extends CommonMark\Node\Text @@ -30,7 +30,7 @@ CommonMark\Interfaces\IVisitable - + Traversable @@ -50,7 +50,7 @@ &Constructor; - + &InheritedMethods; diff --git a/reference/cmark/commonmark.node.customblock.xml b/reference/cmark/commonmark.node.customblock.xml index 660080400..2b5fb28ba 100644 --- a/reference/cmark/commonmark.node.customblock.xml +++ b/reference/cmark/commonmark.node.customblock.xml @@ -21,7 +21,7 @@ final CommonMark\Node\CustomBlock - + extends CommonMark\Node @@ -30,7 +30,7 @@ CommonMark\Interfaces\IVisitable - + Traversable @@ -50,7 +50,7 @@ public stringnull onLeave - + &InheritedMethods; diff --git a/reference/cmark/commonmark.node.custominline.xml b/reference/cmark/commonmark.node.custominline.xml index c84074bd7..9c939cd6c 100644 --- a/reference/cmark/commonmark.node.custominline.xml +++ b/reference/cmark/commonmark.node.custominline.xml @@ -21,7 +21,7 @@ final CommonMark\Node\CustomInline - + extends CommonMark\Node @@ -30,7 +30,7 @@ CommonMark\Interfaces\IVisitable - + Traversable @@ -49,8 +49,8 @@ public stringnull onLeave - - + + &InheritedMethods; diff --git a/reference/cmark/commonmark.node.document.xml b/reference/cmark/commonmark.node.document.xml index 8ec1ce8e3..6560eac61 100644 --- a/reference/cmark/commonmark.node.document.xml +++ b/reference/cmark/commonmark.node.document.xml @@ -21,7 +21,7 @@ final CommonMark\Node\Document - + extends CommonMark\Node @@ -30,7 +30,7 @@ CommonMark\Interfaces\IVisitable - + Traversable @@ -38,7 +38,7 @@ &InheritedProperties; - + &InheritedMethods; diff --git a/reference/cmark/commonmark.node.heading.xml b/reference/cmark/commonmark.node.heading.xml index 9d9bcc0cd..b638b6320 100644 --- a/reference/cmark/commonmark.node.heading.xml +++ b/reference/cmark/commonmark.node.heading.xml @@ -21,7 +21,7 @@ final CommonMark\Node\Heading - + extends CommonMark\Node @@ -30,7 +30,7 @@ CommonMark\Interfaces\IVisitable - + Traversable @@ -49,7 +49,7 @@ &Constructor; - + &InheritedMethods; diff --git a/reference/cmark/commonmark.node.htmlblock.xml b/reference/cmark/commonmark.node.htmlblock.xml index a12622f73..5d4bd4dd4 100644 --- a/reference/cmark/commonmark.node.htmlblock.xml +++ b/reference/cmark/commonmark.node.htmlblock.xml @@ -21,7 +21,7 @@ final CommonMark\Node\HTMLBlock - + extends CommonMark\Node\Text @@ -30,7 +30,7 @@ CommonMark\Interfaces\IVisitable - + Traversable @@ -42,7 +42,7 @@ &Constructor; - + &InheritedMethods; diff --git a/reference/cmark/commonmark.node.htmlinline.xml b/reference/cmark/commonmark.node.htmlinline.xml index cdca6b31f..1d1885927 100644 --- a/reference/cmark/commonmark.node.htmlinline.xml +++ b/reference/cmark/commonmark.node.htmlinline.xml @@ -21,7 +21,7 @@ final CommonMark\Node\HTMLInline - + extends CommonMark\Node\Text @@ -30,7 +30,7 @@ CommonMark\Interfaces\IVisitable - + Traversable @@ -42,7 +42,7 @@ &Constructor; - + &InheritedMethods; diff --git a/reference/cmark/commonmark.node.image.xml b/reference/cmark/commonmark.node.image.xml index 60369de68..d975d0d4f 100644 --- a/reference/cmark/commonmark.node.image.xml +++ b/reference/cmark/commonmark.node.image.xml @@ -21,7 +21,7 @@ final CommonMark\Node\Image - + extends CommonMark\Node @@ -30,7 +30,7 @@ CommonMark\Interfaces\IVisitable - + Traversable @@ -53,7 +53,7 @@ &Constructor; - + &InheritedMethods; diff --git a/reference/cmark/commonmark.node.item.xml b/reference/cmark/commonmark.node.item.xml index 0cb79c3e2..2887f1290 100644 --- a/reference/cmark/commonmark.node.item.xml +++ b/reference/cmark/commonmark.node.item.xml @@ -21,7 +21,7 @@ final CommonMark\Node\Item - + extends CommonMark\Node @@ -30,7 +30,7 @@ CommonMark\Interfaces\IVisitable - + Traversable @@ -38,7 +38,7 @@ &InheritedProperties; - + &InheritedMethods; diff --git a/reference/cmark/commonmark.node.linebreak.xml b/reference/cmark/commonmark.node.linebreak.xml index f8a2942c6..7fc4e713b 100644 --- a/reference/cmark/commonmark.node.linebreak.xml +++ b/reference/cmark/commonmark.node.linebreak.xml @@ -21,7 +21,7 @@ final CommonMark\Node\LineBreak - + extends CommonMark\Node @@ -30,7 +30,7 @@ CommonMark\Interfaces\IVisitable - + Traversable @@ -38,7 +38,7 @@ &InheritedProperties; - + &InheritedMethods; diff --git a/reference/cmark/commonmark.node.link.xml b/reference/cmark/commonmark.node.link.xml index f7071a33c..4a41898f7 100644 --- a/reference/cmark/commonmark.node.link.xml +++ b/reference/cmark/commonmark.node.link.xml @@ -21,7 +21,7 @@ final CommonMark\Node\Link - + extends CommonMark\Node @@ -30,7 +30,7 @@ CommonMark\Interfaces\IVisitable - + Traversable @@ -54,7 +54,7 @@ &Constructor; - + &InheritedMethods; diff --git a/reference/cmark/commonmark.node.orderedlist.xml b/reference/cmark/commonmark.node.orderedlist.xml index 3121b8510..6448dacc9 100644 --- a/reference/cmark/commonmark.node.orderedlist.xml +++ b/reference/cmark/commonmark.node.orderedlist.xml @@ -21,7 +21,7 @@ final CommonMark\Node\OrderedList - + extends CommonMark\Node @@ -30,7 +30,7 @@ CommonMark\Interfaces\IVisitable - + Traversable @@ -58,7 +58,7 @@ &Constructor; - + &InheritedMethods; diff --git a/reference/cmark/commonmark.node.paragraph.xml b/reference/cmark/commonmark.node.paragraph.xml index 337a6b517..4f6d33567 100644 --- a/reference/cmark/commonmark.node.paragraph.xml +++ b/reference/cmark/commonmark.node.paragraph.xml @@ -21,7 +21,7 @@ final CommonMark\Node\Paragraph - + extends CommonMark\Node @@ -30,7 +30,7 @@ CommonMark\Interfaces\IVisitable - + Traversable @@ -38,7 +38,7 @@ &InheritedProperties; - + &InheritedMethods; diff --git a/reference/cmark/commonmark.node.softbreak.xml b/reference/cmark/commonmark.node.softbreak.xml index 579d42576..9f2998d0c 100644 --- a/reference/cmark/commonmark.node.softbreak.xml +++ b/reference/cmark/commonmark.node.softbreak.xml @@ -21,7 +21,7 @@ final CommonMark\Node\SoftBreak - + extends CommonMark\Node @@ -30,7 +30,7 @@ CommonMark\Interfaces\IVisitable - + Traversable @@ -38,7 +38,7 @@ &InheritedProperties; - + &InheritedMethods; diff --git a/reference/cmark/commonmark.node.text.emphasis.xml b/reference/cmark/commonmark.node.text.emphasis.xml index 40bbbb390..bd143a0cf 100644 --- a/reference/cmark/commonmark.node.text.emphasis.xml +++ b/reference/cmark/commonmark.node.text.emphasis.xml @@ -21,7 +21,7 @@ final CommonMark\Node\Text\Emphasis - + extends CommonMark\Node @@ -30,7 +30,7 @@ CommonMark\Interfaces\IVisitable - + Traversable @@ -38,7 +38,7 @@ &InheritedProperties; - + &InheritedMethods; diff --git a/reference/cmark/commonmark.node.text.strong.xml b/reference/cmark/commonmark.node.text.strong.xml index 787b2d67c..177fb1000 100644 --- a/reference/cmark/commonmark.node.text.strong.xml +++ b/reference/cmark/commonmark.node.text.strong.xml @@ -21,7 +21,7 @@ final CommonMark\Node\Text\Strong - + extends CommonMark\Node @@ -30,7 +30,7 @@ CommonMark\Interfaces\IVisitable - + Traversable @@ -38,7 +38,7 @@ &InheritedProperties; - + &InheritedMethods; diff --git a/reference/cmark/commonmark.node.text.xml b/reference/cmark/commonmark.node.text.xml index 7343edcae..b2ca77462 100644 --- a/reference/cmark/commonmark.node.text.xml +++ b/reference/cmark/commonmark.node.text.xml @@ -21,7 +21,7 @@ final CommonMark\Node\Text - + extends CommonMark\Node @@ -30,7 +30,7 @@ CommonMark\Interfaces\IVisitable - + Traversable @@ -48,7 +48,7 @@ &Constructor; - + &InheritedMethods; diff --git a/reference/cmark/commonmark.node.thematicbreak.xml b/reference/cmark/commonmark.node.thematicbreak.xml index 61643cd00..8a4363b97 100644 --- a/reference/cmark/commonmark.node.thematicbreak.xml +++ b/reference/cmark/commonmark.node.thematicbreak.xml @@ -21,7 +21,7 @@ final CommonMark\Node\ThematicBreak - + extends CommonMark\Node @@ -30,7 +30,7 @@ CommonMark\Interfaces\IVisitable - + Traversable @@ -38,7 +38,7 @@ &InheritedProperties; - + &InheritedMethods; diff --git a/reference/cmark/commonmark.node.xml b/reference/cmark/commonmark.node.xml index e57acf212..deece16e7 100644 --- a/reference/cmark/commonmark.node.xml +++ b/reference/cmark/commonmark.node.xml @@ -1,6 +1,6 @@ - + Abstract CommonMark\Node CommonMark\Node diff --git a/reference/cmark/commonmark.parser.xml b/reference/cmark/commonmark.parser.xml index 9ea64aa69..ffebf98f8 100644 --- a/reference/cmark/commonmark.parser.xml +++ b/reference/cmark/commonmark.parser.xml @@ -1,6 +1,6 @@ - + The CommonMark\Parser class CommonMark\Parser diff --git a/reference/cmark/commonmark/cql/construct.xml b/reference/cmark/commonmark/cql/construct.xml index 08aff3732..8488df671 100644 --- a/reference/cmark/commonmark/cql/construct.xml +++ b/reference/cmark/commonmark/cql/construct.xml @@ -1,6 +1,6 @@ - + CommonMark\CQL::__construct CQL Construction diff --git a/reference/cmark/commonmark/cql/invoke.xml b/reference/cmark/commonmark/cql/invoke.xml index 534758d3a..8a323e1ad 100644 --- a/reference/cmark/commonmark/cql/invoke.xml +++ b/reference/cmark/commonmark/cql/invoke.xml @@ -1,6 +1,6 @@ - + CommonMark\CQL::__invoke CQL Execution diff --git a/reference/cmark/commonmark/interfaces/ivisitable/accept.xml b/reference/cmark/commonmark/interfaces/ivisitable/accept.xml index 791b8cff8..fb841d3ea 100644 --- a/reference/cmark/commonmark/interfaces/ivisitable/accept.xml +++ b/reference/cmark/commonmark/interfaces/ivisitable/accept.xml @@ -1,6 +1,6 @@ - + CommonMark\Interfaces\IVisitable::accept Visitation diff --git a/reference/cmark/commonmark/interfaces/ivisitor/enter.xml b/reference/cmark/commonmark/interfaces/ivisitor/enter.xml index 2d23d8c24..0ab0b25fd 100644 --- a/reference/cmark/commonmark/interfaces/ivisitor/enter.xml +++ b/reference/cmark/commonmark/interfaces/ivisitor/enter.xml @@ -1,6 +1,6 @@ - + CommonMark\Interfaces\IVisitor::enter Visitation diff --git a/reference/cmark/commonmark/interfaces/ivisitor/leave.xml b/reference/cmark/commonmark/interfaces/ivisitor/leave.xml index d603b92cf..6857a8ac7 100644 --- a/reference/cmark/commonmark/interfaces/ivisitor/leave.xml +++ b/reference/cmark/commonmark/interfaces/ivisitor/leave.xml @@ -1,6 +1,6 @@ - + CommonMark\Interfaces\IVisitor::leave Visitation diff --git a/reference/cmark/commonmark/node/accept.xml b/reference/cmark/commonmark/node/accept.xml index 473619597..e2a7f4956 100644 --- a/reference/cmark/commonmark/node/accept.xml +++ b/reference/cmark/commonmark/node/accept.xml @@ -1,6 +1,6 @@ - + CommonMark\Node::accept Visitation diff --git a/reference/cmark/commonmark/node/appendchild.xml b/reference/cmark/commonmark/node/appendchild.xml index ba6328f08..dab633f9f 100644 --- a/reference/cmark/commonmark/node/appendchild.xml +++ b/reference/cmark/commonmark/node/appendchild.xml @@ -1,6 +1,6 @@ - + CommonMark\Node::appendChild AST Manipulation diff --git a/reference/cmark/commonmark/node/bulletlist/construct.xml b/reference/cmark/commonmark/node/bulletlist/construct.xml index cbf2ee8a0..c975465dd 100644 --- a/reference/cmark/commonmark/node/bulletlist/construct.xml +++ b/reference/cmark/commonmark/node/bulletlist/construct.xml @@ -1,6 +1,6 @@ - + CommonMark\Node\BulletList::__construct BulletList Construction diff --git a/reference/cmark/commonmark/node/codeblock/construct.xml b/reference/cmark/commonmark/node/codeblock/construct.xml index 0c4f468ad..c50064d94 100644 --- a/reference/cmark/commonmark/node/codeblock/construct.xml +++ b/reference/cmark/commonmark/node/codeblock/construct.xml @@ -1,6 +1,6 @@ - + CommonMark\Node\CodeBlock::__construct CodeBlock Construction diff --git a/reference/cmark/commonmark/node/heading/construct.xml b/reference/cmark/commonmark/node/heading/construct.xml index 6ba1bad66..37cd9e3ec 100644 --- a/reference/cmark/commonmark/node/heading/construct.xml +++ b/reference/cmark/commonmark/node/heading/construct.xml @@ -1,6 +1,6 @@ - + CommonMark\Node\Heading::__construct Heading Construction diff --git a/reference/cmark/commonmark/node/image/construct.xml b/reference/cmark/commonmark/node/image/construct.xml index 15a950104..dc437044d 100644 --- a/reference/cmark/commonmark/node/image/construct.xml +++ b/reference/cmark/commonmark/node/image/construct.xml @@ -1,6 +1,6 @@ - + CommonMark\Node\Image::__construct Image Construction diff --git a/reference/cmark/commonmark/node/insertafter.xml b/reference/cmark/commonmark/node/insertafter.xml index 5df5829ee..3aa181c1e 100644 --- a/reference/cmark/commonmark/node/insertafter.xml +++ b/reference/cmark/commonmark/node/insertafter.xml @@ -1,6 +1,6 @@ - + CommonMark\Node::insertAfter AST Manipulation diff --git a/reference/cmark/commonmark/node/insertbefore.xml b/reference/cmark/commonmark/node/insertbefore.xml index efcfb595d..30ba115ff 100644 --- a/reference/cmark/commonmark/node/insertbefore.xml +++ b/reference/cmark/commonmark/node/insertbefore.xml @@ -1,6 +1,6 @@ - + CommonMark\Node::insertBefore AST Manipulation diff --git a/reference/cmark/commonmark/node/link/construct.xml b/reference/cmark/commonmark/node/link/construct.xml index 277c2e100..bdc1babc9 100644 --- a/reference/cmark/commonmark/node/link/construct.xml +++ b/reference/cmark/commonmark/node/link/construct.xml @@ -1,6 +1,6 @@ - + CommonMark\Node\Link::__construct Link Construction diff --git a/reference/cmark/commonmark/node/orderedlist/construct.xml b/reference/cmark/commonmark/node/orderedlist/construct.xml index 3e7f12d0f..4fc767915 100644 --- a/reference/cmark/commonmark/node/orderedlist/construct.xml +++ b/reference/cmark/commonmark/node/orderedlist/construct.xml @@ -1,6 +1,6 @@ - + CommonMark\Node\OrderedList::__construct OrderedList Construction diff --git a/reference/cmark/commonmark/node/prependchild.xml b/reference/cmark/commonmark/node/prependchild.xml index 40533d1df..23b330458 100644 --- a/reference/cmark/commonmark/node/prependchild.xml +++ b/reference/cmark/commonmark/node/prependchild.xml @@ -1,6 +1,6 @@ - + CommonMark\Node::prependChild AST Manipulation diff --git a/reference/cmark/commonmark/node/replace.xml b/reference/cmark/commonmark/node/replace.xml index e9dd7e643..f5d961d55 100644 --- a/reference/cmark/commonmark/node/replace.xml +++ b/reference/cmark/commonmark/node/replace.xml @@ -1,6 +1,6 @@ - + CommonMark\Node::replace AST Manipulation diff --git a/reference/cmark/commonmark/node/text/construct.xml b/reference/cmark/commonmark/node/text/construct.xml index fd224d928..b28809b9f 100644 --- a/reference/cmark/commonmark/node/text/construct.xml +++ b/reference/cmark/commonmark/node/text/construct.xml @@ -1,6 +1,6 @@ - + CommonMark\Node\Text::__construct Text Construction diff --git a/reference/cmark/commonmark/node/unlink.xml b/reference/cmark/commonmark/node/unlink.xml index e6259d869..37214b686 100644 --- a/reference/cmark/commonmark/node/unlink.xml +++ b/reference/cmark/commonmark/node/unlink.xml @@ -1,6 +1,6 @@ - + CommonMark\Node::unlink AST Manipulation diff --git a/reference/cmark/commonmark/parser/construct.xml b/reference/cmark/commonmark/parser/construct.xml index d6d225465..d6d0586a7 100644 --- a/reference/cmark/commonmark/parser/construct.xml +++ b/reference/cmark/commonmark/parser/construct.xml @@ -1,6 +1,6 @@ - + CommonMark\Parser::__construct Parsing diff --git a/reference/cmark/commonmark/parser/finish.xml b/reference/cmark/commonmark/parser/finish.xml index be0085cc6..66c8707ae 100644 --- a/reference/cmark/commonmark/parser/finish.xml +++ b/reference/cmark/commonmark/parser/finish.xml @@ -1,6 +1,6 @@ - + CommonMark\Parser::finish Parsing diff --git a/reference/cmark/commonmark/parser/parse.xml b/reference/cmark/commonmark/parser/parse.xml index 4812cf407..ad8ba9402 100644 --- a/reference/cmark/commonmark/parser/parse.xml +++ b/reference/cmark/commonmark/parser/parse.xml @@ -1,6 +1,6 @@ - + CommonMark\Parser::parse Parsing diff --git a/reference/cmark/configure.xml b/reference/cmark/configure.xml index 6b66114e8..6470f0bc6 100644 --- a/reference/cmark/configure.xml +++ b/reference/cmark/configure.xml @@ -1,6 +1,6 @@ -
+
&reftitle.install; diff --git a/reference/cmark/functions/commonmark.parse.xml b/reference/cmark/functions/commonmark.parse.xml index 21477c432..297f21f4a 100644 --- a/reference/cmark/functions/commonmark.parse.xml +++ b/reference/cmark/functions/commonmark.parse.xml @@ -1,6 +1,6 @@ - + CommonMark\Parse Parsing diff --git a/reference/cmark/functions/commonmark.render.html.xml b/reference/cmark/functions/commonmark.render.html.xml index 2bb03904d..dab868cea 100644 --- a/reference/cmark/functions/commonmark.render.html.xml +++ b/reference/cmark/functions/commonmark.render.html.xml @@ -1,6 +1,6 @@ - + CommonMark\Render\HTML Rendering diff --git a/reference/cmark/functions/commonmark.render.latex.xml b/reference/cmark/functions/commonmark.render.latex.xml index 328bfa05c..fb1f6ef03 100644 --- a/reference/cmark/functions/commonmark.render.latex.xml +++ b/reference/cmark/functions/commonmark.render.latex.xml @@ -1,6 +1,6 @@ - + CommonMark\Render\Latex Rendering diff --git a/reference/cmark/functions/commonmark.render.man.xml b/reference/cmark/functions/commonmark.render.man.xml index 240df7b85..397a7a9a9 100644 --- a/reference/cmark/functions/commonmark.render.man.xml +++ b/reference/cmark/functions/commonmark.render.man.xml @@ -1,6 +1,6 @@ - + CommonMark\Render\Man Rendering diff --git a/reference/cmark/functions/commonmark.render.xml b/reference/cmark/functions/commonmark.render.xml index 488719b1f..c7988cc01 100644 --- a/reference/cmark/functions/commonmark.render.xml +++ b/reference/cmark/functions/commonmark.render.xml @@ -1,6 +1,6 @@ - + CommonMark\Render Rendering diff --git a/reference/cmark/functions/commonmark.render.xml.xml b/reference/cmark/functions/commonmark.render.xml.xml index 5b68b282f..f74fb2d69 100644 --- a/reference/cmark/functions/commonmark.render.xml.xml +++ b/reference/cmark/functions/commonmark.render.xml.xml @@ -1,6 +1,6 @@ - + CommonMark\Render\XML Rendering diff --git a/reference/cmark/setup.xml b/reference/cmark/setup.xml index 0ec50755c..22a9b4ac2 100644 --- a/reference/cmark/setup.xml +++ b/reference/cmark/setup.xml @@ -1,6 +1,6 @@ - + &reftitle.setup;
diff --git a/reference/componere/book.xml b/reference/componere/book.xml index 07e62a234..92a73f74b 100644 --- a/reference/componere/book.xml +++ b/reference/componere/book.xml @@ -1,6 +1,6 @@ - + Componere Componere diff --git a/reference/componere/componere.abstract.definition.xml b/reference/componere/componere.abstract.definition.xml index 06e0d3e95..443f186d1 100644 --- a/reference/componere/componere.abstract.definition.xml +++ b/reference/componere/componere.abstract.definition.xml @@ -1,6 +1,6 @@ - + The Componere\Abstract\Definition class Componere\Abstract\Definition diff --git a/reference/componere/componere.definition.xml b/reference/componere/componere.definition.xml index e6030ed35..9fbae209d 100644 --- a/reference/componere/componere.definition.xml +++ b/reference/componere/componere.definition.xml @@ -1,6 +1,6 @@ - + The Componere\Definition class Componere\Definition diff --git a/reference/componere/componere.method.xml b/reference/componere/componere.method.xml index 2a15ae14b..9b0060b44 100644 --- a/reference/componere/componere.method.xml +++ b/reference/componere/componere.method.xml @@ -1,6 +1,6 @@ - + The Componere\Method class Componere\Method diff --git a/reference/componere/componere.patch.xml b/reference/componere/componere.patch.xml index 0ebe39a2b..ff0e7f4f4 100644 --- a/reference/componere/componere.patch.xml +++ b/reference/componere/componere.patch.xml @@ -1,6 +1,6 @@ - + The Componere\Patch class Componere\Patch diff --git a/reference/componere/componere.value.xml b/reference/componere/componere.value.xml index 0f7918f95..aa831f155 100644 --- a/reference/componere/componere.value.xml +++ b/reference/componere/componere.value.xml @@ -1,6 +1,6 @@ - + The Componere\Value class Componere\Value diff --git a/reference/componere/componere/abstract/definition/addinterface.xml b/reference/componere/componere/abstract/definition/addinterface.xml index 04df5e924..c9d72c01a 100644 --- a/reference/componere/componere/abstract/definition/addinterface.xml +++ b/reference/componere/componere/abstract/definition/addinterface.xml @@ -1,6 +1,6 @@ - + Componere\Abstract\Definition::addInterface Add Interface diff --git a/reference/componere/componere/abstract/definition/addmethod.xml b/reference/componere/componere/abstract/definition/addmethod.xml index dac3f10d7..88e7bac9f 100644 --- a/reference/componere/componere/abstract/definition/addmethod.xml +++ b/reference/componere/componere/abstract/definition/addmethod.xml @@ -1,6 +1,6 @@ - + Componere\Abstract\Definition::addMethod Add Method diff --git a/reference/componere/componere/abstract/definition/addtrait.xml b/reference/componere/componere/abstract/definition/addtrait.xml index f720ee8a3..459ba2a83 100644 --- a/reference/componere/componere/abstract/definition/addtrait.xml +++ b/reference/componere/componere/abstract/definition/addtrait.xml @@ -1,6 +1,6 @@ - + Componere\Abstract\Definition::addTrait Add Trait diff --git a/reference/componere/componere/abstract/definition/getreflector.xml b/reference/componere/componere/abstract/definition/getreflector.xml index 11a93d485..a169e2414 100644 --- a/reference/componere/componere/abstract/definition/getreflector.xml +++ b/reference/componere/componere/abstract/definition/getreflector.xml @@ -1,6 +1,6 @@ - + Componere\Abstract\Definition::getReflector Reflection diff --git a/reference/componere/componere/definition/addconstant.xml b/reference/componere/componere/definition/addconstant.xml index 351f347cc..0f435fa3e 100644 --- a/reference/componere/componere/definition/addconstant.xml +++ b/reference/componere/componere/definition/addconstant.xml @@ -1,6 +1,6 @@ - + Componere\Definition::addConstant Add Constant diff --git a/reference/componere/componere/definition/addproperty.xml b/reference/componere/componere/definition/addproperty.xml index 74a702d41..d149a2170 100644 --- a/reference/componere/componere/definition/addproperty.xml +++ b/reference/componere/componere/definition/addproperty.xml @@ -1,6 +1,6 @@ - + Componere\Definition::addProperty Add Property diff --git a/reference/componere/componere/definition/construct.xml b/reference/componere/componere/definition/construct.xml index 96c3f5ab9..56f05c9d3 100644 --- a/reference/componere/componere/definition/construct.xml +++ b/reference/componere/componere/definition/construct.xml @@ -1,6 +1,6 @@ - + Componere\Definition::__construct Definition Construction diff --git a/reference/componere/componere/definition/getclosure.xml b/reference/componere/componere/definition/getclosure.xml index 3c741c10e..3e00b764d 100644 --- a/reference/componere/componere/definition/getclosure.xml +++ b/reference/componere/componere/definition/getclosure.xml @@ -1,6 +1,6 @@ - + Componere\Definition::getClosure Get Closure diff --git a/reference/componere/componere/definition/getclosures.xml b/reference/componere/componere/definition/getclosures.xml index 808e71d37..7762b3127 100644 --- a/reference/componere/componere/definition/getclosures.xml +++ b/reference/componere/componere/definition/getclosures.xml @@ -1,6 +1,6 @@ - + Componere\Definition::getClosures Get Closures diff --git a/reference/componere/componere/definition/isregistered.xml b/reference/componere/componere/definition/isregistered.xml index 401906108..7fd348259 100644 --- a/reference/componere/componere/definition/isregistered.xml +++ b/reference/componere/componere/definition/isregistered.xml @@ -1,6 +1,6 @@ - + Componere\Definition::isRegistered State Detection diff --git a/reference/componere/componere/definition/register.xml b/reference/componere/componere/definition/register.xml index f5f96e820..eb69409a4 100644 --- a/reference/componere/componere/definition/register.xml +++ b/reference/componere/componere/definition/register.xml @@ -1,6 +1,6 @@ - + Componere\Definition::register Registration diff --git a/reference/componere/componere/method/construct.xml b/reference/componere/componere/method/construct.xml index 1ae6a0ce0..82dc54928 100644 --- a/reference/componere/componere/method/construct.xml +++ b/reference/componere/componere/method/construct.xml @@ -1,6 +1,6 @@ - + Componere\Method::__construct Method Construction diff --git a/reference/componere/componere/method/getreflector.xml b/reference/componere/componere/method/getreflector.xml index 0d9b8b798..f791f7d60 100644 --- a/reference/componere/componere/method/getreflector.xml +++ b/reference/componere/componere/method/getreflector.xml @@ -1,6 +1,6 @@ - + Componere\Method::getReflector Reflection diff --git a/reference/componere/componere/method/setprivate.xml b/reference/componere/componere/method/setprivate.xml index d3865ea82..b190c0f94 100644 --- a/reference/componere/componere/method/setprivate.xml +++ b/reference/componere/componere/method/setprivate.xml @@ -1,6 +1,6 @@ - + Componere\Method::setPrivate Accessibility Modification diff --git a/reference/componere/componere/method/setprotected.xml b/reference/componere/componere/method/setprotected.xml index e13da5661..35522b7bf 100644 --- a/reference/componere/componere/method/setprotected.xml +++ b/reference/componere/componere/method/setprotected.xml @@ -1,6 +1,6 @@ - + Componere\Method::setProtected Accessibility Modification diff --git a/reference/componere/componere/method/setstatic.xml b/reference/componere/componere/method/setstatic.xml index 62b63361c..15c13258a 100644 --- a/reference/componere/componere/method/setstatic.xml +++ b/reference/componere/componere/method/setstatic.xml @@ -1,6 +1,6 @@ - + Componere\Method::setStatic Accessibility Modification diff --git a/reference/componere/componere/patch/apply.xml b/reference/componere/componere/patch/apply.xml index a2339e577..dabfdc098 100644 --- a/reference/componere/componere/patch/apply.xml +++ b/reference/componere/componere/patch/apply.xml @@ -1,6 +1,6 @@ - + Componere\Patch::apply Application diff --git a/reference/componere/componere/patch/construct.xml b/reference/componere/componere/patch/construct.xml index 954cdd48a..7dccf4b2e 100644 --- a/reference/componere/componere/patch/construct.xml +++ b/reference/componere/componere/patch/construct.xml @@ -1,6 +1,6 @@ - + Componere\Patch::__construct Patch Construction diff --git a/reference/componere/componere/patch/derive.xml b/reference/componere/componere/patch/derive.xml index 7f93bb98e..ca405d55e 100644 --- a/reference/componere/componere/patch/derive.xml +++ b/reference/componere/componere/patch/derive.xml @@ -1,6 +1,6 @@ - + Componere\Patch::derive Patch Derivation diff --git a/reference/componere/componere/patch/getclosure.xml b/reference/componere/componere/patch/getclosure.xml index 1da32bb40..259259f6a 100644 --- a/reference/componere/componere/patch/getclosure.xml +++ b/reference/componere/componere/patch/getclosure.xml @@ -1,6 +1,6 @@ - + Componere\Patch::getClosure Get Closure diff --git a/reference/componere/componere/patch/getclosures.xml b/reference/componere/componere/patch/getclosures.xml index 9752284df..0b1cb1379 100644 --- a/reference/componere/componere/patch/getclosures.xml +++ b/reference/componere/componere/patch/getclosures.xml @@ -1,6 +1,6 @@ - + Componere\Patch::getClosures Get Closures diff --git a/reference/componere/componere/patch/revert.xml b/reference/componere/componere/patch/revert.xml index adb662391..ced904906 100644 --- a/reference/componere/componere/patch/revert.xml +++ b/reference/componere/componere/patch/revert.xml @@ -1,6 +1,6 @@ - + Componere\Patch::revert Reversal diff --git a/reference/componere/componere/value/construct.xml b/reference/componere/componere/value/construct.xml index 83ab23eac..bb3924b8d 100644 --- a/reference/componere/componere/value/construct.xml +++ b/reference/componere/componere/value/construct.xml @@ -1,6 +1,6 @@ - + Componere\Value::__construct Value Construction diff --git a/reference/componere/componere/value/hasdefault.xml b/reference/componere/componere/value/hasdefault.xml index 1f9961462..1a81b71e4 100644 --- a/reference/componere/componere/value/hasdefault.xml +++ b/reference/componere/componere/value/hasdefault.xml @@ -1,6 +1,6 @@ - + Componere\Value::hasDefault Value Interaction diff --git a/reference/componere/componere/value/isprivate.xml b/reference/componere/componere/value/isprivate.xml index dc9a57aaf..0578835ea 100644 --- a/reference/componere/componere/value/isprivate.xml +++ b/reference/componere/componere/value/isprivate.xml @@ -1,6 +1,6 @@ - + Componere\Value::isPrivate Accessibility Detection diff --git a/reference/componere/componere/value/isprotected.xml b/reference/componere/componere/value/isprotected.xml index 80415bb68..0a90d7cdf 100644 --- a/reference/componere/componere/value/isprotected.xml +++ b/reference/componere/componere/value/isprotected.xml @@ -1,6 +1,6 @@ - + Componere\Value::isProtected Accessibility Detection diff --git a/reference/componere/componere/value/isstatic.xml b/reference/componere/componere/value/isstatic.xml index 49a1eb667..5a15a3620 100644 --- a/reference/componere/componere/value/isstatic.xml +++ b/reference/componere/componere/value/isstatic.xml @@ -1,6 +1,6 @@ - + Componere\Value::isStatic Accessibility Detection diff --git a/reference/componere/componere/value/setprivate.xml b/reference/componere/componere/value/setprivate.xml index 8db751330..17d03edb2 100644 --- a/reference/componere/componere/value/setprivate.xml +++ b/reference/componere/componere/value/setprivate.xml @@ -1,6 +1,6 @@ - + Componere\Value::setPrivate Accessibility Modification diff --git a/reference/componere/componere/value/setprotected.xml b/reference/componere/componere/value/setprotected.xml index 99be9efe8..303e1f7ef 100644 --- a/reference/componere/componere/value/setprotected.xml +++ b/reference/componere/componere/value/setprotected.xml @@ -1,6 +1,6 @@ - + Componere\Value::setProtected Accessibility Modification diff --git a/reference/componere/componere/value/setstatic.xml b/reference/componere/componere/value/setstatic.xml index 271a90347..d5f2ed098 100644 --- a/reference/componere/componere/value/setstatic.xml +++ b/reference/componere/componere/value/setstatic.xml @@ -1,6 +1,6 @@ - + Componere\Value::setStatic Accessibility Modification diff --git a/reference/componere/configure.xml b/reference/componere/configure.xml index 08d790f5a..24e2cdc1b 100644 --- a/reference/componere/configure.xml +++ b/reference/componere/configure.xml @@ -1,6 +1,6 @@ -
+
&reftitle.install; diff --git a/reference/componere/functions/componere.cast.xml b/reference/componere/functions/componere.cast.xml index f9b7b48e9..61cb2501f 100644 --- a/reference/componere/functions/componere.cast.xml +++ b/reference/componere/functions/componere.cast.xml @@ -1,6 +1,6 @@ - + Componere\cast Casting diff --git a/reference/componere/functions/componere.cast_by_ref.xml b/reference/componere/functions/componere.cast_by_ref.xml index 6d7d387fa..e25aac9b7 100644 --- a/reference/componere/functions/componere.cast_by_ref.xml +++ b/reference/componere/functions/componere.cast_by_ref.xml @@ -1,6 +1,6 @@ - + Componere\cast_by_ref Casting diff --git a/reference/componere/setup.xml b/reference/componere/setup.xml index c4ffd1840..89bfa7532 100644 --- a/reference/componere/setup.xml +++ b/reference/componere/setup.xml @@ -1,6 +1,6 @@ - + &reftitle.setup;
diff --git a/reference/cubrid/book.xml b/reference/cubrid/book.xml index e01ff29a9..873298d24 100644 --- a/reference/cubrid/book.xml +++ b/reference/cubrid/book.xml @@ -1,6 +1,6 @@ - + CUBRID CUBRID diff --git a/reference/cubrid/configure.xml b/reference/cubrid/configure.xml index 3a88ab530..f4a3cbfef 100644 --- a/reference/cubrid/configure.xml +++ b/reference/cubrid/configure.xml @@ -1,6 +1,6 @@ -
+
&reftitle.install; diff --git a/reference/cubrid/constants.xml b/reference/cubrid/constants.xml index ab004bb06..4de02972a 100644 --- a/reference/cubrid/constants.xml +++ b/reference/cubrid/constants.xml @@ -82,7 +82,7 @@ The following constants can be used when positioning the cursor in query - results. They can be passed to or returned by + results. They can be passed to or returned by cubrid_move_cursor. CUBRID cursor position flags diff --git a/reference/cubrid/cubridmysql/cubrid-affected-rows.xml b/reference/cubrid/cubridmysql/cubrid-affected-rows.xml index 354fde4e0..0afbfd52f 100644 --- a/reference/cubrid/cubridmysql/cubrid-affected-rows.xml +++ b/reference/cubrid/cubridmysql/cubrid-affected-rows.xml @@ -1,6 +1,6 @@ - + cubrid_affected_rows Return the number of rows affected by the last SQL statement diff --git a/reference/cubrid/cubridmysql/cubrid-client-encoding.xml b/reference/cubrid/cubridmysql/cubrid-client-encoding.xml index f3a0c3698..371c99c24 100644 --- a/reference/cubrid/cubridmysql/cubrid-client-encoding.xml +++ b/reference/cubrid/cubridmysql/cubrid-client-encoding.xml @@ -1,6 +1,6 @@ - + cubrid_client_encoding Return the current CUBRID connection charset diff --git a/reference/cubrid/cubridmysql/cubrid-close.xml b/reference/cubrid/cubridmysql/cubrid-close.xml index e26286843..0d67e95e1 100644 --- a/reference/cubrid/cubridmysql/cubrid-close.xml +++ b/reference/cubrid/cubridmysql/cubrid-close.xml @@ -1,6 +1,6 @@ - + cubrid_close Close CUBRID connection diff --git a/reference/cubrid/cubridmysql/cubrid-data-seek.xml b/reference/cubrid/cubridmysql/cubrid-data-seek.xml index 1751a9432..9444233c0 100644 --- a/reference/cubrid/cubridmysql/cubrid-data-seek.xml +++ b/reference/cubrid/cubridmysql/cubrid-data-seek.xml @@ -1,6 +1,6 @@ - + cubrid_data_seek Move the internal row pointer of the CUBRID result diff --git a/reference/cubrid/cubridmysql/cubrid-db-name.xml b/reference/cubrid/cubridmysql/cubrid-db-name.xml index 5988306f6..2b3a4b72c 100644 --- a/reference/cubrid/cubridmysql/cubrid-db-name.xml +++ b/reference/cubrid/cubridmysql/cubrid-db-name.xml @@ -1,6 +1,6 @@ - + cubrid_db_name Get db name from results of cubrid_list_dbs diff --git a/reference/cubrid/cubridmysql/cubrid-errno.xml b/reference/cubrid/cubridmysql/cubrid-errno.xml index b76abb008..7a3c35eae 100644 --- a/reference/cubrid/cubridmysql/cubrid-errno.xml +++ b/reference/cubrid/cubridmysql/cubrid-errno.xml @@ -1,6 +1,6 @@ - + cubrid_errno Return the numerical value of the error message from previous CUBRID operation diff --git a/reference/cubrid/cubridmysql/cubrid-error.xml b/reference/cubrid/cubridmysql/cubrid-error.xml index eed8e743a..dc3706903 100644 --- a/reference/cubrid/cubridmysql/cubrid-error.xml +++ b/reference/cubrid/cubridmysql/cubrid-error.xml @@ -1,6 +1,6 @@ - + cubrid_error Get the error message diff --git a/reference/cubrid/cubridmysql/cubrid-fetch-array.xml b/reference/cubrid/cubridmysql/cubrid-fetch-array.xml index 7136019f9..a8d9b41e2 100644 --- a/reference/cubrid/cubridmysql/cubrid-fetch-array.xml +++ b/reference/cubrid/cubridmysql/cubrid-fetch-array.xml @@ -1,6 +1,6 @@ - + cubrid_fetch_array Fetch a result row as an associative array, a numeric array, or both diff --git a/reference/cubrid/cubridmysql/cubrid-fetch-assoc.xml b/reference/cubrid/cubridmysql/cubrid-fetch-assoc.xml index 72f4df77e..75db636dd 100644 --- a/reference/cubrid/cubridmysql/cubrid-fetch-assoc.xml +++ b/reference/cubrid/cubridmysql/cubrid-fetch-assoc.xml @@ -1,6 +1,6 @@ - + cubrid_fetch_assoc Return the associative array that corresponds to the fetched row diff --git a/reference/cubrid/cubridmysql/cubrid-fetch-field.xml b/reference/cubrid/cubridmysql/cubrid-fetch-field.xml index a4e105fdf..01d587752 100644 --- a/reference/cubrid/cubridmysql/cubrid-fetch-field.xml +++ b/reference/cubrid/cubridmysql/cubrid-fetch-field.xml @@ -1,6 +1,6 @@ - + cubrid_fetch_field Get column information from a result and return as an object diff --git a/reference/cubrid/cubridmysql/cubrid-fetch-lengths.xml b/reference/cubrid/cubridmysql/cubrid-fetch-lengths.xml index b974c6713..392fe4f1e 100644 --- a/reference/cubrid/cubridmysql/cubrid-fetch-lengths.xml +++ b/reference/cubrid/cubridmysql/cubrid-fetch-lengths.xml @@ -1,6 +1,6 @@ - + cubrid_fetch_lengths Return an array with the lengths of the values of each field from the current row diff --git a/reference/cubrid/cubridmysql/cubrid-fetch-object.xml b/reference/cubrid/cubridmysql/cubrid-fetch-object.xml index 012f242cb..2bf5e1404 100644 --- a/reference/cubrid/cubridmysql/cubrid-fetch-object.xml +++ b/reference/cubrid/cubridmysql/cubrid-fetch-object.xml @@ -1,6 +1,6 @@ - + cubrid_fetch_object Fetch the next row and return it as an object diff --git a/reference/cubrid/cubridmysql/cubrid-fetch-row.xml b/reference/cubrid/cubridmysql/cubrid-fetch-row.xml index 885ab6820..df6517c93 100644 --- a/reference/cubrid/cubridmysql/cubrid-fetch-row.xml +++ b/reference/cubrid/cubridmysql/cubrid-fetch-row.xml @@ -1,6 +1,6 @@ - + cubrid_fetch_row Return a numerical array with the values of the current row diff --git a/reference/cubrid/cubridmysql/cubrid-field-flags.xml b/reference/cubrid/cubridmysql/cubrid-field-flags.xml index 7299de51f..0ea9f7e66 100644 --- a/reference/cubrid/cubridmysql/cubrid-field-flags.xml +++ b/reference/cubrid/cubridmysql/cubrid-field-flags.xml @@ -1,6 +1,6 @@ - + cubrid_field_flags Return a string with the flags of the given field offset diff --git a/reference/cubrid/cubridmysql/cubrid-field-len.xml b/reference/cubrid/cubridmysql/cubrid-field-len.xml index b6f9705e2..6daf4ab0f 100644 --- a/reference/cubrid/cubridmysql/cubrid-field-len.xml +++ b/reference/cubrid/cubridmysql/cubrid-field-len.xml @@ -1,6 +1,6 @@ - + cubrid_field_len Get the maximum length of the specified field diff --git a/reference/cubrid/cubridmysql/cubrid-field-name.xml b/reference/cubrid/cubridmysql/cubrid-field-name.xml index ed9241d3c..287728322 100644 --- a/reference/cubrid/cubridmysql/cubrid-field-name.xml +++ b/reference/cubrid/cubridmysql/cubrid-field-name.xml @@ -1,6 +1,6 @@ - + cubrid_field_name Return the name of the specified field index diff --git a/reference/cubrid/cubridmysql/cubrid-field-seek.xml b/reference/cubrid/cubridmysql/cubrid-field-seek.xml index d88a2560d..8058c88da 100644 --- a/reference/cubrid/cubridmysql/cubrid-field-seek.xml +++ b/reference/cubrid/cubridmysql/cubrid-field-seek.xml @@ -1,6 +1,6 @@ - + cubrid_field_seek Move the result set cursor to the specified field offset diff --git a/reference/cubrid/cubridmysql/cubrid-field-table.xml b/reference/cubrid/cubridmysql/cubrid-field-table.xml index fd6a53ed6..c2043173d 100644 --- a/reference/cubrid/cubridmysql/cubrid-field-table.xml +++ b/reference/cubrid/cubridmysql/cubrid-field-table.xml @@ -1,6 +1,6 @@ - + cubrid_field_table Return the name of the table of the specified field diff --git a/reference/cubrid/cubridmysql/cubrid-field-type.xml b/reference/cubrid/cubridmysql/cubrid-field-type.xml index 45efda969..c70906547 100644 --- a/reference/cubrid/cubridmysql/cubrid-field-type.xml +++ b/reference/cubrid/cubridmysql/cubrid-field-type.xml @@ -1,6 +1,6 @@ - + cubrid_field_type Return the type of the column corresponding to the given field offset diff --git a/reference/cubrid/cubridmysql/cubrid-list-dbs.xml b/reference/cubrid/cubridmysql/cubrid-list-dbs.xml index 2e33932e4..92ef4229d 100644 --- a/reference/cubrid/cubridmysql/cubrid-list-dbs.xml +++ b/reference/cubrid/cubridmysql/cubrid-list-dbs.xml @@ -1,6 +1,6 @@ - + cubrid_list_dbs Return an array with the list of all existing CUBRID databases diff --git a/reference/cubrid/cubridmysql/cubrid-num-fields.xml b/reference/cubrid/cubridmysql/cubrid-num-fields.xml index b12852c7b..81c78544b 100644 --- a/reference/cubrid/cubridmysql/cubrid-num-fields.xml +++ b/reference/cubrid/cubridmysql/cubrid-num-fields.xml @@ -1,6 +1,6 @@ - + cubrid_num_fields Return the number of columns in the result set diff --git a/reference/cubrid/cubridmysql/cubrid-ping.xml b/reference/cubrid/cubridmysql/cubrid-ping.xml index 9d0c20540..e646c205a 100644 --- a/reference/cubrid/cubridmysql/cubrid-ping.xml +++ b/reference/cubrid/cubridmysql/cubrid-ping.xml @@ -1,6 +1,6 @@ - + cubrid_ping Ping a server connection or reconnect if there is no connection diff --git a/reference/cubrid/cubridmysql/cubrid-query.xml b/reference/cubrid/cubridmysql/cubrid-query.xml index 0a6261eca..9bd445f80 100644 --- a/reference/cubrid/cubridmysql/cubrid-query.xml +++ b/reference/cubrid/cubridmysql/cubrid-query.xml @@ -1,6 +1,6 @@ - + cubrid_query Send a CUBRID query diff --git a/reference/cubrid/cubridmysql/cubrid-real-escape-string.xml b/reference/cubrid/cubridmysql/cubrid-real-escape-string.xml index 4b3cfe1f8..9c22e146a 100644 --- a/reference/cubrid/cubridmysql/cubrid-real-escape-string.xml +++ b/reference/cubrid/cubridmysql/cubrid-real-escape-string.xml @@ -1,6 +1,6 @@ - + cubrid_real_escape_string Escape special characters in a string for use in an SQL statement diff --git a/reference/cubrid/cubridmysql/cubrid-result.xml b/reference/cubrid/cubridmysql/cubrid-result.xml index b772ea58b..2775814ee 100644 --- a/reference/cubrid/cubridmysql/cubrid-result.xml +++ b/reference/cubrid/cubridmysql/cubrid-result.xml @@ -1,6 +1,6 @@ - + cubrid_result Return the value of a specific field in a specific row diff --git a/reference/cubrid/cubridmysql/cubrid-unbuffered-query.xml b/reference/cubrid/cubridmysql/cubrid-unbuffered-query.xml index c45b4b9d4..87a6d9fb1 100644 --- a/reference/cubrid/cubridmysql/cubrid-unbuffered-query.xml +++ b/reference/cubrid/cubridmysql/cubrid-unbuffered-query.xml @@ -1,6 +1,6 @@ - + cubrid_unbuffered_query Perform a query without fetching the results into memory diff --git a/reference/cubrid/examples.xml b/reference/cubrid/examples.xml index 96769e13c..8f7b11212 100644 --- a/reference/cubrid/examples.xml +++ b/reference/cubrid/examples.xml @@ -1,6 +1,6 @@ - + &reftitle.examples; The following is a simple example that establishes a connection between PHP and CUBRID. This section will cover the most basic and notable features. The following code required to connect to CUBRID database, which means CUBRID Server and CUBRID Broker have to be running. The example below uses the demodb database as an examples. By default it is created during the installation. Make sure it has been created. diff --git a/reference/cubrid/functions/cubrid-bind.xml b/reference/cubrid/functions/cubrid-bind.xml index c4c47f257..5e027df63 100644 --- a/reference/cubrid/functions/cubrid-bind.xml +++ b/reference/cubrid/functions/cubrid-bind.xml @@ -1,6 +1,6 @@ - + cubrid_bind Bind variables to a prepared statement as parameters diff --git a/reference/cubrid/functions/cubrid-close-prepare.xml b/reference/cubrid/functions/cubrid-close-prepare.xml index 7f02a6502..8b71b7656 100644 --- a/reference/cubrid/functions/cubrid-close-prepare.xml +++ b/reference/cubrid/functions/cubrid-close-prepare.xml @@ -1,6 +1,6 @@ - + cubrid_close_prepare Close the request handle diff --git a/reference/cubrid/functions/cubrid-close-request.xml b/reference/cubrid/functions/cubrid-close-request.xml index 9ab9f38d8..44d04f10a 100644 --- a/reference/cubrid/functions/cubrid-close-request.xml +++ b/reference/cubrid/functions/cubrid-close-request.xml @@ -1,6 +1,6 @@ - + cubrid_close_request Close the request handle diff --git a/reference/cubrid/functions/cubrid-col-get.xml b/reference/cubrid/functions/cubrid-col-get.xml index 38c79b619..58f5b4dc6 100644 --- a/reference/cubrid/functions/cubrid-col-get.xml +++ b/reference/cubrid/functions/cubrid-col-get.xml @@ -1,6 +1,6 @@ - + cubrid_col_get Get contents of collection type column using OID diff --git a/reference/cubrid/functions/cubrid-col-size.xml b/reference/cubrid/functions/cubrid-col-size.xml index 63b49ada7..b83ba89d0 100644 --- a/reference/cubrid/functions/cubrid-col-size.xml +++ b/reference/cubrid/functions/cubrid-col-size.xml @@ -1,6 +1,6 @@ - + cubrid_col_size Get the number of elements in collection type column using OID diff --git a/reference/cubrid/functions/cubrid-column-names.xml b/reference/cubrid/functions/cubrid-column-names.xml index 0fb8a37de..17960b0a2 100644 --- a/reference/cubrid/functions/cubrid-column-names.xml +++ b/reference/cubrid/functions/cubrid-column-names.xml @@ -1,6 +1,6 @@ - + cubrid_column_names Get the column names in result diff --git a/reference/cubrid/functions/cubrid-column-types.xml b/reference/cubrid/functions/cubrid-column-types.xml index 7431f6ffd..730f6da0a 100644 --- a/reference/cubrid/functions/cubrid-column-types.xml +++ b/reference/cubrid/functions/cubrid-column-types.xml @@ -1,6 +1,6 @@ - + cubrid_column_types Get column types in result diff --git a/reference/cubrid/functions/cubrid-commit.xml b/reference/cubrid/functions/cubrid-commit.xml index 90055a29f..61aaf2f95 100644 --- a/reference/cubrid/functions/cubrid-commit.xml +++ b/reference/cubrid/functions/cubrid-commit.xml @@ -1,6 +1,6 @@ - + cubrid_commit Commit a transaction diff --git a/reference/cubrid/functions/cubrid-connect-with-url.xml b/reference/cubrid/functions/cubrid-connect-with-url.xml index 89583b179..a95826ff8 100644 --- a/reference/cubrid/functions/cubrid-connect-with-url.xml +++ b/reference/cubrid/functions/cubrid-connect-with-url.xml @@ -1,6 +1,6 @@ - + cubrid_connect_with_url Establish the environment for connecting to CUBRID server diff --git a/reference/cubrid/functions/cubrid-connect.xml b/reference/cubrid/functions/cubrid-connect.xml index 4e7107b1b..7c8ed036d 100644 --- a/reference/cubrid/functions/cubrid-connect.xml +++ b/reference/cubrid/functions/cubrid-connect.xml @@ -1,6 +1,6 @@ - + cubrid_connect Open a connection to a CUBRID Server diff --git a/reference/cubrid/functions/cubrid-current-oid.xml b/reference/cubrid/functions/cubrid-current-oid.xml index c4de97d35..ff2d0ca5e 100644 --- a/reference/cubrid/functions/cubrid-current-oid.xml +++ b/reference/cubrid/functions/cubrid-current-oid.xml @@ -1,6 +1,6 @@ - + cubrid_current_oid Get OID of the current cursor location diff --git a/reference/cubrid/functions/cubrid-disconnect.xml b/reference/cubrid/functions/cubrid-disconnect.xml index 730a5874f..853a768a9 100644 --- a/reference/cubrid/functions/cubrid-disconnect.xml +++ b/reference/cubrid/functions/cubrid-disconnect.xml @@ -1,6 +1,6 @@ - + cubrid_disconnect Close a database connection diff --git a/reference/cubrid/functions/cubrid-drop.xml b/reference/cubrid/functions/cubrid-drop.xml index 53b556491..eceb40157 100644 --- a/reference/cubrid/functions/cubrid-drop.xml +++ b/reference/cubrid/functions/cubrid-drop.xml @@ -1,6 +1,6 @@ - + cubrid_drop Delete an instance using OID diff --git a/reference/cubrid/functions/cubrid-error-code-facility.xml b/reference/cubrid/functions/cubrid-error-code-facility.xml index 0c5682431..59ecdcdc3 100644 --- a/reference/cubrid/functions/cubrid-error-code-facility.xml +++ b/reference/cubrid/functions/cubrid-error-code-facility.xml @@ -1,6 +1,6 @@ - + cubrid_error_code_facility Get the facility code of error diff --git a/reference/cubrid/functions/cubrid-error-code.xml b/reference/cubrid/functions/cubrid-error-code.xml index 798964137..9e35a85a5 100644 --- a/reference/cubrid/functions/cubrid-error-code.xml +++ b/reference/cubrid/functions/cubrid-error-code.xml @@ -1,6 +1,6 @@ - + cubrid_error_code Get error code for the most recent function call diff --git a/reference/cubrid/functions/cubrid-error-msg.xml b/reference/cubrid/functions/cubrid-error-msg.xml index c2b5498ec..8a8f78ea9 100644 --- a/reference/cubrid/functions/cubrid-error-msg.xml +++ b/reference/cubrid/functions/cubrid-error-msg.xml @@ -1,6 +1,6 @@ - + cubrid_error_msg Get last error message for the most recent function call diff --git a/reference/cubrid/functions/cubrid-execute.xml b/reference/cubrid/functions/cubrid-execute.xml index 3148a966a..a0a34d6e1 100644 --- a/reference/cubrid/functions/cubrid-execute.xml +++ b/reference/cubrid/functions/cubrid-execute.xml @@ -1,6 +1,6 @@ - + cubrid_execute Execute a prepared SQL statement diff --git a/reference/cubrid/functions/cubrid-fetch.xml b/reference/cubrid/functions/cubrid-fetch.xml index 4ae412bf7..5391cffeb 100644 --- a/reference/cubrid/functions/cubrid-fetch.xml +++ b/reference/cubrid/functions/cubrid-fetch.xml @@ -1,6 +1,6 @@ - + cubrid_fetch Fetch the next row from a result set diff --git a/reference/cubrid/functions/cubrid-free-result.xml b/reference/cubrid/functions/cubrid-free-result.xml index 83ec6e82b..ac1c47388 100644 --- a/reference/cubrid/functions/cubrid-free-result.xml +++ b/reference/cubrid/functions/cubrid-free-result.xml @@ -1,6 +1,6 @@ - + cubrid_free_result Free the memory occupied by the result data diff --git a/reference/cubrid/functions/cubrid-get-autocommit.xml b/reference/cubrid/functions/cubrid-get-autocommit.xml index 3ab793ca6..49b6d578a 100644 --- a/reference/cubrid/functions/cubrid-get-autocommit.xml +++ b/reference/cubrid/functions/cubrid-get-autocommit.xml @@ -1,6 +1,6 @@ - + cubrid_get_autocommit Get auto-commit mode of the connection diff --git a/reference/cubrid/functions/cubrid-get-charset.xml b/reference/cubrid/functions/cubrid-get-charset.xml index 2aad500fd..a924b5102 100644 --- a/reference/cubrid/functions/cubrid-get-charset.xml +++ b/reference/cubrid/functions/cubrid-get-charset.xml @@ -1,6 +1,6 @@ - + cubrid_get_charset Return the current CUBRID connection charset diff --git a/reference/cubrid/functions/cubrid-get-class-name.xml b/reference/cubrid/functions/cubrid-get-class-name.xml index e9b09a5fc..c1209b1b5 100644 --- a/reference/cubrid/functions/cubrid-get-class-name.xml +++ b/reference/cubrid/functions/cubrid-get-class-name.xml @@ -1,6 +1,6 @@ - + cubrid_get_class_name Get the class name using OID diff --git a/reference/cubrid/functions/cubrid-get-client-info.xml b/reference/cubrid/functions/cubrid-get-client-info.xml index 5dff1dea5..d1fd70730 100644 --- a/reference/cubrid/functions/cubrid-get-client-info.xml +++ b/reference/cubrid/functions/cubrid-get-client-info.xml @@ -1,6 +1,6 @@ - + cubrid_get_client_info Return the client library version diff --git a/reference/cubrid/functions/cubrid-get-db-parameter.xml b/reference/cubrid/functions/cubrid-get-db-parameter.xml index 5337b2af6..879f5c55f 100644 --- a/reference/cubrid/functions/cubrid-get-db-parameter.xml +++ b/reference/cubrid/functions/cubrid-get-db-parameter.xml @@ -1,6 +1,6 @@ - + cubrid_get_db_parameter Returns the CUBRID database parameters diff --git a/reference/cubrid/functions/cubrid-get-query-timeout.xml b/reference/cubrid/functions/cubrid-get-query-timeout.xml index dbe24d024..cb7391b56 100644 --- a/reference/cubrid/functions/cubrid-get-query-timeout.xml +++ b/reference/cubrid/functions/cubrid-get-query-timeout.xml @@ -1,6 +1,6 @@ - + cubrid_get_query_timeout Get the query timeout value of the request diff --git a/reference/cubrid/functions/cubrid-get-server-info.xml b/reference/cubrid/functions/cubrid-get-server-info.xml index 81741e70c..2512354b5 100644 --- a/reference/cubrid/functions/cubrid-get-server-info.xml +++ b/reference/cubrid/functions/cubrid-get-server-info.xml @@ -1,6 +1,6 @@ - + cubrid_get_server_info Return the CUBRID server version diff --git a/reference/cubrid/functions/cubrid-get.xml b/reference/cubrid/functions/cubrid-get.xml index d91f6f203..53e17341c 100644 --- a/reference/cubrid/functions/cubrid-get.xml +++ b/reference/cubrid/functions/cubrid-get.xml @@ -1,6 +1,6 @@ - + cubrid_get Get a column using OID diff --git a/reference/cubrid/functions/cubrid-insert-id.xml b/reference/cubrid/functions/cubrid-insert-id.xml index c1e992ee8..ebd4f7857 100644 --- a/reference/cubrid/functions/cubrid-insert-id.xml +++ b/reference/cubrid/functions/cubrid-insert-id.xml @@ -1,6 +1,6 @@ - + cubrid_insert_id Return the ID generated for the last updated AUTO_INCREMENT column diff --git a/reference/cubrid/functions/cubrid-is-instance.xml b/reference/cubrid/functions/cubrid-is-instance.xml index c9e68d0af..810968343 100644 --- a/reference/cubrid/functions/cubrid-is-instance.xml +++ b/reference/cubrid/functions/cubrid-is-instance.xml @@ -1,6 +1,6 @@ - + cubrid_is_instance Check whether the instance pointed by OID exists diff --git a/reference/cubrid/functions/cubrid-lob-close.xml b/reference/cubrid/functions/cubrid-lob-close.xml index 0648917e1..0f950a883 100644 --- a/reference/cubrid/functions/cubrid-lob-close.xml +++ b/reference/cubrid/functions/cubrid-lob-close.xml @@ -1,6 +1,6 @@ - + cubrid_lob_close Close BLOB/CLOB data diff --git a/reference/cubrid/functions/cubrid-lob-export.xml b/reference/cubrid/functions/cubrid-lob-export.xml index 5d8406d43..56b0e2d0e 100644 --- a/reference/cubrid/functions/cubrid-lob-export.xml +++ b/reference/cubrid/functions/cubrid-lob-export.xml @@ -1,6 +1,6 @@ - + cubrid_lob_export Export BLOB/CLOB data to file diff --git a/reference/cubrid/functions/cubrid-lob-get.xml b/reference/cubrid/functions/cubrid-lob-get.xml index 6faf6d2bd..ec7809214 100644 --- a/reference/cubrid/functions/cubrid-lob-get.xml +++ b/reference/cubrid/functions/cubrid-lob-get.xml @@ -1,6 +1,6 @@ - + cubrid_lob_get Get BLOB/CLOB data diff --git a/reference/cubrid/functions/cubrid-lob-send.xml b/reference/cubrid/functions/cubrid-lob-send.xml index 0220f7ec6..dde521746 100644 --- a/reference/cubrid/functions/cubrid-lob-send.xml +++ b/reference/cubrid/functions/cubrid-lob-send.xml @@ -1,6 +1,6 @@ - + cubrid_lob_send Read BLOB/CLOB data and send straight to browser diff --git a/reference/cubrid/functions/cubrid-lob-size.xml b/reference/cubrid/functions/cubrid-lob-size.xml index ab7261770..9b1bebe21 100644 --- a/reference/cubrid/functions/cubrid-lob-size.xml +++ b/reference/cubrid/functions/cubrid-lob-size.xml @@ -1,6 +1,6 @@ - + cubrid_lob_size Get BLOB/CLOB data size diff --git a/reference/cubrid/functions/cubrid-lob2-bind.xml b/reference/cubrid/functions/cubrid-lob2-bind.xml index d79c60157..c7803e21d 100644 --- a/reference/cubrid/functions/cubrid-lob2-bind.xml +++ b/reference/cubrid/functions/cubrid-lob2-bind.xml @@ -1,6 +1,6 @@ - + cubrid_lob2_bind Bind a lob object or a string as a lob object to a prepared statement as parameters diff --git a/reference/cubrid/functions/cubrid-lob2-close.xml b/reference/cubrid/functions/cubrid-lob2-close.xml index 85bd9b233..82f0f380f 100644 --- a/reference/cubrid/functions/cubrid-lob2-close.xml +++ b/reference/cubrid/functions/cubrid-lob2-close.xml @@ -1,6 +1,6 @@ - + cubrid_lob2_close Close LOB object diff --git a/reference/cubrid/functions/cubrid-lob2-export.xml b/reference/cubrid/functions/cubrid-lob2-export.xml index 278c0491d..ef46535b3 100644 --- a/reference/cubrid/functions/cubrid-lob2-export.xml +++ b/reference/cubrid/functions/cubrid-lob2-export.xml @@ -1,6 +1,6 @@ - + cubrid_lob2_export Export the lob object to a file diff --git a/reference/cubrid/functions/cubrid-lob2-import.xml b/reference/cubrid/functions/cubrid-lob2-import.xml index 0e837f170..29374f99c 100644 --- a/reference/cubrid/functions/cubrid-lob2-import.xml +++ b/reference/cubrid/functions/cubrid-lob2-import.xml @@ -1,6 +1,6 @@ - + cubrid_lob2_import Import BLOB/CLOB data from a file diff --git a/reference/cubrid/functions/cubrid-lob2-new.xml b/reference/cubrid/functions/cubrid-lob2-new.xml index 12f6a7b53..93c7d6d55 100644 --- a/reference/cubrid/functions/cubrid-lob2-new.xml +++ b/reference/cubrid/functions/cubrid-lob2-new.xml @@ -1,6 +1,6 @@ - + cubrid_lob2_new Create a lob object diff --git a/reference/cubrid/functions/cubrid-lob2-read.xml b/reference/cubrid/functions/cubrid-lob2-read.xml index 1c2c05fda..295f08f30 100644 --- a/reference/cubrid/functions/cubrid-lob2-read.xml +++ b/reference/cubrid/functions/cubrid-lob2-read.xml @@ -1,6 +1,6 @@ - + cubrid_lob2_read Read from BLOB/CLOB data diff --git a/reference/cubrid/functions/cubrid-lob2-seek.xml b/reference/cubrid/functions/cubrid-lob2-seek.xml index 3af4192ea..5733e71b5 100644 --- a/reference/cubrid/functions/cubrid-lob2-seek.xml +++ b/reference/cubrid/functions/cubrid-lob2-seek.xml @@ -1,6 +1,6 @@ - + cubrid_lob2_seek Move the cursor of a lob object diff --git a/reference/cubrid/functions/cubrid-lob2-seek64.xml b/reference/cubrid/functions/cubrid-lob2-seek64.xml index 9561317d7..826c85f3b 100644 --- a/reference/cubrid/functions/cubrid-lob2-seek64.xml +++ b/reference/cubrid/functions/cubrid-lob2-seek64.xml @@ -1,6 +1,6 @@ - + cubrid_lob2_seek64 Move the cursor of a lob object diff --git a/reference/cubrid/functions/cubrid-lob2-size.xml b/reference/cubrid/functions/cubrid-lob2-size.xml index 183d27f72..068b176bb 100644 --- a/reference/cubrid/functions/cubrid-lob2-size.xml +++ b/reference/cubrid/functions/cubrid-lob2-size.xml @@ -1,6 +1,6 @@ - + cubrid_lob2_size Get a lob object's size diff --git a/reference/cubrid/functions/cubrid-lob2-size64.xml b/reference/cubrid/functions/cubrid-lob2-size64.xml index 7f0b966ab..c974021e7 100644 --- a/reference/cubrid/functions/cubrid-lob2-size64.xml +++ b/reference/cubrid/functions/cubrid-lob2-size64.xml @@ -1,6 +1,6 @@ - + cubrid_lob2_size64 Get a lob object's size diff --git a/reference/cubrid/functions/cubrid-lob2-tell.xml b/reference/cubrid/functions/cubrid-lob2-tell.xml index ddf413fb2..fa929d3e5 100644 --- a/reference/cubrid/functions/cubrid-lob2-tell.xml +++ b/reference/cubrid/functions/cubrid-lob2-tell.xml @@ -1,6 +1,6 @@ - + cubrid_lob2_tell Tell the cursor position of the LOB object diff --git a/reference/cubrid/functions/cubrid-lob2-tell64.xml b/reference/cubrid/functions/cubrid-lob2-tell64.xml index 224a46ae5..cc91a1336 100644 --- a/reference/cubrid/functions/cubrid-lob2-tell64.xml +++ b/reference/cubrid/functions/cubrid-lob2-tell64.xml @@ -1,6 +1,6 @@ - + cubrid_lob2_tell64 Tell the cursor position of the LOB object diff --git a/reference/cubrid/functions/cubrid-lob2-write.xml b/reference/cubrid/functions/cubrid-lob2-write.xml index 2383fd694..a4a3a3646 100644 --- a/reference/cubrid/functions/cubrid-lob2-write.xml +++ b/reference/cubrid/functions/cubrid-lob2-write.xml @@ -1,6 +1,6 @@ - + cubrid_lob2_write Write to a lob object diff --git a/reference/cubrid/functions/cubrid-lock-read.xml b/reference/cubrid/functions/cubrid-lock-read.xml index 5c820a05d..1eea3a2b9 100644 --- a/reference/cubrid/functions/cubrid-lock-read.xml +++ b/reference/cubrid/functions/cubrid-lock-read.xml @@ -1,6 +1,6 @@ - + cubrid_lock_read Set a read lock on the given OID diff --git a/reference/cubrid/functions/cubrid-lock-write.xml b/reference/cubrid/functions/cubrid-lock-write.xml index a141af74c..880ae964d 100644 --- a/reference/cubrid/functions/cubrid-lock-write.xml +++ b/reference/cubrid/functions/cubrid-lock-write.xml @@ -1,6 +1,6 @@ - + cubrid_lock_write Set a write lock on the given OID diff --git a/reference/cubrid/functions/cubrid-move-cursor.xml b/reference/cubrid/functions/cubrid-move-cursor.xml index 217faa8be..d520fa455 100644 --- a/reference/cubrid/functions/cubrid-move-cursor.xml +++ b/reference/cubrid/functions/cubrid-move-cursor.xml @@ -1,6 +1,6 @@ - + cubrid_move_cursor Move the cursor in the result diff --git a/reference/cubrid/functions/cubrid-next-result.xml b/reference/cubrid/functions/cubrid-next-result.xml index e66ce0f5e..4631270b0 100644 --- a/reference/cubrid/functions/cubrid-next-result.xml +++ b/reference/cubrid/functions/cubrid-next-result.xml @@ -1,6 +1,6 @@ - + cubrid_next_result Get result of next query when executing multiple SQL statements diff --git a/reference/cubrid/functions/cubrid-num-cols.xml b/reference/cubrid/functions/cubrid-num-cols.xml index abd1ec83c..258c799f8 100644 --- a/reference/cubrid/functions/cubrid-num-cols.xml +++ b/reference/cubrid/functions/cubrid-num-cols.xml @@ -1,6 +1,6 @@ - + cubrid_num_cols Return the number of columns in the result set diff --git a/reference/cubrid/functions/cubrid-num-rows.xml b/reference/cubrid/functions/cubrid-num-rows.xml index 632c3cf2d..991a97b12 100644 --- a/reference/cubrid/functions/cubrid-num-rows.xml +++ b/reference/cubrid/functions/cubrid-num-rows.xml @@ -1,6 +1,6 @@ - + cubrid_num_rows Get the number of rows in the result set diff --git a/reference/cubrid/functions/cubrid-pconnect-with-url.xml b/reference/cubrid/functions/cubrid-pconnect-with-url.xml index 1dc7e3873..f5f45a952 100644 --- a/reference/cubrid/functions/cubrid-pconnect-with-url.xml +++ b/reference/cubrid/functions/cubrid-pconnect-with-url.xml @@ -1,6 +1,6 @@ - + cubrid_pconnect_with_url Open a persistent connection to CUBRID server diff --git a/reference/cubrid/functions/cubrid-pconnect.xml b/reference/cubrid/functions/cubrid-pconnect.xml index 84b9bf239..50d73323d 100644 --- a/reference/cubrid/functions/cubrid-pconnect.xml +++ b/reference/cubrid/functions/cubrid-pconnect.xml @@ -1,6 +1,6 @@ - + cubrid_pconnect Open a persistent connection to a CUBRID server diff --git a/reference/cubrid/functions/cubrid-prepare.xml b/reference/cubrid/functions/cubrid-prepare.xml index ed9878f97..ccfddff82 100644 --- a/reference/cubrid/functions/cubrid-prepare.xml +++ b/reference/cubrid/functions/cubrid-prepare.xml @@ -1,6 +1,6 @@ - + cubrid_prepare Prepare a SQL statement for execution diff --git a/reference/cubrid/functions/cubrid-put.xml b/reference/cubrid/functions/cubrid-put.xml index a8bb2a9a7..94c21af87 100644 --- a/reference/cubrid/functions/cubrid-put.xml +++ b/reference/cubrid/functions/cubrid-put.xml @@ -1,6 +1,6 @@ - + cubrid_put Update a column using OID diff --git a/reference/cubrid/functions/cubrid-rollback.xml b/reference/cubrid/functions/cubrid-rollback.xml index ba2d08998..ace358a87 100644 --- a/reference/cubrid/functions/cubrid-rollback.xml +++ b/reference/cubrid/functions/cubrid-rollback.xml @@ -1,6 +1,6 @@ - + cubrid_rollback Roll back a transaction diff --git a/reference/cubrid/functions/cubrid-schema.xml b/reference/cubrid/functions/cubrid-schema.xml index 036862df0..a92b663c3 100644 --- a/reference/cubrid/functions/cubrid-schema.xml +++ b/reference/cubrid/functions/cubrid-schema.xml @@ -1,6 +1,6 @@ - + cubrid_schema Get the requested schema information diff --git a/reference/cubrid/functions/cubrid-seq-drop.xml b/reference/cubrid/functions/cubrid-seq-drop.xml index b281c0a0f..6a8348922 100644 --- a/reference/cubrid/functions/cubrid-seq-drop.xml +++ b/reference/cubrid/functions/cubrid-seq-drop.xml @@ -1,6 +1,6 @@ - + cubrid_seq_drop Delete an element from sequence type column using OID diff --git a/reference/cubrid/functions/cubrid-seq-insert.xml b/reference/cubrid/functions/cubrid-seq-insert.xml index 62e0ab25a..638ca5ca2 100644 --- a/reference/cubrid/functions/cubrid-seq-insert.xml +++ b/reference/cubrid/functions/cubrid-seq-insert.xml @@ -1,6 +1,6 @@ - + cubrid_seq_insert Insert an element to a sequence type column using OID diff --git a/reference/cubrid/functions/cubrid-seq-put.xml b/reference/cubrid/functions/cubrid-seq-put.xml index 7349e0b3f..9cef107f8 100644 --- a/reference/cubrid/functions/cubrid-seq-put.xml +++ b/reference/cubrid/functions/cubrid-seq-put.xml @@ -1,6 +1,6 @@ - + cubrid_seq_put Update the element value of sequence type column using OID diff --git a/reference/cubrid/functions/cubrid-set-add.xml b/reference/cubrid/functions/cubrid-set-add.xml index df5333fb3..11d585d02 100644 --- a/reference/cubrid/functions/cubrid-set-add.xml +++ b/reference/cubrid/functions/cubrid-set-add.xml @@ -1,6 +1,6 @@ - + cubrid_set_add Insert a single element to set type column using OID diff --git a/reference/cubrid/functions/cubrid-set-autocommit.xml b/reference/cubrid/functions/cubrid-set-autocommit.xml index 0a13502f8..b5ac391fe 100644 --- a/reference/cubrid/functions/cubrid-set-autocommit.xml +++ b/reference/cubrid/functions/cubrid-set-autocommit.xml @@ -1,6 +1,6 @@ - + cubrid_set_autocommit Set autocommit mode of the connection diff --git a/reference/cubrid/functions/cubrid-set-db-parameter.xml b/reference/cubrid/functions/cubrid-set-db-parameter.xml index 79bc0e07d..9d80742fc 100644 --- a/reference/cubrid/functions/cubrid-set-db-parameter.xml +++ b/reference/cubrid/functions/cubrid-set-db-parameter.xml @@ -1,6 +1,6 @@ - + cubrid_set_db_parameter Sets the CUBRID database parameters diff --git a/reference/cubrid/functions/cubrid-set-drop.xml b/reference/cubrid/functions/cubrid-set-drop.xml index 64c3449fc..258cf53ad 100644 --- a/reference/cubrid/functions/cubrid-set-drop.xml +++ b/reference/cubrid/functions/cubrid-set-drop.xml @@ -1,6 +1,6 @@ - + cubrid_set_drop Delete an element from set type column using OID diff --git a/reference/cubrid/functions/cubrid-set-query-timeout.xml b/reference/cubrid/functions/cubrid-set-query-timeout.xml index 5c53b6971..8ebd4d71d 100644 --- a/reference/cubrid/functions/cubrid-set-query-timeout.xml +++ b/reference/cubrid/functions/cubrid-set-query-timeout.xml @@ -1,6 +1,6 @@ - + cubrid_set_query_timeout Set the timeout time of query execution diff --git a/reference/cubrid/functions/cubrid-version.xml b/reference/cubrid/functions/cubrid-version.xml index b0ddb2661..4cffb634a 100644 --- a/reference/cubrid/functions/cubrid-version.xml +++ b/reference/cubrid/functions/cubrid-version.xml @@ -1,6 +1,6 @@ - + cubrid_version Get the CUBRID PHP module's version diff --git a/reference/cubrid/oldaliases/cubrid-load-from-glo.xml b/reference/cubrid/oldaliases/cubrid-load-from-glo.xml index 19f937608..543afc851 100644 --- a/reference/cubrid/oldaliases/cubrid-load-from-glo.xml +++ b/reference/cubrid/oldaliases/cubrid-load-from-glo.xml @@ -1,6 +1,6 @@ - + cubrid_load_from_glo Read data from a GLO instance and save it in a file diff --git a/reference/cubrid/oldaliases/cubrid-new-glo.xml b/reference/cubrid/oldaliases/cubrid-new-glo.xml index 176a5d1be..6ef73ad99 100644 --- a/reference/cubrid/oldaliases/cubrid-new-glo.xml +++ b/reference/cubrid/oldaliases/cubrid-new-glo.xml @@ -1,6 +1,6 @@ - + cubrid_new_glo Create a glo instance diff --git a/reference/cubrid/oldaliases/cubrid-save-to-glo.xml b/reference/cubrid/oldaliases/cubrid-save-to-glo.xml index d9ccfff66..dfa4bb418 100644 --- a/reference/cubrid/oldaliases/cubrid-save-to-glo.xml +++ b/reference/cubrid/oldaliases/cubrid-save-to-glo.xml @@ -1,6 +1,6 @@ - + cubrid_save_to_glo Save requested file in a GLO instance diff --git a/reference/cubrid/oldaliases/cubrid-send-glo.xml b/reference/cubrid/oldaliases/cubrid-send-glo.xml index 9ecce71bf..ef34e1e4c 100644 --- a/reference/cubrid/oldaliases/cubrid-send-glo.xml +++ b/reference/cubrid/oldaliases/cubrid-send-glo.xml @@ -1,6 +1,6 @@ - + cubrid_send_glo Read data from glo and send it to std output diff --git a/reference/cubrid/setup.xml b/reference/cubrid/setup.xml index bce5962b3..5580f89a9 100644 --- a/reference/cubrid/setup.xml +++ b/reference/cubrid/setup.xml @@ -1,9 +1,9 @@ - + &reftitle.setup; -
+
&reftitle.required; In order to have these functions available, you must install CUBRID, and compile CUBRID PHP Library with CUBRID support. diff --git a/reference/dbase/book.xml b/reference/dbase/book.xml index 4ec110cf4..57eb36dd5 100644 --- a/reference/dbase/book.xml +++ b/reference/dbase/book.xml @@ -1,48 +1,48 @@ - + dBase - + &reftitle.intro; - + &pecl.moved-ver;5.3.0. - + - + These functions allow you to access records stored in dBase-format (dbf) databases. - + - + We recommend against using dBase files as your production - database. Use SQLite or choose any real SQL server instead; SQLite or choose any real SQL server instead; MySQL or Postgres are common choices with PHP. dBase support is here to allow you to import and export data to and from your web database, because the file format is commonly understood by Windows spreadsheets and organizers. - + - + As of dbase 7.0.0 the databases are automatically locked via flock. There has been no support for locking earlier, so two concurrent web server processes modifying the same dBase file would have very likely ruined your database. This can happen even with dbase 7.0.0+ on systems which implement the locks at the process level with multithreaded SAPIs. - + - - dBase files are simple sequential files of fixed length records. + + dBase files are simple sequential files of fixed length records. Records are appended to the end of the file and deleted records are kept until you call dbase_pack. - + Only dbf file levels 3 (dBASE III+) - 5 (dBASE V) are supported. The types of dBase fields available are: @@ -103,7 +103,7 @@ L Boolean - T or Y for &true;, + T or Y for &true;, F or N for &false;, ? for uninitialized. @@ -118,21 +118,21 @@
- + As of dbase 7.0.0 nullable fields are supported for DBASE_TYPE_FOXPRO databases. If a field is nullable, passing &null; will set the respective flag, and on later retrieval the field value will be &null;. - + - + There is no support for indexes or memo fields. - + - + &reference.dbase.setup; &reference.dbase.constants; &reference.dbase.reference; diff --git a/reference/dbase/configure.xml b/reference/dbase/configure.xml index 50dd3a3bd..60f2d27a9 100644 --- a/reference/dbase/configure.xml +++ b/reference/dbase/configure.xml @@ -2,10 +2,10 @@
&reftitle.install; - + &pecl.info; &url.pecl.package;dbase. - +
&reftitle.notes; - + Boolean fields result in an int element value (0 or 1) when retrieved via dbase_get_record or dbase_get_record_with_names. If they are written back, this results in the value becoming 0, so care has to be taken to properly adjust the values. - + diff --git a/reference/dbase/reference.xml b/reference/dbase/reference.xml index c65b48a54..ce0a99418 100644 --- a/reference/dbase/reference.xml +++ b/reference/dbase/reference.xml @@ -7,13 +7,13 @@
&reftitle.examples; - - Many examples in this reference require a dBase database. We will use + + Many examples in this reference require a dBase database. We will use /tmp/test.dbf that will be created in the example of dbase_create. - +
- + &reference.dbase.entities.functions; diff --git a/reference/dbase/setup.xml b/reference/dbase/setup.xml index 47b5c33b6..967645e64 100644 --- a/reference/dbase/setup.xml +++ b/reference/dbase/setup.xml @@ -11,11 +11,11 @@
&reftitle.resources; - + As of dbase 7.0.0, the resource type dbase is defined, which is returned by dbase_open and dbase_create. - +
diff --git a/reference/dio/book.xml b/reference/dio/book.xml index 7351515e9..38e2fb6b4 100644 --- a/reference/dio/book.xml +++ b/reference/dio/book.xml @@ -1,26 +1,26 @@ - + Direct IO - + &reftitle.intro; - + PHP supports the direct io functions as described in the Posix Standard (Section 6) for performing I/O functions at a lower level than the C-Language stream I/O functions (fopen, fread,..). The use - of the DIO functions should be considered only when direct + of the DIO functions should be considered only when direct control of a device is needed. In all other cases, the standard filesystem functions are more - than adequate. - + than adequate. + - + &reference.dio.setup; &reference.dio.constants; &reference.dio.reference; diff --git a/reference/dio/configure.xml b/reference/dio/configure.xml index 80064e8d1..1ec3a761a 100644 --- a/reference/dio/configure.xml +++ b/reference/dio/configure.xml @@ -2,13 +2,13 @@
&reftitle.install; - + &pecl.moved; - - + + &pecl.info; &url.pecl.package;dio. - +
&reftitle.resources; - + One resource type is defined by this extension: a file descriptor returned by dio_open. - +
diff --git a/reference/ds/book.xml b/reference/ds/book.xml index 4a6d5f5db..e86b4e12b 100644 --- a/reference/ds/book.xml +++ b/reference/ds/book.xml @@ -8,13 +8,13 @@ &reftitle.intro; - + Efficient data structures for PHP 7, provided as an alternative to the &array;. - - + + See this blog post for benchmarks, discussion and frequently asked questions. - + &reference.ds.setup; diff --git a/reference/ds/ds.deque.xml b/reference/ds/ds.deque.xml index badebc0db..afdcbd9ed 100644 --- a/reference/ds/ds.deque.xml +++ b/reference/ds/ds.deque.xml @@ -10,22 +10,22 @@
&reftitle.intro; - + A Deque (pronounced “deck”) is a sequence of values in a contiguous buffer that grows and shrinks automatically. The name is a common abbreviation of “double-ended queue” and is used internally by Ds\Queue. - - + + Two pointers are used to keep track of a head and a tail. The pointers can “wrap around” the end of the buffer, which avoids the need to move other values around to make room. This makes shift and unshift very fast —  something a Ds\Vector can’t compete with. - - + + Accessing a value by index requires a translation between the index and its corresponding position in the buffer: ((head + position) % capacity). - +
@@ -100,7 +100,7 @@ Ds\Deque::MIN_CAPACITY - + diff --git a/reference/ds/ds.map.xml b/reference/ds/ds.map.xml index d98861711..f5361465e 100644 --- a/reference/ds/ds.map.xml +++ b/reference/ds/ds.map.xml @@ -10,11 +10,11 @@
&reftitle.intro; - + A Map is a sequential collection of key-value pairs, almost identical to an &array; used in a similar context. Keys can be any type, but must be unique. Values are replaced if added to the map using the same key. - +
@@ -82,7 +82,7 @@ Ds\Map::MIN_CAPACITY - + diff --git a/reference/ds/ds.priorityqueue.xml b/reference/ds/ds.priorityqueue.xml index bc41929b8..c375c60e5 100644 --- a/reference/ds/ds.priorityqueue.xml +++ b/reference/ds/ds.priorityqueue.xml @@ -10,23 +10,23 @@
&reftitle.intro; - + A PriorityQueue is very similar to a Queue. Values are pushed into the queue with an assigned priority, and the value with the highest priority will always be at the front of the queue. - - + + Implemented using a max heap. - + - + "First in, first out" ordering is preserved for values with the same priority. - + - + Iterating over a PriorityQueue is destructive, equivalent to successive pop operations until the queue is empty. - +
@@ -67,7 +67,7 @@ Ds\PriorityQueue::MIN_CAPACITY - + diff --git a/reference/ds/ds.queue.xml b/reference/ds/ds.queue.xml index eba8c6f4e..0633b0b5f 100644 --- a/reference/ds/ds.queue.xml +++ b/reference/ds/ds.queue.xml @@ -10,11 +10,11 @@
&reftitle.intro; - + A Queue is a “first in, first out” or “FIFO” collection that only allows access to the value at the front of the queue and iterates in that order, destructively. - +
@@ -57,7 +57,7 @@ Ds\Queue::MIN_CAPACITY - + diff --git a/reference/ds/ds.set.xml b/reference/ds/ds.set.xml index b85ef9161..25a6eb6bb 100644 --- a/reference/ds/ds.set.xml +++ b/reference/ds/ds.set.xml @@ -10,11 +10,11 @@
&reftitle.intro; - + A Set is a sequence of unique values. This implementation uses the same hash table as Ds\Map, where values are used as keys and the mapped value is ignored. - +
@@ -93,7 +93,7 @@ Ds\Set::MIN_CAPACITY - + diff --git a/reference/ds/ds.vector.xml b/reference/ds/ds.vector.xml index 9594effcd..80433c33c 100644 --- a/reference/ds/ds.vector.xml +++ b/reference/ds/ds.vector.xml @@ -10,12 +10,12 @@
&reftitle.intro; - + A Vector is a sequence of values in a contiguous buffer that grows and shrinks automatically. It’s the most efficient sequential structure because a value’s index is a direct mapping to its index in the buffer, and the growth factor isn't bound to a specific multiple or exponent. - +
@@ -87,7 +87,7 @@ Ds\Vector::MIN_CAPACITY - + diff --git a/reference/ds/ds/collection/clear.xml b/reference/ds/ds/collection/clear.xml index 4c07cf06e..82ec5a1be 100644 --- a/reference/ds/ds/collection/clear.xml +++ b/reference/ds/ds/collection/clear.xml @@ -13,9 +13,9 @@ public voidDs\Collection::clear - + Removes all values from the collection. - + @@ -25,9 +25,9 @@ &reftitle.returnvalues; - + &return.void; - + diff --git a/reference/ds/ds/collection/copy.xml b/reference/ds/ds/collection/copy.xml index ea4af34fb..b1f37d25d 100644 --- a/reference/ds/ds/collection/copy.xml +++ b/reference/ds/ds/collection/copy.xml @@ -13,9 +13,9 @@ public Ds\CollectionDs\Collection::copy - + Returns a shallow copy of the collection. - + @@ -25,9 +25,9 @@ &reftitle.returnvalues; - + Returns a shallow copy of the collection. - + diff --git a/reference/ds/ds/collection/isempty.xml b/reference/ds/ds/collection/isempty.xml index 418d0e292..e83198af1 100644 --- a/reference/ds/ds/collection/isempty.xml +++ b/reference/ds/ds/collection/isempty.xml @@ -13,9 +13,9 @@ public boolDs\Collection::isEmpty - + Returns whether the collection is empty. - + @@ -25,9 +25,9 @@ &reftitle.returnvalues; - + Returns &true; if the collection is empty, &false; otherwise. - + diff --git a/reference/ds/ds/collection/toarray.xml b/reference/ds/ds/collection/toarray.xml index 44b782af7..e51e67dde 100644 --- a/reference/ds/ds/collection/toarray.xml +++ b/reference/ds/ds/collection/toarray.xml @@ -15,13 +15,13 @@ public arrayDs\Collection::toArray - + Converts the collection to an &array;. - + - + Casting to an &array; is not supported yet. - + @@ -33,9 +33,9 @@ &reftitle.returnvalues; - + An &array; containing all the values in the same order as the collection. - + diff --git a/reference/ds/ds/deque/allocate.xml b/reference/ds/ds/deque/allocate.xml index be614818c..2ecef8958 100644 --- a/reference/ds/ds/deque/allocate.xml +++ b/reference/ds/ds/deque/allocate.xml @@ -25,19 +25,19 @@ capacity - + The number of values for which capacity should be allocated. - + - + Capacity will stay the same if this value is less than or equal to the current capacity. - + - + Capacity will always be rounded up to the nearest power of 2. - + @@ -46,9 +46,9 @@ &reftitle.returnvalues; - + &return.void; - + diff --git a/reference/ds/ds/deque/apply.xml b/reference/ds/ds/deque/apply.xml index 8d3969098..4b8bac10e 100644 --- a/reference/ds/ds/deque/apply.xml +++ b/reference/ds/ds/deque/apply.xml @@ -13,10 +13,10 @@ public voidDs\Deque::apply callablecallback - + Updates all values by applying a callback function to each value in the deque. - + @@ -33,13 +33,13 @@ mixedvalue - + A callable to apply to each value in the deque. - + - + The callback should return what the value should be replaced by. - + @@ -48,9 +48,9 @@ &reftitle.returnvalues; - + &return.void; - + diff --git a/reference/ds/ds/deque/capacity.xml b/reference/ds/ds/deque/capacity.xml index 3672eda1a..56aedbdd4 100644 --- a/reference/ds/ds/deque/capacity.xml +++ b/reference/ds/ds/deque/capacity.xml @@ -13,9 +13,9 @@ public intDs\Deque::capacity - + Returns the current capacity. - + @@ -25,9 +25,9 @@ &reftitle.returnvalues; - + The current capacity. - + diff --git a/reference/ds/ds/deque/clear.xml b/reference/ds/ds/deque/clear.xml index 742018dbc..ed611a293 100644 --- a/reference/ds/ds/deque/clear.xml +++ b/reference/ds/ds/deque/clear.xml @@ -13,9 +13,9 @@ public voidDs\Deque::clear - + Removes all values from the deque. - + @@ -25,9 +25,9 @@ &reftitle.returnvalues; - + &return.void; - + diff --git a/reference/ds/ds/deque/construct.xml b/reference/ds/ds/deque/construct.xml index 9579cc6b1..9c8dd8b0a 100644 --- a/reference/ds/ds/deque/construct.xml +++ b/reference/ds/ds/deque/construct.xml @@ -13,10 +13,10 @@ public Ds\Deque::__construct mixedvalues - + Creates a new instance, using either a traversable object or an &array; for the initial values. - + @@ -25,9 +25,9 @@ values - + A traversable object or an &array; to use for the initial values. - + diff --git a/reference/ds/ds/deque/contains.xml b/reference/ds/ds/deque/contains.xml index 878ec0320..3920f0ce3 100644 --- a/reference/ds/ds/deque/contains.xml +++ b/reference/ds/ds/deque/contains.xml @@ -13,9 +13,9 @@ public boolDs\Deque::contains mixedvalues - + Determines if the deque contains all values. - + @@ -24,9 +24,9 @@ values - + Values to check. - + @@ -34,10 +34,10 @@ &reftitle.returnvalues; - + &false; if any of the provided values are not in the deque, &true; otherwise. - + diff --git a/reference/ds/ds/deque/copy.xml b/reference/ds/ds/deque/copy.xml index 49cfb60ad..e56c7f988 100644 --- a/reference/ds/ds/deque/copy.xml +++ b/reference/ds/ds/deque/copy.xml @@ -13,9 +13,9 @@ public Ds\DequeDs\Deque::copy - + Returns a shallow copy of the deque. - + @@ -25,9 +25,9 @@ &reftitle.returnvalues; - + A shallow copy of the deque. - + diff --git a/reference/ds/ds/deque/count.xml b/reference/ds/ds/deque/count.xml index a374bdfc4..f678af1df 100644 --- a/reference/ds/ds/deque/count.xml +++ b/reference/ds/ds/deque/count.xml @@ -9,9 +9,9 @@ &reftitle.description; - + See Countable::count - + diff --git a/reference/ds/ds/deque/filter.xml b/reference/ds/ds/deque/filter.xml index 4e36f6b74..f345e4c43 100644 --- a/reference/ds/ds/deque/filter.xml +++ b/reference/ds/ds/deque/filter.xml @@ -16,10 +16,10 @@ public Ds\DequeDs\Deque::filter callablecallback - + Creates a new deque using a callable to determine which values to include. - + @@ -37,14 +37,14 @@ mixedvalue - + Optional callable which returns &true; if the value should be included, &false; otherwise. - - + + If a callback is not provided, only values which are &true; (see converting to boolean) will be included. - + @@ -53,11 +53,11 @@ &reftitle.returnvalues; - + A new deque containing all the values for which either the callback returned &true;, or all values that convert to &true; if a callback was not provided. - + diff --git a/reference/ds/ds/deque/find.xml b/reference/ds/ds/deque/find.xml index dfab9c66c..ec35b74e6 100644 --- a/reference/ds/ds/deque/find.xml +++ b/reference/ds/ds/deque/find.xml @@ -15,9 +15,9 @@ public mixedDs\Deque::find mixedvalue - + Returns the index of the value, or &false; if not found. - + @@ -27,9 +27,9 @@ value - + The value to find. - + @@ -37,13 +37,13 @@ &reftitle.returnvalues; - + The index of the value, or &false; if not found. - + - + Values will be compared by value and by type. - + diff --git a/reference/ds/ds/deque/first.xml b/reference/ds/ds/deque/first.xml index f3837b3cc..dd60c62a8 100644 --- a/reference/ds/ds/deque/first.xml +++ b/reference/ds/ds/deque/first.xml @@ -13,9 +13,9 @@ public mixedDs\Deque::first - + Returns the first value in the deque. - + @@ -25,16 +25,16 @@ &reftitle.returnvalues; - + The first value in the deque. - + &reftitle.errors; - - UnderflowException if empty. - + + UnderflowException if empty. + diff --git a/reference/ds/ds/deque/get.xml b/reference/ds/ds/deque/get.xml index 374a37383..1d3706ea8 100644 --- a/reference/ds/ds/deque/get.xml +++ b/reference/ds/ds/deque/get.xml @@ -13,9 +13,9 @@ public mixedDs\Deque::get intindex - + Returns the value at a given index. - + @@ -25,9 +25,9 @@ index - + The index to access, starting at 0. - + @@ -35,16 +35,16 @@ &reftitle.returnvalues; - + The value at the requested index. - + &reftitle.errors; - - OutOfRangeException if the index is not valid. - + + OutOfRangeException if the index is not valid. + diff --git a/reference/ds/ds/deque/insert.xml b/reference/ds/ds/deque/insert.xml index 136ec85ce..e7dda1049 100644 --- a/reference/ds/ds/deque/insert.xml +++ b/reference/ds/ds/deque/insert.xml @@ -14,9 +14,9 @@ intindex mixedvalues - + Inserts values into the deque at a given index. - + @@ -26,22 +26,22 @@ index - + The index at which to insert. 0 <= index <= count - + - + You can insert at the index equal to the number of values. - + values - + The value or values to insert. - + @@ -49,16 +49,16 @@ &reftitle.returnvalues; - + &return.void; - + &reftitle.errors; - - OutOfRangeException if the index is not valid. - + + OutOfRangeException if the index is not valid. + diff --git a/reference/ds/ds/deque/isempty.xml b/reference/ds/ds/deque/isempty.xml index 8fcf23f7e..589949671 100644 --- a/reference/ds/ds/deque/isempty.xml +++ b/reference/ds/ds/deque/isempty.xml @@ -13,9 +13,9 @@ public boolDs\Deque::isEmpty - + Returns whether the deque is empty. - + @@ -25,9 +25,9 @@ &reftitle.returnvalues; - + Returns &true; if the deque is empty, &false; otherwise. - + diff --git a/reference/ds/ds/deque/join.xml b/reference/ds/ds/deque/join.xml index 6eef2d348..fcafd61c5 100644 --- a/reference/ds/ds/deque/join.xml +++ b/reference/ds/ds/deque/join.xml @@ -13,9 +13,9 @@ public stringDs\Deque::join stringglue - + Joins all values together as a string using an optional separator between each value. - + @@ -24,9 +24,9 @@ glue - + An optional string to separate each value. - + @@ -34,9 +34,9 @@ &reftitle.returnvalues; - + All values of the deque joined together as a string. - + diff --git a/reference/ds/ds/deque/jsonserialize.xml b/reference/ds/ds/deque/jsonserialize.xml index d3be59b20..f06c70f51 100644 --- a/reference/ds/ds/deque/jsonserialize.xml +++ b/reference/ds/ds/deque/jsonserialize.xml @@ -9,13 +9,13 @@ &reftitle.description; - + See JsonSerializable::jsonSerialize - + - + You should never need to call this directly. - + diff --git a/reference/ds/ds/deque/last.xml b/reference/ds/ds/deque/last.xml index 8718c8041..8a4c15f6e 100644 --- a/reference/ds/ds/deque/last.xml +++ b/reference/ds/ds/deque/last.xml @@ -13,9 +13,9 @@ public mixedDs\Deque::last - + Returns the last value in the deque. - + @@ -25,16 +25,16 @@ &reftitle.returnvalues; - + The last value in the deque. - + &reftitle.errors; - - UnderflowException if empty. - + + UnderflowException if empty. + diff --git a/reference/ds/ds/deque/map.xml b/reference/ds/ds/deque/map.xml index def1d450e..b929ee4d9 100644 --- a/reference/ds/ds/deque/map.xml +++ b/reference/ds/ds/deque/map.xml @@ -13,10 +13,10 @@ public Ds\DequeDs\Deque::map callablecallback - + Returns the result of applying a callback function to each value in the deque. - + @@ -33,13 +33,13 @@ mixedvalue - + A callable to apply to each value in the deque. - + - + The callable should return what the new value will be in the new deque. - + @@ -48,14 +48,14 @@ &reftitle.returnvalues; - + The result of applying a callback to each value in the deque. - + - + The values of the current instance won't be affected. - + diff --git a/reference/ds/ds/deque/merge.xml b/reference/ds/ds/deque/merge.xml index 02412b276..8b828e350 100644 --- a/reference/ds/ds/deque/merge.xml +++ b/reference/ds/ds/deque/merge.xml @@ -13,9 +13,9 @@ public Ds\DequeDs\Deque::merge mixedvalues - + Returns the result of adding all given values to the deque. - + @@ -25,9 +25,9 @@ values - + A traversable object or an &array;. - + @@ -35,14 +35,14 @@ &reftitle.returnvalues; - + The result of adding all given values to the deque, effectively the same as adding the values to a copy, then returning that copy. - + - + The current instance won't be affected. - + diff --git a/reference/ds/ds/deque/pop.xml b/reference/ds/ds/deque/pop.xml index 44960b60d..92b2e5ab9 100644 --- a/reference/ds/ds/deque/pop.xml +++ b/reference/ds/ds/deque/pop.xml @@ -13,9 +13,9 @@ public mixedDs\Deque::pop - + Removes and returns the last value. - + @@ -26,16 +26,16 @@ &reftitle.returnvalues; - + The removed last value. - + &reftitle.errors; - - UnderflowException if empty. - + + UnderflowException if empty. + diff --git a/reference/ds/ds/deque/push.xml b/reference/ds/ds/deque/push.xml index f42c6bccb..404ee3892 100644 --- a/reference/ds/ds/deque/push.xml +++ b/reference/ds/ds/deque/push.xml @@ -13,9 +13,9 @@ public voidDs\Deque::push mixedvalues - + Adds values to the end of the deque. - + @@ -25,9 +25,9 @@ values - + The values to add. - + @@ -35,9 +35,9 @@ &reftitle.returnvalues; - + &return.void; - + diff --git a/reference/ds/ds/deque/reduce.xml b/reference/ds/ds/deque/reduce.xml index 745bcf683..5cc66343e 100644 --- a/reference/ds/ds/deque/reduce.xml +++ b/reference/ds/ds/deque/reduce.xml @@ -14,9 +14,9 @@ callablecallback mixedinitial - + Reduces the deque to a single value using a callback function. - + @@ -36,18 +36,18 @@ carry - + The return value of the previous callback, or initial if it's the first iteration. - + value - + The value of the current iteration. - + @@ -57,9 +57,9 @@ initial - + The initial value of the carry value. Can be &null;. - + @@ -67,9 +67,9 @@ &reftitle.returnvalues; - + The return value of the final callback. - + diff --git a/reference/ds/ds/deque/remove.xml b/reference/ds/ds/deque/remove.xml index 100470a89..57f89d423 100644 --- a/reference/ds/ds/deque/remove.xml +++ b/reference/ds/ds/deque/remove.xml @@ -13,9 +13,9 @@ public mixedDs\Deque::remove intindex - + Removes and returns a value by index. - + @@ -25,9 +25,9 @@ index - + The index of the value to remove. - + @@ -35,16 +35,16 @@ &reftitle.returnvalues; - + The value that was removed. - + &reftitle.errors; - - OutOfRangeException if the index is not valid. - + + OutOfRangeException if the index is not valid. + diff --git a/reference/ds/ds/deque/reverse.xml b/reference/ds/ds/deque/reverse.xml index c530d5176..dfd9767fe 100644 --- a/reference/ds/ds/deque/reverse.xml +++ b/reference/ds/ds/deque/reverse.xml @@ -15,9 +15,9 @@ public voidDs\Deque::reverse - + Reverses the deque in-place. - + @@ -28,9 +28,9 @@ &reftitle.returnvalues; - + &return.void; - + diff --git a/reference/ds/ds/deque/reversed.xml b/reference/ds/ds/deque/reversed.xml index f08000242..a12f23878 100644 --- a/reference/ds/ds/deque/reversed.xml +++ b/reference/ds/ds/deque/reversed.xml @@ -13,9 +13,9 @@ public Ds\DequeDs\Deque::reversed - + Returns a reversed copy of the deque. - + @@ -30,9 +30,9 @@ A reversed copy of the deque. - + The current instance is not affected. - + diff --git a/reference/ds/ds/deque/rotate.xml b/reference/ds/ds/deque/rotate.xml index dce00cbce..c9f743cde 100644 --- a/reference/ds/ds/deque/rotate.xml +++ b/reference/ds/ds/deque/rotate.xml @@ -13,11 +13,11 @@ public voidDs\Deque::rotate introtations - + Rotates the deque by a given number of rotations, which is equivalent to successively calling $deque->push($deque->shift()) if the number of rotations is positive, or $deque->unshift($deque->pop()) if negative. - + @@ -27,9 +27,9 @@ rotations - + The number of times the deque should be rotated. - + @@ -37,9 +37,9 @@ &reftitle.returnvalues; - + &return.void;. The deque of the current instance will be rotated. - + diff --git a/reference/ds/ds/deque/set.xml b/reference/ds/ds/deque/set.xml index 1555e6951..6ed5288c0 100644 --- a/reference/ds/ds/deque/set.xml +++ b/reference/ds/ds/deque/set.xml @@ -14,9 +14,9 @@ intindex mixedvalue - + Updates a value at a given index. - + @@ -26,17 +26,17 @@ index - + The index of the value to update. - + value - + The new value. - + @@ -44,16 +44,16 @@ &reftitle.returnvalues; - + &return.void; - + &reftitle.errors; - - OutOfRangeException if the index is not valid. - + + OutOfRangeException if the index is not valid. + diff --git a/reference/ds/ds/deque/shift.xml b/reference/ds/ds/deque/shift.xml index ad76fb929..70a09b103 100644 --- a/reference/ds/ds/deque/shift.xml +++ b/reference/ds/ds/deque/shift.xml @@ -13,9 +13,9 @@ public mixedDs\Deque::shift - + Removes and returns the first value. - + @@ -26,16 +26,16 @@ &reftitle.returnvalues; - + The first value, which was removed. - + &reftitle.errors; - - UnderflowException if empty. - + + UnderflowException if empty. + diff --git a/reference/ds/ds/deque/slice.xml b/reference/ds/ds/deque/slice.xml index f8191128f..2deed41f4 100644 --- a/reference/ds/ds/deque/slice.xml +++ b/reference/ds/ds/deque/slice.xml @@ -16,9 +16,9 @@ intindex intlength - + Creates a sub-deque of a given range. - + @@ -28,19 +28,19 @@ index - + The index at which the sub-deque starts. - - + + If positive, the deque will start at that index in the deque. If negative, the deque will start that far from the end. - + length - + If a length is given and is positive, the resulting deque will have up to that many values in it. @@ -53,7 +53,7 @@ If a length is not provided, the resulting deque will contain all values between the index and the end of the deque. - + @@ -61,9 +61,9 @@ &reftitle.returnvalues; - + A sub-deque of the given range. - + diff --git a/reference/ds/ds/deque/sort.xml b/reference/ds/ds/deque/sort.xml index b50d2c2fd..d8108f3fe 100644 --- a/reference/ds/ds/deque/sort.xml +++ b/reference/ds/ds/deque/sort.xml @@ -15,9 +15,9 @@ public voidDs\Deque::sort callablecomparator - + Sorts the deque in-place, using an optional comparator function. - + @@ -35,9 +35,9 @@ &reftitle.returnvalues; - + &return.void; - + diff --git a/reference/ds/ds/deque/sorted.xml b/reference/ds/ds/deque/sorted.xml index 93241d67b..b32284caf 100644 --- a/reference/ds/ds/deque/sorted.xml +++ b/reference/ds/ds/deque/sorted.xml @@ -13,9 +13,9 @@ public Ds\DequeDs\Deque::sorted callablecomparator - + Returns a sorted copy, using an optional comparator function. - + @@ -33,9 +33,9 @@ &reftitle.returnvalues; - + Returns a sorted copy of the deque. - + diff --git a/reference/ds/ds/deque/sum.xml b/reference/ds/ds/deque/sum.xml index 5ae0a7135..8136ef734 100644 --- a/reference/ds/ds/deque/sum.xml +++ b/reference/ds/ds/deque/sum.xml @@ -13,13 +13,13 @@ public intfloatDs\Deque::sum - + Returns the sum of all values in the deque. - + - + Arrays and objects are considered equal to zero when calculating the sum. - + @@ -31,10 +31,10 @@ &reftitle.returnvalues; - + The sum of all the values in the deque as either a float or int depending on the values in the deque. - + diff --git a/reference/ds/ds/deque/toarray.xml b/reference/ds/ds/deque/toarray.xml index 6fba07034..c0dc499c3 100644 --- a/reference/ds/ds/deque/toarray.xml +++ b/reference/ds/ds/deque/toarray.xml @@ -15,13 +15,13 @@ public arrayDs\Deque::toArray - + Converts the deque to an &array;. - + - + Casting to an &array; is not supported yet. - + @@ -33,9 +33,9 @@ &reftitle.returnvalues; - + An &array; containing all the values in the same order as the deque. - + diff --git a/reference/ds/ds/deque/unshift.xml b/reference/ds/ds/deque/unshift.xml index 7618263ce..8baef3c46 100644 --- a/reference/ds/ds/deque/unshift.xml +++ b/reference/ds/ds/deque/unshift.xml @@ -13,10 +13,10 @@ public voidDs\Deque::unshift mixedvalues - + Adds values to the front of the deque, moving all the current values forward to make room for the new values. - + @@ -29,10 +29,10 @@ The values to add to the front of the deque. - + Multiple values will be added in the same order that they are passed. - + @@ -42,9 +42,9 @@ &reftitle.returnvalues; - + &return.void; - + diff --git a/reference/ds/ds/hashable/equals.xml b/reference/ds/ds/hashable/equals.xml index e2c56f217..4b1817e6b 100644 --- a/reference/ds/ds/hashable/equals.xml +++ b/reference/ds/ds/hashable/equals.xml @@ -13,27 +13,27 @@ abstract public boolDs\Hashable::equals objectobj - + Determines whether another object is equal to the current instance. - + - + This method allows objects to be used as keys in structures such as Ds\Map and Ds\Set, or any other lookup structure that honors this interface. - + - + It's guaranteed that obj is an instance of the same class. - + - + It's important that objects which are equal also have the same hash value. See Ds\Hashable::hash. - + @@ -44,10 +44,10 @@ obj - + The object to compare the current instance to, which is always an instance of the same class. - + @@ -55,9 +55,9 @@ &reftitle.returnvalues; - + &true; if equal, &false; otherwise. - + diff --git a/reference/ds/ds/hashable/hash.xml b/reference/ds/ds/hashable/hash.xml index 386c85e05..ce3942e22 100644 --- a/reference/ds/ds/hashable/hash.xml +++ b/reference/ds/ds/hashable/hash.xml @@ -13,35 +13,35 @@ abstract public mixedDs\Hashable::hash - + Returns a scalar value to be used as the hash value of the objects. - - + + While the hash value does not define equality, all objects that are equal according to Ds\Hashable::equals must have the same hash value. Hash values of equal objects don't have to be unique, for example you could just return &true; for all objects and nothing would break - the only implication would be that hash tables then turn into linked lists because all your objects will be hashed to the same bucket. It's therefore very important that you pick a good hash value, such as an ID or email address. - + - + This method allows objects to be used as keys in structures such as Ds\Map and Ds\Set, or any other lookup structure that honors this interface. - + - + Do not pick a value that might change within the object, such as a public property. Hash table lookups would fail because the hash has changed. - + - + All objects that are equal must have the same hash value. - + @@ -53,9 +53,9 @@ &reftitle.returnvalues; - + A scalar value to be used as this object's hash value. - + diff --git a/reference/ds/ds/map/allocate.xml b/reference/ds/ds/map/allocate.xml index ad645579f..55a65e1af 100644 --- a/reference/ds/ds/map/allocate.xml +++ b/reference/ds/ds/map/allocate.xml @@ -13,9 +13,9 @@ public voidDs\Map::allocate intcapacity - + Allocates enough memory for a required capacity. - + @@ -25,19 +25,19 @@ capacity - + The number of values for which capacity should be allocated. - + - + Capacity will stay the same if this value is less than or equal to the current capacity. - + - + Capacity will always be rounded up to the nearest power of 2. - + @@ -46,9 +46,9 @@ &reftitle.returnvalues; - + &return.void; - + diff --git a/reference/ds/ds/map/apply.xml b/reference/ds/ds/map/apply.xml index 03dbb4ca9..bfb485815 100644 --- a/reference/ds/ds/map/apply.xml +++ b/reference/ds/ds/map/apply.xml @@ -13,10 +13,10 @@ public voidDs\Map::apply callablecallback - + Updates all values by applying a callback function to each value in the map. - + @@ -34,13 +34,13 @@ mixedvalue - + A callable to apply to each value in the map. - + - + The callback should return what the value should be replaced by. - + @@ -49,9 +49,9 @@ &reftitle.returnvalues; - + &return.void; - + diff --git a/reference/ds/ds/map/capacity.xml b/reference/ds/ds/map/capacity.xml index 4f65668a1..057a9c0aa 100644 --- a/reference/ds/ds/map/capacity.xml +++ b/reference/ds/ds/map/capacity.xml @@ -13,9 +13,9 @@ public intDs\Map::capacity - + Returns the current capacity. - + @@ -25,9 +25,9 @@ &reftitle.returnvalues; - + The current capacity. - + diff --git a/reference/ds/ds/map/clear.xml b/reference/ds/ds/map/clear.xml index 0e2cb991f..5a2d3776e 100644 --- a/reference/ds/ds/map/clear.xml +++ b/reference/ds/ds/map/clear.xml @@ -13,9 +13,9 @@ public voidDs\Map::clear - + Removes all values from the map. - + @@ -25,9 +25,9 @@ &reftitle.returnvalues; - + &return.void; - + diff --git a/reference/ds/ds/map/construct.xml b/reference/ds/ds/map/construct.xml index ecd58f298..7ae180c62 100644 --- a/reference/ds/ds/map/construct.xml +++ b/reference/ds/ds/map/construct.xml @@ -13,10 +13,10 @@ public Ds\Map::__construct mixedvalues - + Creates a new instance, using either a traversable object or an &array; for the initial values. - + @@ -26,9 +26,9 @@ values - + A traversable object or an &array; to use for the initial values. - + diff --git a/reference/ds/ds/map/copy.xml b/reference/ds/ds/map/copy.xml index 2fbc8c4b3..6858632a0 100644 --- a/reference/ds/ds/map/copy.xml +++ b/reference/ds/ds/map/copy.xml @@ -13,9 +13,9 @@ public Ds\MapDs\Map::copy - + Returns a shallow copy of the map. - + @@ -25,9 +25,9 @@ &reftitle.returnvalues; - + Returns a shallow copy of the map. - + diff --git a/reference/ds/ds/map/count.xml b/reference/ds/ds/map/count.xml index b04276e12..0d4d8404f 100644 --- a/reference/ds/ds/map/count.xml +++ b/reference/ds/ds/map/count.xml @@ -9,9 +9,9 @@ &reftitle.description; - + See Countable::count - + diff --git a/reference/ds/ds/map/diff.xml b/reference/ds/ds/map/diff.xml index 92c11bdbf..c82826050 100644 --- a/reference/ds/ds/map/diff.xml +++ b/reference/ds/ds/map/diff.xml @@ -13,13 +13,13 @@ public Ds\MapDs\Map::diff Ds\Mapmap - + Returns the result of removing all keys from the current instance that are present in a given map. - - + + A \ B = {x ∈ A | x ∉ B} - + @@ -28,9 +28,9 @@ map - + The map containing the keys to exclude in the resulting map. - + @@ -38,10 +38,10 @@ &reftitle.returnvalues; - + The result of removing all keys from the current instance that are present in a given map. - + diff --git a/reference/ds/ds/map/filter.xml b/reference/ds/ds/map/filter.xml index d6375657b..7a70048da 100644 --- a/reference/ds/ds/map/filter.xml +++ b/reference/ds/ds/map/filter.xml @@ -15,9 +15,9 @@ public Ds\MapDs\Map::filter callablecallback - + Creates a new map using a callable to determine which pairs to include. - + @@ -35,14 +35,14 @@ mixedvalue - + Optional callable which returns &true; if the pair should be included, &false; otherwise. - - + + If a callback is not provided, only values which are &true; (see converting to boolean) will be included. - + @@ -50,11 +50,11 @@ &reftitle.returnvalues; - + A new map containing all the pairs for which either the callback returned &true;, or all values that convert to &true; if a callback was not provided. - + diff --git a/reference/ds/ds/map/first.xml b/reference/ds/ds/map/first.xml index 4434e5348..f7d6c691c 100644 --- a/reference/ds/ds/map/first.xml +++ b/reference/ds/ds/map/first.xml @@ -13,9 +13,9 @@ public Ds\PairDs\Map::first - + Returns the first pair in the map. - + @@ -26,16 +26,16 @@ &reftitle.returnvalues; - + The first pair in the map. - + &reftitle.errors; - - UnderflowException if empty. - + + UnderflowException if empty. + diff --git a/reference/ds/ds/map/get.xml b/reference/ds/ds/map/get.xml index 8aae6aa0b..4524a38c7 100644 --- a/reference/ds/ds/map/get.xml +++ b/reference/ds/ds/map/get.xml @@ -14,13 +14,13 @@ mixedkey mixeddefault - + Returns the value for a given key, or an optional default value if the key could not be found. - + - + Keys of type object are supported. If an object implements Ds\Hashable, @@ -28,25 +28,25 @@ If an object does not implement Ds\Hashable, objects must be references to the same instance to be considered equal. - + - + You can also use array syntax to access values by key, eg. $map["key"]. - + - + Be careful when using array syntax. Scalar keys will be coerced to integers by the engine. For example, $map["1"] will attempt to access int(1), while $map->get("1") will correctly look up the string key. - - + + See Arrays. - + @@ -57,17 +57,17 @@ key - + The key to look up. - + default - + The optional default value, returned if the key could not be found. - + @@ -75,18 +75,18 @@ &reftitle.returnvalues; - + The value mapped to the given key, or the default value if provided and the key could not be found in the map. - + &reftitle.errors; - - OutOfBoundsException if the key could not be found + + OutOfBoundsException if the key could not be found and a default value was not provided. - + diff --git a/reference/ds/ds/map/haskey.xml b/reference/ds/ds/map/haskey.xml index 30982c250..0684c4a3c 100644 --- a/reference/ds/ds/map/haskey.xml +++ b/reference/ds/ds/map/haskey.xml @@ -13,9 +13,9 @@ public boolDs\Map::hasKey mixedkey - + Determines whether the map contains a given key. - + @@ -25,9 +25,9 @@ key - + The key to look for. - + diff --git a/reference/ds/ds/map/hasvalue.xml b/reference/ds/ds/map/hasvalue.xml index 9c8e301c1..47e4188dd 100644 --- a/reference/ds/ds/map/hasvalue.xml +++ b/reference/ds/ds/map/hasvalue.xml @@ -13,9 +13,9 @@ public boolDs\Map::hasValue mixedvalue - + Determines whether the map contains a given value. - + @@ -25,9 +25,9 @@ value - + The value to look for. - + diff --git a/reference/ds/ds/map/intersect.xml b/reference/ds/ds/map/intersect.xml index 96170889c..ec6a98743 100644 --- a/reference/ds/ds/map/intersect.xml +++ b/reference/ds/ds/map/intersect.xml @@ -13,21 +13,21 @@ public Ds\MapDs\Map::intersect Ds\Mapmap - + Creates a new map containing the pairs of the current instance whose keys are also present in the given map. In other words, returns a copy of the current instance with all keys removed that are not also in the other map. - - + + A ∩ B = {x : x ∈ A ∧ x ∈ B} - + - + Values from the current instance will be kept. - + @@ -37,9 +37,9 @@ map - + The other map, containing the keys to intersect with. - + @@ -47,9 +47,9 @@ &reftitle.returnvalues; - + The key intersection of the current instance and another map. - + diff --git a/reference/ds/ds/map/isempty.xml b/reference/ds/ds/map/isempty.xml index 71b3bf055..49ef39897 100644 --- a/reference/ds/ds/map/isempty.xml +++ b/reference/ds/ds/map/isempty.xml @@ -13,9 +13,9 @@ public boolDs\Map::isEmpty - + Returns whether the map is empty. - + @@ -25,9 +25,9 @@ &reftitle.returnvalues; - + Returns &true; if the map is empty, &false; otherwise. - + diff --git a/reference/ds/ds/map/jsonserialize.xml b/reference/ds/ds/map/jsonserialize.xml index 0da6deb87..7230947e7 100644 --- a/reference/ds/ds/map/jsonserialize.xml +++ b/reference/ds/ds/map/jsonserialize.xml @@ -9,13 +9,13 @@ &reftitle.description; - + See JsonSerializable::jsonSerialize - + - + You should never need to call this directly. - + diff --git a/reference/ds/ds/map/keys.xml b/reference/ds/ds/map/keys.xml index 9878196d7..1c65b0c8b 100644 --- a/reference/ds/ds/map/keys.xml +++ b/reference/ds/ds/map/keys.xml @@ -13,9 +13,9 @@ public Ds\SetDs\Map::keys - + Returns a set containing all the keys of the map, in the same order. - + @@ -26,9 +26,9 @@ &reftitle.returnvalues; - + A Ds\Set containing all the keys of the map. - + diff --git a/reference/ds/ds/map/last.xml b/reference/ds/ds/map/last.xml index 2b53f5bc7..13a4166d9 100644 --- a/reference/ds/ds/map/last.xml +++ b/reference/ds/ds/map/last.xml @@ -13,9 +13,9 @@ public Ds\PairDs\Map::last - + Returns the last pair of the map. - + @@ -26,16 +26,16 @@ &reftitle.returnvalues; - + The last pair of the map. - + &reftitle.errors; - - UnderflowException if empty. - + + UnderflowException if empty. + diff --git a/reference/ds/ds/map/map.xml b/reference/ds/ds/map/map.xml index 91c02ff65..d2f2c5e15 100644 --- a/reference/ds/ds/map/map.xml +++ b/reference/ds/ds/map/map.xml @@ -13,10 +13,10 @@ public Ds\MapDs\Map::map callablecallback - + Returns the result of applying a callback function to each value of the map. - + @@ -33,14 +33,14 @@ mixedvalue - + A callable to apply to each value in the map. - + - + The callable should return what the key will be mapped to in the resulting map. - + @@ -49,14 +49,14 @@ &reftitle.returnvalues; - + The result of applying a callback to each value in the map. - + - + The keys and values of the current instance won't be affected. - + diff --git a/reference/ds/ds/map/merge.xml b/reference/ds/ds/map/merge.xml index a21cc75bf..734eeb0d2 100644 --- a/reference/ds/ds/map/merge.xml +++ b/reference/ds/ds/map/merge.xml @@ -13,15 +13,15 @@ public Ds\MapDs\Map::merge mixedvalues - + Returns the result of associating all keys of a given traversable object or &array; with their corresponding values, combined with the current instance. - + - + Values of the current instance will be overwritten by those provided where keys are equal. - + @@ -32,9 +32,9 @@ values - + A traversable object or an &array;. - + @@ -42,14 +42,14 @@ &reftitle.returnvalues; - + The result of associating all keys of a given traversable object or &array; with their corresponding values, combined with the current instance. - + - + The current instance won't be affected. - + diff --git a/reference/ds/ds/map/pairs.xml b/reference/ds/ds/map/pairs.xml index c34a0749a..f63595ba5 100644 --- a/reference/ds/ds/map/pairs.xml +++ b/reference/ds/ds/map/pairs.xml @@ -13,9 +13,9 @@ public Ds\SequenceDs\Map::pairs - + Returns a Ds\Sequence containing all the pairs of the map. - + @@ -26,9 +26,9 @@ &reftitle.returnvalues; - + Ds\Sequence containing all the pairs of the map. - + diff --git a/reference/ds/ds/map/put.xml b/reference/ds/ds/map/put.xml index 387290889..4d57949cc 100644 --- a/reference/ds/ds/map/put.xml +++ b/reference/ds/ds/map/put.xml @@ -14,13 +14,13 @@ mixedkey mixedvalue - + Associates a key with a value, overwriting a previous association if one exists. - + - + Keys of type object are supported. If an object implements Ds\Hashable, @@ -28,25 +28,25 @@ If an object does not implement Ds\Hashable, objects must be references to the same instance to be considered equal. - + - + You can also use array syntax to associate values by key, eg. $map["key"] = $value. - + - + Be careful when using array syntax. Scalar keys will be coerced to integers by the engine. For example, $map["1"] will attempt to access int(1), while $map->get("1") will correctly look up the string key. - - + + See Arrays. - + @@ -57,17 +57,17 @@ key - + The key to associate the value with. - + value - + The value to be associated with the key. - + @@ -75,9 +75,9 @@ &reftitle.returnvalues; - + &return.void; - + diff --git a/reference/ds/ds/map/putAll.xml b/reference/ds/ds/map/putAll.xml index 1f4a613db..eeff01dac 100644 --- a/reference/ds/ds/map/putAll.xml +++ b/reference/ds/ds/map/putAll.xml @@ -13,12 +13,12 @@ public voidDs\Map::putAll mixedpairs - + Associates all key-value pairs of a traversable object or &array;. - + - + Keys of type object are supported. If an object implements Ds\Hashable, @@ -26,7 +26,7 @@ If an object does not implement Ds\Hashable, objects must be references to the same instance to be considered equal. - + @@ -37,9 +37,9 @@ pairs - + traversable object or &array;. - + @@ -47,9 +47,9 @@ &reftitle.returnvalues; - + &return.void; - + diff --git a/reference/ds/ds/map/reduce.xml b/reference/ds/ds/map/reduce.xml index a8f4d466b..e36bcb1ee 100644 --- a/reference/ds/ds/map/reduce.xml +++ b/reference/ds/ds/map/reduce.xml @@ -14,9 +14,9 @@ callablecallback mixedinitial - + Reduces the map to a single value using a callback function. - + @@ -37,26 +37,26 @@ carry - + The return value of the previous callback, or initial if it's the first iteration. - + key - + The key of the current iteration. - + value - + The value of the current iteration. - + @@ -66,9 +66,9 @@ initial - + The initial value of the carry value. Can be &null;. - + @@ -76,9 +76,9 @@ &reftitle.returnvalues; - + The return value of the final callback. - + diff --git a/reference/ds/ds/map/remove.xml b/reference/ds/ds/map/remove.xml index 10665a787..d672ca893 100644 --- a/reference/ds/ds/map/remove.xml +++ b/reference/ds/ds/map/remove.xml @@ -14,13 +14,13 @@ mixedkey mixeddefault - + Removes and returns a value by key, or return an optional default value if the key could not be found. - + - + Keys of type object are supported. If an object implements Ds\Hashable, @@ -28,25 +28,25 @@ If an object does not implement Ds\Hashable, objects must be references to the same instance to be considered equal. - + - + You can also use array syntax to access values by key, eg. $map["key"]. - + - + Be careful when using array syntax. Scalar keys will be coerced to integers by the engine. For example, $map["1"] will attempt to access int(1), while $map->get("1") will correctly look up the string key. - - + + See Arrays. - + @@ -57,17 +57,17 @@ key - + The key to remove. - + default - + The optional default value, returned if the key could not be found. - + @@ -75,18 +75,18 @@ &reftitle.returnvalues; - + The value that was removed, or the default value if provided and the key could not be found in the map. - + &reftitle.errors; - - OutOfBoundsException if the key could not be found + + OutOfBoundsException if the key could not be found and a default value was not provided. - + diff --git a/reference/ds/ds/map/reverse.xml b/reference/ds/ds/map/reverse.xml index ca144d868..8410f07af 100644 --- a/reference/ds/ds/map/reverse.xml +++ b/reference/ds/ds/map/reverse.xml @@ -15,9 +15,9 @@ public voidDs\Map::reverse - + Reverses the map in-place. - + @@ -28,9 +28,9 @@ &reftitle.returnvalues; - + &return.void; - + diff --git a/reference/ds/ds/map/reversed.xml b/reference/ds/ds/map/reversed.xml index 097c3e8d3..98b59c75d 100644 --- a/reference/ds/ds/map/reversed.xml +++ b/reference/ds/ds/map/reversed.xml @@ -13,9 +13,9 @@ public Ds\MapDs\Map::reversed - + Returns a reversed copy of the map. - + @@ -30,9 +30,9 @@ A reversed copy of the map. - + The current instance is not affected. - + diff --git a/reference/ds/ds/map/skip.xml b/reference/ds/ds/map/skip.xml index 1cddb5db5..2871e6ee1 100644 --- a/reference/ds/ds/map/skip.xml +++ b/reference/ds/ds/map/skip.xml @@ -13,9 +13,9 @@ public Ds\PairDs\Map::skip intposition - + Returns the pair at a given zero-based position. - + @@ -25,9 +25,9 @@ position - + The zero-based positional index to return. - + @@ -35,16 +35,16 @@ &reftitle.returnvalues; - + Returns the Ds\Pair at the given position. - + &reftitle.errors; - - OutOfRangeException if the position is not valid. - + + OutOfRangeException if the position is not valid. + diff --git a/reference/ds/ds/map/slice.xml b/reference/ds/ds/map/slice.xml index 901059a9e..bd0dfbddb 100644 --- a/reference/ds/ds/map/slice.xml +++ b/reference/ds/ds/map/slice.xml @@ -16,9 +16,9 @@ intindex intlength - + Returns a subset of the map defined by a starting index and length. - + @@ -28,19 +28,19 @@ index - + The index at which the range starts. - - + + If positive, the range will start at that index in the map. If negative, the range will start that far from the end. - + length - + If a length is given and is positive, the resulting map will have up to that many pairs in it. @@ -53,7 +53,7 @@ If a length is not provided, the resulting map will contain all pairs between the index and the end of the map. - + @@ -61,9 +61,9 @@ &reftitle.returnvalues; - + A subset of the map defined by a starting index and length. - + diff --git a/reference/ds/ds/map/sort.xml b/reference/ds/ds/map/sort.xml index 723f6274d..f586b65c4 100644 --- a/reference/ds/ds/map/sort.xml +++ b/reference/ds/ds/map/sort.xml @@ -15,9 +15,9 @@ public voidDs\Map::sort callablecomparator - + Sorts the map in-place by value, using an optional comparator function. - + @@ -35,9 +35,9 @@ &reftitle.returnvalues; - + &return.void; - + diff --git a/reference/ds/ds/map/sorted.xml b/reference/ds/ds/map/sorted.xml index f02d6cede..5910cfe52 100644 --- a/reference/ds/ds/map/sorted.xml +++ b/reference/ds/ds/map/sorted.xml @@ -13,9 +13,9 @@ public Ds\MapDs\Map::sorted callablecomparator - + Returns a copy, sorted by value using an optional comparator function. - + @@ -33,9 +33,9 @@ &reftitle.returnvalues; - + Returns a copy of the map, sorted by value. - + diff --git a/reference/ds/ds/map/sum.xml b/reference/ds/ds/map/sum.xml index 9bf04d890..2b12363d0 100644 --- a/reference/ds/ds/map/sum.xml +++ b/reference/ds/ds/map/sum.xml @@ -13,13 +13,13 @@ public intfloatDs\Map::sum - + Returns the sum of all values in the map. - + - + Arrays and objects are considered equal to zero when calculating the sum. - + @@ -31,10 +31,10 @@ &reftitle.returnvalues; - + The sum of all the values in the map as either a float or int depending on the values in the map. - + diff --git a/reference/ds/ds/map/toarray.xml b/reference/ds/ds/map/toarray.xml index 4b30278d6..afc616ce9 100644 --- a/reference/ds/ds/map/toarray.xml +++ b/reference/ds/ds/map/toarray.xml @@ -15,25 +15,25 @@ public arrayDs\Map::toArray - + Converts the map to an &array;. - + Maps with non-scalar keys can't be converted to an &array;. - + An &array; will treat all numeric keys as integers, eg. "1" and 1 as keys in the map will only result in 1 being included in the array. - + - + Casting to an &array; is not supported yet. - + @@ -45,9 +45,9 @@ &reftitle.returnvalues; - + An &array; containing all the values in the same order as the map. - + diff --git a/reference/ds/ds/map/union.xml b/reference/ds/ds/map/union.xml index f5064677a..572b5f079 100644 --- a/reference/ds/ds/map/union.xml +++ b/reference/ds/ds/map/union.xml @@ -13,18 +13,18 @@ public Ds\MapDs\Map::union Ds\Mapmap - + Creates a new map that contains the pairs of the current instance as well as the pairs of another map. - - + + A ∪ B = {x: x ∈ A ∨ x ∈ B} - + - + Values of the current instance will be overwritten by those provided where keys are equal. - + @@ -35,9 +35,9 @@ map - + The other map, to combine with the current instance. - + @@ -45,9 +45,9 @@ &reftitle.returnvalues; - + A new map containing all the pairs of the current instance as well as another map. - + diff --git a/reference/ds/ds/map/values.xml b/reference/ds/ds/map/values.xml index bf14f0206..ddbf3bfc1 100644 --- a/reference/ds/ds/map/values.xml +++ b/reference/ds/ds/map/values.xml @@ -13,9 +13,9 @@ public Ds\SequenceDs\Map::values - + Returns a sequence containing all the values of the map, in the same order. - + @@ -26,9 +26,9 @@ &reftitle.returnvalues; - + A Ds\Sequence containing all the values of the map. - + diff --git a/reference/ds/ds/map/xor.xml b/reference/ds/ds/map/xor.xml index 53c60982c..a80ffb257 100644 --- a/reference/ds/ds/map/xor.xml +++ b/reference/ds/ds/map/xor.xml @@ -13,13 +13,13 @@ public Ds\MapDs\Map::xor Ds\Mapmap - + Creates a new map containing keys of the current instance as well as another map, but not of both. - - + + A ⊖ B = {x : x ∈ (A \ B) ∪ (B \ A)} - + @@ -28,9 +28,9 @@ map - + The other map. - + @@ -38,10 +38,10 @@ &reftitle.returnvalues; - + A new map containing keys in the current instance as well as another map, but not in both. - + diff --git a/reference/ds/ds/pair/clear.xml b/reference/ds/ds/pair/clear.xml index 37651d88c..2f5442570 100644 --- a/reference/ds/ds/pair/clear.xml +++ b/reference/ds/ds/pair/clear.xml @@ -13,9 +13,9 @@ public voidDs\Pair::clear - + Removes all values from the pair. - + @@ -25,9 +25,9 @@ &reftitle.returnvalues; - + &return.void; - + diff --git a/reference/ds/ds/pair/construct.xml b/reference/ds/ds/pair/construct.xml index 723822a21..3da2ad215 100644 --- a/reference/ds/ds/pair/construct.xml +++ b/reference/ds/ds/pair/construct.xml @@ -14,9 +14,9 @@ mixedkey mixedvalue - + Creates a new instance using a given key and value. - + @@ -26,17 +26,17 @@ key - + The key. - + value - + The value. - + diff --git a/reference/ds/ds/pair/copy.xml b/reference/ds/ds/pair/copy.xml index f2b848107..640ea73fa 100644 --- a/reference/ds/ds/pair/copy.xml +++ b/reference/ds/ds/pair/copy.xml @@ -13,9 +13,9 @@ public Ds\PairDs\Pair::copy - + Returns a shallow copy of the pair. - + @@ -25,9 +25,9 @@ &reftitle.returnvalues; - + Returns a shallow copy of the pair. - + diff --git a/reference/ds/ds/pair/isempty.xml b/reference/ds/ds/pair/isempty.xml index 240f54c7b..fb8d8b2bd 100644 --- a/reference/ds/ds/pair/isempty.xml +++ b/reference/ds/ds/pair/isempty.xml @@ -13,9 +13,9 @@ public boolDs\Pair::isEmpty - + Returns whether the pair is empty. - + @@ -25,9 +25,9 @@ &reftitle.returnvalues; - + Returns &true; if the pair is empty, &false; otherwise. - + diff --git a/reference/ds/ds/pair/jsonserialize.xml b/reference/ds/ds/pair/jsonserialize.xml index 1f778e0d0..820d08846 100644 --- a/reference/ds/ds/pair/jsonserialize.xml +++ b/reference/ds/ds/pair/jsonserialize.xml @@ -9,13 +9,13 @@ &reftitle.description; - + See JsonSerializable::jsonSerialize - + - + You should never need to call this directly. - + diff --git a/reference/ds/ds/pair/toarray.xml b/reference/ds/ds/pair/toarray.xml index d7ef63839..19dcf6b70 100644 --- a/reference/ds/ds/pair/toarray.xml +++ b/reference/ds/ds/pair/toarray.xml @@ -15,13 +15,13 @@ public arrayDs\Pair::toArray - + Converts the pair to an &array;. - + - + Casting to an &array; is not supported yet. - + @@ -33,9 +33,9 @@ &reftitle.returnvalues; - + An &array; containing all the values in the same order as the pair. - + diff --git a/reference/ds/ds/priorityqueue/allocate.xml b/reference/ds/ds/priorityqueue/allocate.xml index 30e71e062..81666f9bc 100644 --- a/reference/ds/ds/priorityqueue/allocate.xml +++ b/reference/ds/ds/priorityqueue/allocate.xml @@ -25,19 +25,19 @@ capacity - + The number of values for which capacity should be allocated. - + - + Capacity will stay the same if this value is less than or equal to the current capacity. - + - + Capacity will always be rounded up to the nearest power of 2. - + @@ -46,9 +46,9 @@ &reftitle.returnvalues; - + &return.void; - + diff --git a/reference/ds/ds/priorityqueue/capacity.xml b/reference/ds/ds/priorityqueue/capacity.xml index 65e343f35..9ab8c6db4 100644 --- a/reference/ds/ds/priorityqueue/capacity.xml +++ b/reference/ds/ds/priorityqueue/capacity.xml @@ -13,9 +13,9 @@ public intDs\PriorityQueue::capacity - + Returns the current capacity. - + @@ -25,9 +25,9 @@ &reftitle.returnvalues; - + The current capacity. - + diff --git a/reference/ds/ds/priorityqueue/clear.xml b/reference/ds/ds/priorityqueue/clear.xml index 326a08f37..c5de61ec8 100644 --- a/reference/ds/ds/priorityqueue/clear.xml +++ b/reference/ds/ds/priorityqueue/clear.xml @@ -13,9 +13,9 @@ public voidDs\PriorityQueue::clear - + Removes all values from the queue. - + @@ -25,9 +25,9 @@ &reftitle.returnvalues; - + &return.void; - + diff --git a/reference/ds/ds/priorityqueue/construct.xml b/reference/ds/ds/priorityqueue/construct.xml index bdd9a49b6..5375d3cf2 100644 --- a/reference/ds/ds/priorityqueue/construct.xml +++ b/reference/ds/ds/priorityqueue/construct.xml @@ -13,9 +13,9 @@ public Ds\PriorityQueue::__construct - + Creates a new instance. - + -
+
&reftitle.install; diff --git a/reference/eio/examples.xml b/reference/eio/examples.xml index 8560167c2..be375f902 100644 --- a/reference/eio/examples.xml +++ b/reference/eio/examples.xml @@ -1,6 +1,6 @@ - + &reftitle.examples; Cancelling a request diff --git a/reference/eio/functions/eio-busy.xml b/reference/eio/functions/eio-busy.xml index e0af433ed..39fece27f 100644 --- a/reference/eio/functions/eio-busy.xml +++ b/reference/eio/functions/eio-busy.xml @@ -1,6 +1,6 @@ - + eio_busy Artificially increase load. Could be useful in tests, diff --git a/reference/eio/functions/eio-cancel.xml b/reference/eio/functions/eio-cancel.xml index 20a593731..9d31ad25a 100644 --- a/reference/eio/functions/eio-cancel.xml +++ b/reference/eio/functions/eio-cancel.xml @@ -1,6 +1,6 @@ - + eio_cancel Cancels a request diff --git a/reference/eio/functions/eio-chmod.xml b/reference/eio/functions/eio-chmod.xml index 7dc60befc..0775282c8 100644 --- a/reference/eio/functions/eio-chmod.xml +++ b/reference/eio/functions/eio-chmod.xml @@ -1,6 +1,6 @@ - + eio_chmod Change file/directory permissions diff --git a/reference/eio/functions/eio-chown.xml b/reference/eio/functions/eio-chown.xml index 324ee6c96..8dc8fa0b8 100644 --- a/reference/eio/functions/eio-chown.xml +++ b/reference/eio/functions/eio-chown.xml @@ -1,6 +1,6 @@ - + eio_chown Change file/directory ownership diff --git a/reference/eio/functions/eio-close.xml b/reference/eio/functions/eio-close.xml index e2487180e..b4685b553 100644 --- a/reference/eio/functions/eio-close.xml +++ b/reference/eio/functions/eio-close.xml @@ -1,6 +1,6 @@ - + eio_close Close file diff --git a/reference/eio/functions/eio-custom.xml b/reference/eio/functions/eio-custom.xml index 4c077a1ff..82d839b24 100644 --- a/reference/eio/functions/eio-custom.xml +++ b/reference/eio/functions/eio-custom.xml @@ -1,6 +1,6 @@ - + eio_custom Execute custom request like any other eio_* call diff --git a/reference/eio/functions/eio-dup2.xml b/reference/eio/functions/eio-dup2.xml index 3c7ede8f9..eab1cc931 100644 --- a/reference/eio/functions/eio-dup2.xml +++ b/reference/eio/functions/eio-dup2.xml @@ -1,6 +1,6 @@ - + eio_dup2 Duplicate a file descriptor diff --git a/reference/eio/functions/eio-event-loop.xml b/reference/eio/functions/eio-event-loop.xml index fd273c222..28c4bd1a5 100644 --- a/reference/eio/functions/eio-event-loop.xml +++ b/reference/eio/functions/eio-event-loop.xml @@ -1,6 +1,6 @@ - + eio_event_loop Polls libeio until all requests proceeded diff --git a/reference/eio/functions/eio-fallocate.xml b/reference/eio/functions/eio-fallocate.xml index eac031090..2ff11ff6c 100644 --- a/reference/eio/functions/eio-fallocate.xml +++ b/reference/eio/functions/eio-fallocate.xml @@ -1,6 +1,6 @@ - + eio_fallocate Allows the caller to directly manipulate the allocated disk diff --git a/reference/eio/functions/eio-fchmod.xml b/reference/eio/functions/eio-fchmod.xml index 245e81312..6bedcbf1a 100644 --- a/reference/eio/functions/eio-fchmod.xml +++ b/reference/eio/functions/eio-fchmod.xml @@ -1,6 +1,6 @@ - + eio_fchmod Change file permissions diff --git a/reference/eio/functions/eio-fchown.xml b/reference/eio/functions/eio-fchown.xml index 9b10af704..0a0f3da0a 100644 --- a/reference/eio/functions/eio-fchown.xml +++ b/reference/eio/functions/eio-fchown.xml @@ -1,6 +1,6 @@ - + eio_fchown Change file ownership diff --git a/reference/eio/functions/eio-fdatasync.xml b/reference/eio/functions/eio-fdatasync.xml index 750773a7c..c34153c32 100644 --- a/reference/eio/functions/eio-fdatasync.xml +++ b/reference/eio/functions/eio-fdatasync.xml @@ -1,6 +1,6 @@ - + eio_fdatasync Synchronize a file's in-core state with storage device diff --git a/reference/eio/functions/eio-fstat.xml b/reference/eio/functions/eio-fstat.xml index eeb7d9933..df60704ce 100644 --- a/reference/eio/functions/eio-fstat.xml +++ b/reference/eio/functions/eio-fstat.xml @@ -1,6 +1,6 @@ - + eio_fstat Get file status diff --git a/reference/eio/functions/eio-fstatvfs.xml b/reference/eio/functions/eio-fstatvfs.xml index 3ac7291cd..2bb208fc1 100644 --- a/reference/eio/functions/eio-fstatvfs.xml +++ b/reference/eio/functions/eio-fstatvfs.xml @@ -1,6 +1,6 @@ - + eio_fstatvfs Get file system statistics diff --git a/reference/eio/functions/eio-fsync.xml b/reference/eio/functions/eio-fsync.xml index 814b356f1..2ba371f4e 100644 --- a/reference/eio/functions/eio-fsync.xml +++ b/reference/eio/functions/eio-fsync.xml @@ -1,6 +1,6 @@ - + eio_fsync Synchronize a file's in-core state with storage device diff --git a/reference/eio/functions/eio-ftruncate.xml b/reference/eio/functions/eio-ftruncate.xml index d09569560..ece4eff1c 100644 --- a/reference/eio/functions/eio-ftruncate.xml +++ b/reference/eio/functions/eio-ftruncate.xml @@ -1,6 +1,6 @@ - + eio_ftruncate Truncate a file diff --git a/reference/eio/functions/eio-futime.xml b/reference/eio/functions/eio-futime.xml index ace349fa0..df089d754 100644 --- a/reference/eio/functions/eio-futime.xml +++ b/reference/eio/functions/eio-futime.xml @@ -1,6 +1,6 @@ - + eio_futime Change file last access and modification times diff --git a/reference/eio/functions/eio-get-event-stream.xml b/reference/eio/functions/eio-get-event-stream.xml index 6ad5aa773..755013076 100644 --- a/reference/eio/functions/eio-get-event-stream.xml +++ b/reference/eio/functions/eio-get-event-stream.xml @@ -1,6 +1,6 @@ - + eio_get_event_stream Get stream representing a variable used in internal communications with libeio diff --git a/reference/eio/functions/eio-get-last-error.xml b/reference/eio/functions/eio-get-last-error.xml index 2ee1de8b2..9934ede11 100644 --- a/reference/eio/functions/eio-get-last-error.xml +++ b/reference/eio/functions/eio-get-last-error.xml @@ -1,6 +1,6 @@ - + eio_get_last_error Returns string describing the last error associated with a request resource diff --git a/reference/eio/functions/eio-grp-add.xml b/reference/eio/functions/eio-grp-add.xml index e7453b58a..091f9e44d 100644 --- a/reference/eio/functions/eio-grp-add.xml +++ b/reference/eio/functions/eio-grp-add.xml @@ -1,6 +1,6 @@ - + eio_grp_add Adds a request to the request group diff --git a/reference/eio/functions/eio-grp-cancel.xml b/reference/eio/functions/eio-grp-cancel.xml index d1258a2e5..51135960d 100644 --- a/reference/eio/functions/eio-grp-cancel.xml +++ b/reference/eio/functions/eio-grp-cancel.xml @@ -1,6 +1,6 @@ - + eio_grp_cancel Cancels a request group diff --git a/reference/eio/functions/eio-grp-limit.xml b/reference/eio/functions/eio-grp-limit.xml index 5b8712aaf..b837bda2d 100644 --- a/reference/eio/functions/eio-grp-limit.xml +++ b/reference/eio/functions/eio-grp-limit.xml @@ -1,6 +1,6 @@ - + eio_grp_limit Set group limit diff --git a/reference/eio/functions/eio-grp.xml b/reference/eio/functions/eio-grp.xml index 943f28cad..9d3cae1bb 100644 --- a/reference/eio/functions/eio-grp.xml +++ b/reference/eio/functions/eio-grp.xml @@ -1,6 +1,6 @@ - + eio_grp Creates a request group diff --git a/reference/eio/functions/eio-init.xml b/reference/eio/functions/eio-init.xml index ad1398bb2..1aee46e83 100644 --- a/reference/eio/functions/eio-init.xml +++ b/reference/eio/functions/eio-init.xml @@ -1,6 +1,6 @@ - + eio_init (Re-)initialize Eio diff --git a/reference/eio/functions/eio-link.xml b/reference/eio/functions/eio-link.xml index cf46db78e..c9dc1a984 100644 --- a/reference/eio/functions/eio-link.xml +++ b/reference/eio/functions/eio-link.xml @@ -1,6 +1,6 @@ - + eio_link Create a hardlink for file diff --git a/reference/eio/functions/eio-lstat.xml b/reference/eio/functions/eio-lstat.xml index 85525cf16..a53f281d9 100644 --- a/reference/eio/functions/eio-lstat.xml +++ b/reference/eio/functions/eio-lstat.xml @@ -1,6 +1,6 @@ - + eio_lstat Get file status diff --git a/reference/eio/functions/eio-mkdir.xml b/reference/eio/functions/eio-mkdir.xml index 18eaeb33c..ce62b21cb 100644 --- a/reference/eio/functions/eio-mkdir.xml +++ b/reference/eio/functions/eio-mkdir.xml @@ -1,6 +1,6 @@ - + eio_mkdir Create directory diff --git a/reference/eio/functions/eio-mknod.xml b/reference/eio/functions/eio-mknod.xml index e9716ae92..fb4fe4738 100644 --- a/reference/eio/functions/eio-mknod.xml +++ b/reference/eio/functions/eio-mknod.xml @@ -1,6 +1,6 @@ - + eio_mknod Create a special or ordinary file diff --git a/reference/eio/functions/eio-nop.xml b/reference/eio/functions/eio-nop.xml index 1dc6499f6..0abdae023 100644 --- a/reference/eio/functions/eio-nop.xml +++ b/reference/eio/functions/eio-nop.xml @@ -1,6 +1,6 @@ - + eio_nop Does nothing, except go through the whole request cycle diff --git a/reference/eio/functions/eio-npending.xml b/reference/eio/functions/eio-npending.xml index 8494dbced..dacee30d6 100644 --- a/reference/eio/functions/eio-npending.xml +++ b/reference/eio/functions/eio-npending.xml @@ -1,6 +1,6 @@ - + eio_npending Returns number of finished, but unhandled requests diff --git a/reference/eio/functions/eio-nready.xml b/reference/eio/functions/eio-nready.xml index 7758d2830..8f41dd02b 100644 --- a/reference/eio/functions/eio-nready.xml +++ b/reference/eio/functions/eio-nready.xml @@ -1,6 +1,6 @@ - + eio_nready Returns number of not-yet handled requests diff --git a/reference/eio/functions/eio-nreqs.xml b/reference/eio/functions/eio-nreqs.xml index a3749848c..0740998ed 100644 --- a/reference/eio/functions/eio-nreqs.xml +++ b/reference/eio/functions/eio-nreqs.xml @@ -1,6 +1,6 @@ - + eio_nreqs Returns number of requests to be processed diff --git a/reference/eio/functions/eio-nthreads.xml b/reference/eio/functions/eio-nthreads.xml index 8d9af66b3..10b818cec 100644 --- a/reference/eio/functions/eio-nthreads.xml +++ b/reference/eio/functions/eio-nthreads.xml @@ -1,6 +1,6 @@ - + eio_nthreads Returns number of threads currently in use diff --git a/reference/eio/functions/eio-open.xml b/reference/eio/functions/eio-open.xml index 9c13904ee..481aa3036 100644 --- a/reference/eio/functions/eio-open.xml +++ b/reference/eio/functions/eio-open.xml @@ -1,6 +1,6 @@ - + eio_open Opens a file diff --git a/reference/eio/functions/eio-poll.xml b/reference/eio/functions/eio-poll.xml index abfd44abe..b922a989c 100644 --- a/reference/eio/functions/eio-poll.xml +++ b/reference/eio/functions/eio-poll.xml @@ -1,6 +1,6 @@ - + eio_poll Can be called whenever there are pending requests that need finishing diff --git a/reference/eio/functions/eio-read.xml b/reference/eio/functions/eio-read.xml index b183e18dd..a8988ac2a 100644 --- a/reference/eio/functions/eio-read.xml +++ b/reference/eio/functions/eio-read.xml @@ -1,6 +1,6 @@ - + eio_read Read from a file descriptor at given offset diff --git a/reference/eio/functions/eio-readahead.xml b/reference/eio/functions/eio-readahead.xml index 7bc10d0e8..ea5c3b9dd 100644 --- a/reference/eio/functions/eio-readahead.xml +++ b/reference/eio/functions/eio-readahead.xml @@ -1,6 +1,6 @@ - + eio_readahead Perform file readahead into page cache diff --git a/reference/eio/functions/eio-readlink.xml b/reference/eio/functions/eio-readlink.xml index b4b750ed8..5d2599608 100644 --- a/reference/eio/functions/eio-readlink.xml +++ b/reference/eio/functions/eio-readlink.xml @@ -1,6 +1,6 @@ - + eio_readlink Read value of a symbolic link diff --git a/reference/eio/functions/eio-realpath.xml b/reference/eio/functions/eio-realpath.xml index f886fdad6..082badb36 100644 --- a/reference/eio/functions/eio-realpath.xml +++ b/reference/eio/functions/eio-realpath.xml @@ -1,6 +1,6 @@ - + eio_realpath Get the canonicalized absolute pathname diff --git a/reference/eio/functions/eio-rename.xml b/reference/eio/functions/eio-rename.xml index ac997884b..63c8bd9ac 100644 --- a/reference/eio/functions/eio-rename.xml +++ b/reference/eio/functions/eio-rename.xml @@ -1,6 +1,6 @@ - + eio_rename Change the name or location of a file diff --git a/reference/eio/functions/eio-rmdir.xml b/reference/eio/functions/eio-rmdir.xml index 83c5e613e..69904406f 100644 --- a/reference/eio/functions/eio-rmdir.xml +++ b/reference/eio/functions/eio-rmdir.xml @@ -1,6 +1,6 @@ - + eio_rmdir Remove a directory diff --git a/reference/eio/functions/eio-seek.xml b/reference/eio/functions/eio-seek.xml index c1c670a57..735d9e082 100644 --- a/reference/eio/functions/eio-seek.xml +++ b/reference/eio/functions/eio-seek.xml @@ -1,6 +1,6 @@ - + eio_seek Seek to a position diff --git a/reference/eio/functions/eio-sendfile.xml b/reference/eio/functions/eio-sendfile.xml index 2679b1d7e..57bc6bcd0 100644 --- a/reference/eio/functions/eio-sendfile.xml +++ b/reference/eio/functions/eio-sendfile.xml @@ -1,6 +1,6 @@ - + eio_sendfile Transfer data between file descriptors diff --git a/reference/eio/functions/eio-set-max-idle.xml b/reference/eio/functions/eio-set-max-idle.xml index 8c99ed904..80cce39d4 100644 --- a/reference/eio/functions/eio-set-max-idle.xml +++ b/reference/eio/functions/eio-set-max-idle.xml @@ -1,6 +1,6 @@ - + eio_set_max_idle Set maximum number of idle threads diff --git a/reference/eio/functions/eio-set-max-parallel.xml b/reference/eio/functions/eio-set-max-parallel.xml index 45aae2e12..8b9f38f8a 100644 --- a/reference/eio/functions/eio-set-max-parallel.xml +++ b/reference/eio/functions/eio-set-max-parallel.xml @@ -1,6 +1,6 @@ - + eio_set_max_parallel Set maximum parallel threads diff --git a/reference/eio/functions/eio-set-max-poll-reqs.xml b/reference/eio/functions/eio-set-max-poll-reqs.xml index d6fa6bb3c..2f79d54f2 100644 --- a/reference/eio/functions/eio-set-max-poll-reqs.xml +++ b/reference/eio/functions/eio-set-max-poll-reqs.xml @@ -1,6 +1,6 @@ - + eio_set_max_poll_reqs Set maximum number of requests processed in a poll diff --git a/reference/eio/functions/eio-set-max-poll-time.xml b/reference/eio/functions/eio-set-max-poll-time.xml index f68dcfb80..e6912348b 100644 --- a/reference/eio/functions/eio-set-max-poll-time.xml +++ b/reference/eio/functions/eio-set-max-poll-time.xml @@ -1,6 +1,6 @@ - + eio_set_max_poll_time Set maximum poll time diff --git a/reference/eio/functions/eio-set-min-parallel.xml b/reference/eio/functions/eio-set-min-parallel.xml index 72a51ef95..ec028444c 100644 --- a/reference/eio/functions/eio-set-min-parallel.xml +++ b/reference/eio/functions/eio-set-min-parallel.xml @@ -1,6 +1,6 @@ - + eio_set_min_parallel Set minimum parallel thread number diff --git a/reference/eio/functions/eio-stat.xml b/reference/eio/functions/eio-stat.xml index abedfc5ef..30d5b702a 100644 --- a/reference/eio/functions/eio-stat.xml +++ b/reference/eio/functions/eio-stat.xml @@ -1,6 +1,6 @@ - + eio_stat Get file status diff --git a/reference/eio/functions/eio-statvfs.xml b/reference/eio/functions/eio-statvfs.xml index dfd0b43f8..e046a1bb4 100644 --- a/reference/eio/functions/eio-statvfs.xml +++ b/reference/eio/functions/eio-statvfs.xml @@ -1,6 +1,6 @@ - + eio_statvfs Get file system statistics diff --git a/reference/eio/functions/eio-symlink.xml b/reference/eio/functions/eio-symlink.xml index ba147b08e..f6a56f772 100644 --- a/reference/eio/functions/eio-symlink.xml +++ b/reference/eio/functions/eio-symlink.xml @@ -1,6 +1,6 @@ - + eio_symlink Create a symbolic link diff --git a/reference/eio/functions/eio-sync-file-range.xml b/reference/eio/functions/eio-sync-file-range.xml index a987a1579..034160f5b 100644 --- a/reference/eio/functions/eio-sync-file-range.xml +++ b/reference/eio/functions/eio-sync-file-range.xml @@ -1,6 +1,6 @@ - + eio_sync_file_range Sync a file segment with disk diff --git a/reference/eio/functions/eio-sync.xml b/reference/eio/functions/eio-sync.xml index 873ebf616..5de28bca6 100644 --- a/reference/eio/functions/eio-sync.xml +++ b/reference/eio/functions/eio-sync.xml @@ -1,6 +1,6 @@ - + eio_sync Commit buffer cache to disk diff --git a/reference/eio/functions/eio-syncfs.xml b/reference/eio/functions/eio-syncfs.xml index 82c76fe0b..5574ca7bb 100644 --- a/reference/eio/functions/eio-syncfs.xml +++ b/reference/eio/functions/eio-syncfs.xml @@ -1,6 +1,6 @@ - + eio_syncfs Calls Linux' syncfs syscall, if available diff --git a/reference/eio/functions/eio-truncate.xml b/reference/eio/functions/eio-truncate.xml index b7819a4fa..3fb6e7259 100644 --- a/reference/eio/functions/eio-truncate.xml +++ b/reference/eio/functions/eio-truncate.xml @@ -1,6 +1,6 @@ - + eio_truncate Truncate a file diff --git a/reference/eio/functions/eio-unlink.xml b/reference/eio/functions/eio-unlink.xml index 78b300a3c..ebef2e006 100644 --- a/reference/eio/functions/eio-unlink.xml +++ b/reference/eio/functions/eio-unlink.xml @@ -1,6 +1,6 @@ - + eio_unlink Delete a name and possibly the file it refers to diff --git a/reference/eio/functions/eio-utime.xml b/reference/eio/functions/eio-utime.xml index 9c4cb17e8..0ce394f20 100644 --- a/reference/eio/functions/eio-utime.xml +++ b/reference/eio/functions/eio-utime.xml @@ -1,6 +1,6 @@ - + eio_utime Change file last access and modification times diff --git a/reference/eio/functions/eio-write.xml b/reference/eio/functions/eio-write.xml index 8c5b50506..bee80cc4f 100644 --- a/reference/eio/functions/eio-write.xml +++ b/reference/eio/functions/eio-write.xml @@ -1,6 +1,6 @@ - + eio_write Write to file diff --git a/reference/ev/book.xml b/reference/ev/book.xml index 6ffe59ebb..11663da4d 100644 --- a/reference/ev/book.xml +++ b/reference/ev/book.xml @@ -1,6 +1,6 @@ - + Ev Ev diff --git a/reference/ev/configure.xml b/reference/ev/configure.xml index 7bf61d39e..46af9c84c 100644 --- a/reference/ev/configure.xml +++ b/reference/ev/configure.xml @@ -1,6 +1,6 @@ -
+
&reftitle.install; diff --git a/reference/ev/ev/backend.xml b/reference/ev/ev/backend.xml index 202675315..743db131e 100644 --- a/reference/ev/ev/backend.xml +++ b/reference/ev/ev/backend.xml @@ -1,6 +1,6 @@ - + Ev::backend Returns an integer describing the backend used by libev diff --git a/reference/ev/ev/depth.xml b/reference/ev/ev/depth.xml index 0c8842237..d20307778 100644 --- a/reference/ev/ev/depth.xml +++ b/reference/ev/ev/depth.xml @@ -1,6 +1,6 @@ - + Ev::depth Returns recursion depth diff --git a/reference/ev/ev/embeddablebackends.xml b/reference/ev/ev/embeddablebackends.xml index 2049eb00c..26d5a76fc 100644 --- a/reference/ev/ev/embeddablebackends.xml +++ b/reference/ev/ev/embeddablebackends.xml @@ -1,6 +1,6 @@ - + Ev::embeddableBackends Returns the set of backends that are embeddable in other event loops diff --git a/reference/ev/ev/feedsignal.xml b/reference/ev/ev/feedsignal.xml index 36dfbe862..b8faa8bb4 100644 --- a/reference/ev/ev/feedsignal.xml +++ b/reference/ev/ev/feedsignal.xml @@ -1,6 +1,6 @@ - + Ev::feedSignal Feed a signal event into Ev diff --git a/reference/ev/ev/feedsignalevent.xml b/reference/ev/ev/feedsignalevent.xml index b1c0f604e..2519ea384 100644 --- a/reference/ev/ev/feedsignalevent.xml +++ b/reference/ev/ev/feedsignalevent.xml @@ -1,6 +1,6 @@ - + Ev::feedSignalEvent Feed signal event into the default loop diff --git a/reference/ev/ev/iteration.xml b/reference/ev/ev/iteration.xml index 59eb9bc59..b8563e4ac 100644 --- a/reference/ev/ev/iteration.xml +++ b/reference/ev/ev/iteration.xml @@ -1,6 +1,6 @@ - + Ev::iteration Return the number of times the default event loop has polled for new diff --git a/reference/ev/ev/now.xml b/reference/ev/ev/now.xml index 13bdac16c..a4f8b18a2 100644 --- a/reference/ev/ev/now.xml +++ b/reference/ev/ev/now.xml @@ -1,6 +1,6 @@ - + Ev::now Returns the time when the last iteration of the default event diff --git a/reference/ev/ev/nowupdate.xml b/reference/ev/ev/nowupdate.xml index 05695ec9c..dea8c1a70 100644 --- a/reference/ev/ev/nowupdate.xml +++ b/reference/ev/ev/nowupdate.xml @@ -1,6 +1,6 @@ - + Ev::nowUpdate Establishes the current time by querying the kernel, updating the time diff --git a/reference/ev/ev/recommendedbackends.xml b/reference/ev/ev/recommendedbackends.xml index daabb3af9..56ab43d60 100644 --- a/reference/ev/ev/recommendedbackends.xml +++ b/reference/ev/ev/recommendedbackends.xml @@ -1,6 +1,6 @@ - + Ev::recommendedBackends Returns a bit mask of recommended backends for current diff --git a/reference/ev/ev/resume.xml b/reference/ev/ev/resume.xml index dfeb9f355..6176be83f 100644 --- a/reference/ev/ev/resume.xml +++ b/reference/ev/ev/resume.xml @@ -1,6 +1,6 @@ - + Ev::resume Resume previously suspended default event loop diff --git a/reference/ev/ev/run.xml b/reference/ev/ev/run.xml index 599aa46bf..10802bd55 100644 --- a/reference/ev/ev/run.xml +++ b/reference/ev/ev/run.xml @@ -1,6 +1,6 @@ - + Ev::run Begin checking for events and calling callbacks for the default diff --git a/reference/ev/ev/sleep.xml b/reference/ev/ev/sleep.xml index 8f5cd2b87..f277aaac4 100644 --- a/reference/ev/ev/sleep.xml +++ b/reference/ev/ev/sleep.xml @@ -1,6 +1,6 @@ - + Ev::sleep Block the process for the given number of seconds diff --git a/reference/ev/ev/stop.xml b/reference/ev/ev/stop.xml index a5d27f4bf..4a26776ee 100644 --- a/reference/ev/ev/stop.xml +++ b/reference/ev/ev/stop.xml @@ -1,6 +1,6 @@ - + Ev::stop Stops the default event loop diff --git a/reference/ev/ev/supportedbackends.xml b/reference/ev/ev/supportedbackends.xml index 696141ab3..fe779f2ea 100644 --- a/reference/ev/ev/supportedbackends.xml +++ b/reference/ev/ev/supportedbackends.xml @@ -1,6 +1,6 @@ - + Ev::supportedBackends Returns the set of backends supported by current libev diff --git a/reference/ev/ev/suspend.xml b/reference/ev/ev/suspend.xml index 71a1e8e44..af5b3e6bf 100644 --- a/reference/ev/ev/suspend.xml +++ b/reference/ev/ev/suspend.xml @@ -1,6 +1,6 @@ - + Ev::suspend Suspend the default event loop diff --git a/reference/ev/ev/time.xml b/reference/ev/ev/time.xml index 31dffd083..d5e4b9fae 100644 --- a/reference/ev/ev/time.xml +++ b/reference/ev/ev/time.xml @@ -1,6 +1,6 @@ - + Ev::time Returns the current time in fractional seconds since the epoch diff --git a/reference/ev/ev/verify.xml b/reference/ev/ev/verify.xml index b4ef7411c..b7c406471 100644 --- a/reference/ev/ev/verify.xml +++ b/reference/ev/ev/verify.xml @@ -1,6 +1,6 @@ - + Ev::verify Performs internal consistency checks(for debugging) diff --git a/reference/ev/evcheck.xml b/reference/ev/evcheck.xml index 83af918a2..9fed3a3ed 100644 --- a/reference/ev/evcheck.xml +++ b/reference/ev/evcheck.xml @@ -1,6 +1,6 @@ - + The EvCheck class EvCheck diff --git a/reference/ev/evcheck/construct.xml b/reference/ev/evcheck/construct.xml index 9b070b0ae..59601df35 100644 --- a/reference/ev/evcheck/construct.xml +++ b/reference/ev/evcheck/construct.xml @@ -1,6 +1,6 @@ - + EvCheck::__construct Constructs the EvCheck watcher object diff --git a/reference/ev/evcheck/createstopped.xml b/reference/ev/evcheck/createstopped.xml index eb622b67c..c808463c6 100644 --- a/reference/ev/evcheck/createstopped.xml +++ b/reference/ev/evcheck/createstopped.xml @@ -1,6 +1,6 @@ - + EvCheck::createStopped Create instance of a stopped EvCheck watcher diff --git a/reference/ev/evchild.xml b/reference/ev/evchild.xml index 6de0cfa62..339d2330e 100644 --- a/reference/ev/evchild.xml +++ b/reference/ev/evchild.xml @@ -1,6 +1,6 @@ - + The EvChild class EvChild diff --git a/reference/ev/evchild/construct.xml b/reference/ev/evchild/construct.xml index 897061b45..9bf228a7d 100644 --- a/reference/ev/evchild/construct.xml +++ b/reference/ev/evchild/construct.xml @@ -1,6 +1,6 @@ - + EvChild::__construct Constructs the EvChild watcher object diff --git a/reference/ev/evchild/createstopped.xml b/reference/ev/evchild/createstopped.xml index fe3cf4403..2739cd231 100644 --- a/reference/ev/evchild/createstopped.xml +++ b/reference/ev/evchild/createstopped.xml @@ -1,6 +1,6 @@ - + EvChild::createStopped Create instance of a stopped EvChild watcher diff --git a/reference/ev/evchild/set.xml b/reference/ev/evchild/set.xml index 70e4af1d3..42e898b85 100644 --- a/reference/ev/evchild/set.xml +++ b/reference/ev/evchild/set.xml @@ -1,6 +1,6 @@ - + EvChild::set Configures the watcher diff --git a/reference/ev/evembed.xml b/reference/ev/evembed.xml index e34575548..26db472c8 100644 --- a/reference/ev/evembed.xml +++ b/reference/ev/evembed.xml @@ -1,6 +1,6 @@ - + The EvEmbed class EvEmbed diff --git a/reference/ev/evembed/construct.xml b/reference/ev/evembed/construct.xml index 7522a988f..4698c5600 100644 --- a/reference/ev/evembed/construct.xml +++ b/reference/ev/evembed/construct.xml @@ -1,6 +1,6 @@ - + EvEmbed::__construct Constructs the EvEmbed object diff --git a/reference/ev/evembed/createstopped.xml b/reference/ev/evembed/createstopped.xml index 7c52ec815..c4feaab0f 100644 --- a/reference/ev/evembed/createstopped.xml +++ b/reference/ev/evembed/createstopped.xml @@ -1,6 +1,6 @@ - + EvEmbed::createStopped Create stopped EvEmbed watcher object diff --git a/reference/ev/evembed/set.xml b/reference/ev/evembed/set.xml index c4ff6b72d..dbafc8150 100644 --- a/reference/ev/evembed/set.xml +++ b/reference/ev/evembed/set.xml @@ -1,6 +1,6 @@ - + EvEmbed::set Configures the watcher diff --git a/reference/ev/evembed/sweep.xml b/reference/ev/evembed/sweep.xml index b5902670c..0eea27621 100644 --- a/reference/ev/evembed/sweep.xml +++ b/reference/ev/evembed/sweep.xml @@ -1,6 +1,6 @@ - + EvEmbed::sweep Make a single, non-blocking sweep over the embedded loop diff --git a/reference/ev/evfork.xml b/reference/ev/evfork.xml index 5539e3be1..d2be727a5 100644 --- a/reference/ev/evfork.xml +++ b/reference/ev/evfork.xml @@ -1,6 +1,6 @@ - + The EvFork class EvFork diff --git a/reference/ev/evfork/construct.xml b/reference/ev/evfork/construct.xml index 8f2b845fa..dea159fdf 100644 --- a/reference/ev/evfork/construct.xml +++ b/reference/ev/evfork/construct.xml @@ -1,6 +1,6 @@ - + EvFork::__construct Constructs the EvFork watcher object diff --git a/reference/ev/evfork/createstopped.xml b/reference/ev/evfork/createstopped.xml index bdb0bdfa8..e0237e815 100644 --- a/reference/ev/evfork/createstopped.xml +++ b/reference/ev/evfork/createstopped.xml @@ -1,6 +1,6 @@ - + EvFork::createStopped Creates a stopped instance of EvFork watcher class diff --git a/reference/ev/evidle.xml b/reference/ev/evidle.xml index 9461ad985..53e7baaf9 100644 --- a/reference/ev/evidle.xml +++ b/reference/ev/evidle.xml @@ -1,6 +1,6 @@ - + The EvIdle class EvIdle diff --git a/reference/ev/evidle/construct.xml b/reference/ev/evidle/construct.xml index 487c5a2af..9854e47e7 100644 --- a/reference/ev/evidle/construct.xml +++ b/reference/ev/evidle/construct.xml @@ -1,6 +1,6 @@ - + EvIdle::__construct Constructs the EvIdle watcher object diff --git a/reference/ev/evidle/createstopped.xml b/reference/ev/evidle/createstopped.xml index 9ddb76832..009cc2c7b 100644 --- a/reference/ev/evidle/createstopped.xml +++ b/reference/ev/evidle/createstopped.xml @@ -1,6 +1,6 @@ - + EvIdle::createStopped Creates instance of a stopped EvIdle watcher object diff --git a/reference/ev/evio/construct.xml b/reference/ev/evio/construct.xml index 3e8c48033..ac75d376c 100644 --- a/reference/ev/evio/construct.xml +++ b/reference/ev/evio/construct.xml @@ -1,6 +1,6 @@ - + EvIo::__construct Constructs EvIo watcher object diff --git a/reference/ev/evio/createstopped.xml b/reference/ev/evio/createstopped.xml index fc8de557c..24a032e60 100644 --- a/reference/ev/evio/createstopped.xml +++ b/reference/ev/evio/createstopped.xml @@ -1,6 +1,6 @@ - + EvIo::createStopped Create stopped EvIo watcher object diff --git a/reference/ev/evio/set.xml b/reference/ev/evio/set.xml index 42d150e46..e8e3736c4 100644 --- a/reference/ev/evio/set.xml +++ b/reference/ev/evio/set.xml @@ -1,6 +1,6 @@ - + EvIo::set Configures the watcher diff --git a/reference/ev/evloop.xml b/reference/ev/evloop.xml index 16d6f8b8e..1095b06de 100644 --- a/reference/ev/evloop.xml +++ b/reference/ev/evloop.xml @@ -1,6 +1,6 @@ - + The EvLoop class EvLoop diff --git a/reference/ev/evloop/backend.xml b/reference/ev/evloop/backend.xml index b33378d9b..670a24ab5 100644 --- a/reference/ev/evloop/backend.xml +++ b/reference/ev/evloop/backend.xml @@ -1,6 +1,6 @@ - + EvLoop::backend Returns an integer describing the backend used by libev diff --git a/reference/ev/evloop/check.xml b/reference/ev/evloop/check.xml index 974b4a66f..cde6ca2da 100644 --- a/reference/ev/evloop/check.xml +++ b/reference/ev/evloop/check.xml @@ -1,6 +1,6 @@ - + EvLoop::check Creates EvCheck object associated with the current event loop diff --git a/reference/ev/evloop/child.xml b/reference/ev/evloop/child.xml index c0fce3514..0b825fcce 100644 --- a/reference/ev/evloop/child.xml +++ b/reference/ev/evloop/child.xml @@ -1,6 +1,6 @@ - + EvLoop::child Creates EvChild object associated with the current event loop diff --git a/reference/ev/evloop/construct.xml b/reference/ev/evloop/construct.xml index aefec801f..26e9f6b54 100644 --- a/reference/ev/evloop/construct.xml +++ b/reference/ev/evloop/construct.xml @@ -1,6 +1,6 @@ - + EvLoop::__construct Constructs the event loop object diff --git a/reference/ev/evloop/defaultloop.xml b/reference/ev/evloop/defaultloop.xml index b8b33a0bf..264827ca9 100644 --- a/reference/ev/evloop/defaultloop.xml +++ b/reference/ev/evloop/defaultloop.xml @@ -1,6 +1,6 @@ - + EvLoop::defaultLoop Returns or creates the default event loop diff --git a/reference/ev/evloop/embed.xml b/reference/ev/evloop/embed.xml index 2381fde9c..f5a6c00de 100644 --- a/reference/ev/evloop/embed.xml +++ b/reference/ev/evloop/embed.xml @@ -1,6 +1,6 @@ - + EvLoop::embed Creates an instance of EvEmbed watcher associated diff --git a/reference/ev/evloop/fork.xml b/reference/ev/evloop/fork.xml index 469fe2388..124b2044f 100644 --- a/reference/ev/evloop/fork.xml +++ b/reference/ev/evloop/fork.xml @@ -1,6 +1,6 @@ - + EvLoop::fork Creates EvFork watcher object associated with the current event diff --git a/reference/ev/evloop/idle.xml b/reference/ev/evloop/idle.xml index b24a23968..06d190896 100644 --- a/reference/ev/evloop/idle.xml +++ b/reference/ev/evloop/idle.xml @@ -1,6 +1,6 @@ - + EvLoop::idle Creates EvIdle watcher object associated with the current event diff --git a/reference/ev/evloop/invokepending.xml b/reference/ev/evloop/invokepending.xml index 3958e7e49..4fcbbc5e0 100644 --- a/reference/ev/evloop/invokepending.xml +++ b/reference/ev/evloop/invokepending.xml @@ -1,6 +1,6 @@ - + EvLoop::invokePending Invoke all pending watchers while resetting their pending state diff --git a/reference/ev/evloop/io.xml b/reference/ev/evloop/io.xml index 7d0053760..ce965a5ac 100644 --- a/reference/ev/evloop/io.xml +++ b/reference/ev/evloop/io.xml @@ -1,6 +1,6 @@ - + EvLoop::io Create EvIo watcher object associated with the current event diff --git a/reference/ev/evloop/loopfork.xml b/reference/ev/evloop/loopfork.xml index 9606fb19c..f76edc33e 100644 --- a/reference/ev/evloop/loopfork.xml +++ b/reference/ev/evloop/loopfork.xml @@ -1,6 +1,6 @@ - + EvLoop::loopFork Must be called after a fork diff --git a/reference/ev/evloop/now.xml b/reference/ev/evloop/now.xml index f56958642..4e15f2aa9 100644 --- a/reference/ev/evloop/now.xml +++ b/reference/ev/evloop/now.xml @@ -1,6 +1,6 @@ - + EvLoop::now Returns the current "event loop time" diff --git a/reference/ev/evloop/nowupdate.xml b/reference/ev/evloop/nowupdate.xml index c74694fea..18b947fd9 100644 --- a/reference/ev/evloop/nowupdate.xml +++ b/reference/ev/evloop/nowupdate.xml @@ -1,6 +1,6 @@ - + EvLoop::nowUpdate Establishes the current time by querying the kernel, updating the time diff --git a/reference/ev/evloop/periodic.xml b/reference/ev/evloop/periodic.xml index 0b043ccfb..ad1747e0b 100644 --- a/reference/ev/evloop/periodic.xml +++ b/reference/ev/evloop/periodic.xml @@ -1,6 +1,6 @@ - + EvLoop::periodic Creates EvPeriodic watcher object associated with the current diff --git a/reference/ev/evloop/prepare.xml b/reference/ev/evloop/prepare.xml index cae9278de..cf0130197 100644 --- a/reference/ev/evloop/prepare.xml +++ b/reference/ev/evloop/prepare.xml @@ -1,6 +1,6 @@ - + EvLoop::prepare Creates EvPrepare watcher object associated with the current diff --git a/reference/ev/evloop/resume.xml b/reference/ev/evloop/resume.xml index d1e6f65cb..eaaf14dcd 100644 --- a/reference/ev/evloop/resume.xml +++ b/reference/ev/evloop/resume.xml @@ -1,6 +1,6 @@ - + EvLoop::resume Resume previously suspended default event loop diff --git a/reference/ev/evloop/run.xml b/reference/ev/evloop/run.xml index ddf0a9664..cb8d0f9c2 100644 --- a/reference/ev/evloop/run.xml +++ b/reference/ev/evloop/run.xml @@ -1,6 +1,6 @@ - + EvLoop::run Begin checking for events and calling callbacks for the loop diff --git a/reference/ev/evloop/signal.xml b/reference/ev/evloop/signal.xml index 7fc7bef27..895779dc8 100644 --- a/reference/ev/evloop/signal.xml +++ b/reference/ev/evloop/signal.xml @@ -1,6 +1,6 @@ - + EvLoop::signal Creates EvSignal watcher object associated with the current diff --git a/reference/ev/evloop/stat.xml b/reference/ev/evloop/stat.xml index fec53ab33..8000f004a 100644 --- a/reference/ev/evloop/stat.xml +++ b/reference/ev/evloop/stat.xml @@ -1,6 +1,6 @@ - + EvLoop::stat Creates EvStat watcher object associated with the current event diff --git a/reference/ev/evloop/stop.xml b/reference/ev/evloop/stop.xml index ccda96df3..67c8bebcd 100644 --- a/reference/ev/evloop/stop.xml +++ b/reference/ev/evloop/stop.xml @@ -1,6 +1,6 @@ - + EvLoop::stop Stops the event loop diff --git a/reference/ev/evloop/suspend.xml b/reference/ev/evloop/suspend.xml index 729e2da69..312ed67b4 100644 --- a/reference/ev/evloop/suspend.xml +++ b/reference/ev/evloop/suspend.xml @@ -1,6 +1,6 @@ - + EvLoop::suspend Suspend the loop diff --git a/reference/ev/evloop/timer.xml b/reference/ev/evloop/timer.xml index d52d2c7b4..abfcf7e65 100644 --- a/reference/ev/evloop/timer.xml +++ b/reference/ev/evloop/timer.xml @@ -1,6 +1,6 @@ - + EvLoop::timer Creates EvTimer watcher object associated with the current event diff --git a/reference/ev/evloop/verify.xml b/reference/ev/evloop/verify.xml index 1d353260b..749eed3e7 100644 --- a/reference/ev/evloop/verify.xml +++ b/reference/ev/evloop/verify.xml @@ -1,6 +1,6 @@ - + EvLoop::verify Performs internal consistency checks(for debugging) diff --git a/reference/ev/evperiodic.xml b/reference/ev/evperiodic.xml index a254c4547..80dfb35bf 100644 --- a/reference/ev/evperiodic.xml +++ b/reference/ev/evperiodic.xml @@ -1,6 +1,6 @@ - + The EvPeriodic class EvPeriodic diff --git a/reference/ev/evperiodic/again.xml b/reference/ev/evperiodic/again.xml index 1722165b3..053ce48a5 100644 --- a/reference/ev/evperiodic/again.xml +++ b/reference/ev/evperiodic/again.xml @@ -1,6 +1,6 @@ - + EvPeriodic::again Simply stops and restarts the periodic watcher again diff --git a/reference/ev/evperiodic/at.xml b/reference/ev/evperiodic/at.xml index bd7432c2a..dd738443a 100644 --- a/reference/ev/evperiodic/at.xml +++ b/reference/ev/evperiodic/at.xml @@ -1,6 +1,6 @@ - + EvPeriodic::at Returns the absolute time that this diff --git a/reference/ev/evperiodic/construct.xml b/reference/ev/evperiodic/construct.xml index 81cfc7f86..56671ee87 100644 --- a/reference/ev/evperiodic/construct.xml +++ b/reference/ev/evperiodic/construct.xml @@ -1,6 +1,6 @@ - + EvPeriodic::__construct Constructs EvPeriodic watcher object diff --git a/reference/ev/evperiodic/createstopped.xml b/reference/ev/evperiodic/createstopped.xml index ffe4491d6..4966c63de 100644 --- a/reference/ev/evperiodic/createstopped.xml +++ b/reference/ev/evperiodic/createstopped.xml @@ -1,6 +1,6 @@ - + EvPeriodic::createStopped Create a stopped EvPeriodic watcher diff --git a/reference/ev/evperiodic/set.xml b/reference/ev/evperiodic/set.xml index 152b2c214..3fc9b969c 100644 --- a/reference/ev/evperiodic/set.xml +++ b/reference/ev/evperiodic/set.xml @@ -1,6 +1,6 @@ - + EvPeriodic::set Configures the watcher diff --git a/reference/ev/evprepare/construct.xml b/reference/ev/evprepare/construct.xml index c7f6f35a5..d568ee498 100644 --- a/reference/ev/evprepare/construct.xml +++ b/reference/ev/evprepare/construct.xml @@ -1,6 +1,6 @@ - + EvPrepare::__construct Constructs EvPrepare watcher object diff --git a/reference/ev/evprepare/createstopped.xml b/reference/ev/evprepare/createstopped.xml index 833f8235d..631104092 100644 --- a/reference/ev/evprepare/createstopped.xml +++ b/reference/ev/evprepare/createstopped.xml @@ -1,6 +1,6 @@ - + EvPrepare::createStopped Creates a stopped instance of EvPrepare watcher diff --git a/reference/ev/evsignal.xml b/reference/ev/evsignal.xml index e7782ad09..f10abe7b0 100644 --- a/reference/ev/evsignal.xml +++ b/reference/ev/evsignal.xml @@ -1,6 +1,6 @@ - + The EvSignal class EvSignal diff --git a/reference/ev/evsignal/construct.xml b/reference/ev/evsignal/construct.xml index ec996fb33..06f1b4815 100644 --- a/reference/ev/evsignal/construct.xml +++ b/reference/ev/evsignal/construct.xml @@ -1,6 +1,6 @@ - + EvSignal::__construct Constructs EvSignal watcher object diff --git a/reference/ev/evsignal/createstopped.xml b/reference/ev/evsignal/createstopped.xml index 8d3ea025f..94b4157cd 100644 --- a/reference/ev/evsignal/createstopped.xml +++ b/reference/ev/evsignal/createstopped.xml @@ -1,6 +1,6 @@ - + EvSignal::createStopped Create stopped EvSignal watcher object diff --git a/reference/ev/evsignal/set.xml b/reference/ev/evsignal/set.xml index 5875cbf0d..56a3d0c08 100644 --- a/reference/ev/evsignal/set.xml +++ b/reference/ev/evsignal/set.xml @@ -1,6 +1,6 @@ - + EvSignal::set Configures the watcher diff --git a/reference/ev/evstat.xml b/reference/ev/evstat.xml index 673aafe68..69ec61448 100644 --- a/reference/ev/evstat.xml +++ b/reference/ev/evstat.xml @@ -1,6 +1,6 @@ - + The EvStat class EvStat diff --git a/reference/ev/evstat/attr.xml b/reference/ev/evstat/attr.xml index 2ef7d0272..9d69ee899 100644 --- a/reference/ev/evstat/attr.xml +++ b/reference/ev/evstat/attr.xml @@ -1,6 +1,6 @@ - + EvStat::attr Returns the values most recently detected by Ev diff --git a/reference/ev/evstat/construct.xml b/reference/ev/evstat/construct.xml index cea9473da..cee58d718 100644 --- a/reference/ev/evstat/construct.xml +++ b/reference/ev/evstat/construct.xml @@ -1,6 +1,6 @@ - + EvStat::__construct Constructs EvStat watcher object diff --git a/reference/ev/evstat/createstopped.xml b/reference/ev/evstat/createstopped.xml index b995d568e..0348d1004 100644 --- a/reference/ev/evstat/createstopped.xml +++ b/reference/ev/evstat/createstopped.xml @@ -1,6 +1,6 @@ - + EvStat::createStopped Create a stopped EvStat watcher object diff --git a/reference/ev/evstat/prev.xml b/reference/ev/evstat/prev.xml index cca8ba36c..79d6888db 100644 --- a/reference/ev/evstat/prev.xml +++ b/reference/ev/evstat/prev.xml @@ -1,6 +1,6 @@ - + EvStat::prev Returns the previous set of values returned by EvStat::attr diff --git a/reference/ev/evstat/set.xml b/reference/ev/evstat/set.xml index 5ccf10b13..fee9f5410 100644 --- a/reference/ev/evstat/set.xml +++ b/reference/ev/evstat/set.xml @@ -1,6 +1,6 @@ - + EvStat::set Configures the watcher diff --git a/reference/ev/evstat/stat.xml b/reference/ev/evstat/stat.xml index 80e7cec6b..1d1a10ac6 100644 --- a/reference/ev/evstat/stat.xml +++ b/reference/ev/evstat/stat.xml @@ -1,6 +1,6 @@ - + EvStat::stat Initiates the stat call diff --git a/reference/ev/evtimer.xml b/reference/ev/evtimer.xml index 35bef355a..ca7e5ad8b 100644 --- a/reference/ev/evtimer.xml +++ b/reference/ev/evtimer.xml @@ -1,6 +1,6 @@ - + The EvTimer class EvTimer diff --git a/reference/ev/evtimer/again.xml b/reference/ev/evtimer/again.xml index 44760fc25..e81c4303c 100644 --- a/reference/ev/evtimer/again.xml +++ b/reference/ev/evtimer/again.xml @@ -1,6 +1,6 @@ - + EvTimer::again Restarts the timer watcher diff --git a/reference/ev/evtimer/construct.xml b/reference/ev/evtimer/construct.xml index d788c1c50..10964a22f 100644 --- a/reference/ev/evtimer/construct.xml +++ b/reference/ev/evtimer/construct.xml @@ -1,6 +1,6 @@ - + EvTimer::__construct Constructs an EvTimer watcher object diff --git a/reference/ev/evtimer/createstopped.xml b/reference/ev/evtimer/createstopped.xml index 691ddabda..30e12b833 100644 --- a/reference/ev/evtimer/createstopped.xml +++ b/reference/ev/evtimer/createstopped.xml @@ -1,6 +1,6 @@ - + EvTimer::createStopped Creates EvTimer stopped watcher object diff --git a/reference/ev/evtimer/set.xml b/reference/ev/evtimer/set.xml index a32690104..ffe7445fc 100644 --- a/reference/ev/evtimer/set.xml +++ b/reference/ev/evtimer/set.xml @@ -1,6 +1,6 @@ - + EvTimer::set Configures the watcher diff --git a/reference/ev/evwatcher.xml b/reference/ev/evwatcher.xml index 785b45687..a0b965d52 100644 --- a/reference/ev/evwatcher.xml +++ b/reference/ev/evwatcher.xml @@ -1,6 +1,6 @@ - + The EvWatcher class EvWatcher diff --git a/reference/ev/evwatcher/clear.xml b/reference/ev/evwatcher/clear.xml index 51cb3d6c4..45bd66351 100644 --- a/reference/ev/evwatcher/clear.xml +++ b/reference/ev/evwatcher/clear.xml @@ -1,6 +1,6 @@ - + EvWatcher::clear Clear watcher pending status diff --git a/reference/ev/evwatcher/construct.xml b/reference/ev/evwatcher/construct.xml index b01c7dfc9..46b6dec98 100644 --- a/reference/ev/evwatcher/construct.xml +++ b/reference/ev/evwatcher/construct.xml @@ -1,6 +1,6 @@ - + EvWatcher::__construct Abstract constructor of a watcher object diff --git a/reference/ev/evwatcher/feed.xml b/reference/ev/evwatcher/feed.xml index a4a65ccf6..438284904 100644 --- a/reference/ev/evwatcher/feed.xml +++ b/reference/ev/evwatcher/feed.xml @@ -1,6 +1,6 @@ - + EvWatcher::feed Feeds the given revents set into the event loop diff --git a/reference/ev/evwatcher/getloop.xml b/reference/ev/evwatcher/getloop.xml index 395dbe332..afa9ef219 100644 --- a/reference/ev/evwatcher/getloop.xml +++ b/reference/ev/evwatcher/getloop.xml @@ -1,6 +1,6 @@ - + EvWatcher::getLoop Returns the loop responsible for the watcher diff --git a/reference/ev/evwatcher/invoke.xml b/reference/ev/evwatcher/invoke.xml index f680ab891..5ff91db38 100644 --- a/reference/ev/evwatcher/invoke.xml +++ b/reference/ev/evwatcher/invoke.xml @@ -1,6 +1,6 @@ - + EvWatcher::invoke Invokes the watcher callback with the given received events bit diff --git a/reference/ev/evwatcher/keepalive.xml b/reference/ev/evwatcher/keepalive.xml index 2fe7e384d..c2b4eded6 100644 --- a/reference/ev/evwatcher/keepalive.xml +++ b/reference/ev/evwatcher/keepalive.xml @@ -1,6 +1,6 @@ - + EvWatcher::keepalive Configures whether to keep the loop from returning diff --git a/reference/ev/evwatcher/setcallback.xml b/reference/ev/evwatcher/setcallback.xml index d0725fe98..cd984b035 100644 --- a/reference/ev/evwatcher/setcallback.xml +++ b/reference/ev/evwatcher/setcallback.xml @@ -1,6 +1,6 @@ - + EvWatcher::setCallback Sets new callback for the watcher diff --git a/reference/ev/evwatcher/start.xml b/reference/ev/evwatcher/start.xml index ea965ee92..b2cb16240 100644 --- a/reference/ev/evwatcher/start.xml +++ b/reference/ev/evwatcher/start.xml @@ -1,6 +1,6 @@ - + EvWatcher::start Starts the watcher diff --git a/reference/ev/evwatcher/stop.xml b/reference/ev/evwatcher/stop.xml index a4bfe950e..06ce76460 100644 --- a/reference/ev/evwatcher/stop.xml +++ b/reference/ev/evwatcher/stop.xml @@ -1,6 +1,6 @@ - + EvWatcher::stop Stops the watcher diff --git a/reference/ev/periodic-modes.xml b/reference/ev/periodic-modes.xml index 0388fbc04..26600e3eb 100644 --- a/reference/ev/periodic-modes.xml +++ b/reference/ev/periodic-modes.xml @@ -1,6 +1,6 @@ - + Periodic watcher operation modes EvPeriodic diff --git a/reference/ev/setup.xml b/reference/ev/setup.xml index e8f43d896..e96b7871f 100644 --- a/reference/ev/setup.xml +++ b/reference/ev/setup.xml @@ -1,6 +1,6 @@ - + &reftitle.setup;
diff --git a/reference/ev/watcher-callbacks.xml b/reference/ev/watcher-callbacks.xml index a533551b5..9ca6d395a 100644 --- a/reference/ev/watcher-callbacks.xml +++ b/reference/ev/watcher-callbacks.xml @@ -1,6 +1,6 @@ - + Watcher callbacks All watchers can be active(waiting for events) or inactive(paused). Only diff --git a/reference/ev/watchers.xml b/reference/ev/watchers.xml index c74e26256..5a6d0a43a 100644 --- a/reference/ev/watchers.xml +++ b/reference/ev/watchers.xml @@ -1,6 +1,6 @@ - + Watchers A watcher is an object that gets created to record interest in some event. diff --git a/reference/event/book.xml b/reference/event/book.xml index d6bd18e14..6c6a966bb 100644 --- a/reference/event/book.xml +++ b/reference/event/book.xml @@ -6,29 +6,29 @@ Event &reftitle.intro; - + This is an extension to efficiently schedule I/O, time and signal based events using the best I/O notification mechanism available for specific platform. This is a port of libevent to the PHP infrastructure. - + - + Note, Windows support introduced in event-1.9.0. - + - + Version 1.0.0 introduces new object-oriented API (breaking backwards compatibility), and support of libevent 2+ including HTTP, DNS, OpenSSL and the event listener. - + - + Note, event-1.0.0 and greater is not compatible with previous versions. - + &reference.event.setup; diff --git a/reference/event/configure.xml b/reference/event/configure.xml index 989ca6e81..6e2ceaf7a 100644 --- a/reference/event/configure.xml +++ b/reference/event/configure.xml @@ -3,10 +3,10 @@
&reftitle.install; - + &pecl.info; &url.pecl.package;event - +
- + Event callbacks - + If a callback is registered for an event, it will be called when the event becomes active. To associate a callback with event one can pass a callable @@ -12,10 +12,10 @@ Event::set, or one of the factory methods like Event::timer. - - + + An event callback should match the following prototype: - + void callback @@ -40,12 +40,12 @@ fd - + The file descriptor, stream resource or socket associated with the event. For signal event fd is equal to the signal number. - + @@ -53,11 +53,11 @@ what - + Bit mask of all events triggered. - + @@ -65,16 +65,16 @@ arg - + User custom data. - + - + Event::timer expects the callback to match the following prototype: - + void callback @@ -90,16 +90,16 @@ arg - + User custom data. - + - + Event::signal expects the callback to match the following prototype: - + void callback @@ -119,11 +119,11 @@ signum - + The number of the triggered signal(e.g. SIGTERM ). - + @@ -131,9 +131,9 @@ arg - + User custom data. - + diff --git a/reference/event/event.constructing.signal.events.xml b/reference/event/event.constructing.signal.events.xml index 1e7b9e472..d1bb49a0f 100644 --- a/reference/event/event.constructing.signal.events.xml +++ b/reference/event/event.constructing.signal.events.xml @@ -2,7 +2,7 @@ Constructing signal events - + Event can also watch for POSIX-style signals. To construct a handler for a signal, use Event::__construct @@ -11,7 +11,7 @@ flag, or Event::signal factory method. - + Handling <literal>SIGTERM</literal> signal @@ -56,19 +56,19 @@ $base->loop(); ]]> - + Note that signal callbacks are run in the event loop after the signal occurs, so it is safe for them to call functions that you are not supposed to call from a regular POSIX signal handler. - - - + + + See also Fast portable non-blocking network programming with Libevent, Constructing Signal Events. - + Event flags - + Event::READ This flag indicates an event that becomes active when the provided file descriptor (usually a stream resource, or socket) is ready for reading. - - + + Event::WRITE flag indicates an event that becomes active when the provided file descriptor (usually a stream resource, or socket) is ready for writing. - - + + Event::SIGNAL used to implement signal detection. See "Constructing signal events" below. - - + + Event::TIMEOUT indicates an event that becomes active after a timeout elapses. The Event::TIMEOUT @@ -26,14 +26,14 @@ or not. It is set in the $what argument to the callback function when a timeout has occurred. - - + + See also Fast portable non-blocking network programming with Libevent, Working with events, Event flags - + About event persistence - + By default, whenever a pending event becomes active (because its file descriptor is ready to read or write, or because its timeout expires), it becomes non-pending right before its callback is executed. Thus, to make the event pending again one may call Event::add on it again from inside the callback function. - - + + If the Event::PERSIST flag is set on an event, however, the event is @@ -18,34 +18,34 @@ This means that event remains pending even when its callback is activated. Event::del method can be called to make it non-pending. - - + + The timeout on a persistent event resets whenever the event's callback runs. Thus, if one has an event with flags Event::READ | Event::PERSIST and a timeout of five seconds, the event will become active: - + - + Whenever the socket or file descriptor is ready for reading. - + - + Whenever five seconds have passed since the event last became active. - + - + See also Fast portable non-blocking network programming with Libevent, About Event Persistence - +
&reftitle.intro; - + Event class represents and event firing on a file descriptor being ready to read from or write to; a file descriptor becoming ready to read from or write to(edge-triggered I/O only); a timeout expiring; a signal occurring; a user-triggered event. - - + + Every event is associated with EventBase. However, event will never fire until it is @@ -36,7 +36,7 @@ event, thus making it non-pending. By means of Event::add method it could be added again. - +
@@ -113,10 +113,10 @@ pending - + Whether event is pending. See About event persistence. - + @@ -131,14 +131,14 @@ Event::ET - + Indicates that the event should be edge-triggered, if the underlying event base backend supports edge-triggered events. This affects the semantics of Event::READ and Event::WRITE. - + @@ -146,10 +146,10 @@ Event::PERSIST - + Indicates that the event is persistent. See About event persistence. - + @@ -157,10 +157,10 @@ Event::READ - + This flag indicates an event that becomes active when the provided file descriptor(usually a stream resource, or socket) is ready for reading. - + @@ -179,10 +179,10 @@ Event::SIGNAL - + Used to implement signal detection. See "Constructing signal events" below. - + @@ -190,11 +190,11 @@ Event::TIMEOUT - + This flag indicates an event that becomes active after a timeout elapses. - - + + The Event::TIMEOUT flag is ignored when constructing an event: one can either set a @@ -203,7 +203,7 @@ or not. It is set in the $what argument to the callback function when a timeout has occurred. - + diff --git a/reference/event/event/add.xml b/reference/event/event/add.xml index 2ae88e158..5a3e5d843 100644 --- a/reference/event/event/add.xml +++ b/reference/event/event/add.xml @@ -16,13 +16,13 @@ timeout - + Marks event pending. Non-pending event will never occur, and the event callback will never be called. In conjunction with Event::del an event could be re-scheduled by user at any time. - - + + If Event::add is called on an already pending event, libevent will leave it pending and @@ -30,7 +30,7 @@ timeout is not specified, Event::add has no effect. - + @@ -41,9 +41,9 @@ timeout - + Timeout in seconds. - + @@ -51,9 +51,9 @@ &reftitle.returnvalues; - + &return.success; - + diff --git a/reference/event/event/addsignal.xml b/reference/event/event/addsignal.xml index 0a6c27ec6..acd94296a 100644 --- a/reference/event/event/addsignal.xml +++ b/reference/event/event/addsignal.xml @@ -8,9 +8,9 @@ &reftitle.description; - + &info.method.alias; Event::add - +
&reftitle.intro; - + EventBase class represents libevent's event base structure. It holds a set of events and can poll to determine which events are active. - - + + Each event base has a method, or a @@ -27,14 +27,14 @@ evport and win32. - - + + To configure event base to use, or avoid specific backend EventConfig class can be used. - + - + Do NOT destroy the @@ -43,7 +43,7 @@ Event objects are not released. Otherwise, it will lead to unpredictable results! - +
@@ -114,12 +114,12 @@ EventBase::LOOP_ONCE - + Flag used with EventBase::loop method which means: "block until libevent has an active event, then exit once all active events have had their callbacks run". - + @@ -127,12 +127,12 @@ EventBase::LOOP_NONBLOCK - + Flag used with EventBase::loop method which means: "do not block: see which events are ready now, run the callbacks of the highest-priority ones, then exit". - + @@ -140,10 +140,10 @@ EventBase::NOLOCK - + Configuration flag. Do not allocate a lock for the event base, even if we have locking set up". - + @@ -151,10 +151,10 @@ EventBase::STARTUP_IOCP - + Windows-only configuration flag. Enables the IOCP dispatcher at startup. - + @@ -162,11 +162,11 @@ EventBase::NO_CACHE_TIME - + Configuration flag. Instead of checking the current time every time the event loop is ready to run timeout callbacks, check after each timeout callback. - + @@ -174,28 +174,28 @@ EventBase::EPOLL_USE_CHANGELIST - + If we are using the epoll backend, this flag says that it is safe to use Libevent's internal change-list code to batch up adds and deletes in order to try to do as few syscalls as possible. - - + + Setting this flag can make code run faster, but it may trigger a Linux bug: it is not safe to use this flag if one has any fds cloned by dup(), or its variants. Doing so will produce strange and hard-to-diagnose bugs. - + This flag can also be activated by setting the EVENT_EPOLL_USE_CHANGELIST environment variable. - + This flag has no effect if one winds up using a backend other than epoll. - + diff --git a/reference/event/eventbase/construct.xml b/reference/event/eventbase/construct.xml index 6cdb680e2..586eb7f0a 100644 --- a/reference/event/eventbase/construct.xml +++ b/reference/event/eventbase/construct.xml @@ -15,9 +15,9 @@ cfg - + Constructs EventBase object - + &reftitle.parameters; @@ -27,21 +27,21 @@ cfg - + Optional EventConfig object. - + &reftitle.errors; - + If EventBase cannot be constructed with the provided configuration, - a EventException will be thrown. - + a EventException will be thrown. + &reftitle.seealso; diff --git a/reference/event/eventbase/dispatch.xml b/reference/event/eventbase/dispatch.xml index bce4be7b9..dbf920df5 100644 --- a/reference/event/eventbase/dispatch.xml +++ b/reference/event/eventbase/dispatch.xml @@ -1,6 +1,6 @@ - + EventBase::dispatch Dispatch pending events @@ -13,11 +13,11 @@ EventBase::dispatch - + Wait for events to become active, and run their callbacks. The same as EventBase::loop with no flags set. - + @@ -28,9 +28,9 @@ &reftitle.returnvalues; - + &return.success; - + &reftitle.seealso; diff --git a/reference/event/eventbase/exit.xml b/reference/event/eventbase/exit.xml index ef05e72fe..2ff18095a 100644 --- a/reference/event/eventbase/exit.xml +++ b/reference/event/eventbase/exit.xml @@ -16,9 +16,9 @@ timeout - + Tells event base to stop optionally after given number of seconds. - + &reftitle.parameters; @@ -28,19 +28,19 @@ timeout - + Optional number of seconds after which the event base should stop dispatching events. - + &reftitle.returnvalues; - + &return.success; - + &reftitle.seealso; diff --git a/reference/event/eventbase/free.xml b/reference/event/eventbase/free.xml index 21b8284e0..3bce62b01 100644 --- a/reference/event/eventbase/free.xml +++ b/reference/event/eventbase/free.xml @@ -13,23 +13,23 @@ EventBase::free - + Deallocates resources allocated by libevent for the EventBase object. - + - + The EventBase::free method doesn't destruct the object itself. To destruct the object completely call unset, or assign &null;. - - + + This method does not deallocate or detach any of the events that are currently associated with the EventBase object, or close any of their sockets - beware. - + @@ -38,9 +38,9 @@ &reftitle.returnvalues; - + &return.void; - + &reftitle.seealso; diff --git a/reference/event/eventbase/getfeatures.xml b/reference/event/eventbase/getfeatures.xml index 9824e6fdd..9c4f0e57b 100644 --- a/reference/event/eventbase/getfeatures.xml +++ b/reference/event/eventbase/getfeatures.xml @@ -13,9 +13,9 @@ EventBase::getFeatures - + Returns bitmask of features supported. - + &reftitle.parameters; @@ -23,10 +23,10 @@ &reftitle.returnvalues; - + Returns integer representing a bitmask of supported features. See EventConfig::FEATURE_* constants. - + &reftitle.examples; diff --git a/reference/event/eventbase/getmethod.xml b/reference/event/eventbase/getmethod.xml index 85ba68827..ee8473ad4 100644 --- a/reference/event/eventbase/getmethod.xml +++ b/reference/event/eventbase/getmethod.xml @@ -13,7 +13,7 @@ EventBase::getMethod - + &reftitle.parameters; @@ -21,9 +21,9 @@ &reftitle.returnvalues; - + String representing used event method(backend). - + &reftitle.examples; diff --git a/reference/event/eventbase/gettimeofdaycached.xml b/reference/event/eventbase/gettimeofdaycached.xml index 30e0638f7..09284b52e 100644 --- a/reference/event/eventbase/gettimeofdaycached.xml +++ b/reference/event/eventbase/gettimeofdaycached.xml @@ -13,7 +13,7 @@ EventBase::getTimeOfDayCached - + On success returns the current time(as returned by gettimeofday() ), looking at the cached value in @@ -23,7 +23,7 @@ or clock_gettime() as appropriate if there is no cached time. - + &reftitle.parameters; @@ -31,11 +31,11 @@ &reftitle.returnvalues; - + Returns the current event base time. On failure returns &null;. - + - + EventBase::loop Dispatch pending events @@ -16,9 +16,9 @@ flags - + Wait for events to become active, and run their callbacks. - + @@ -31,21 +31,21 @@ flags - + Optional flags. One of EventBase::LOOP_* constants. See EventBase constants. - + &reftitle.returnvalues; - + &return.success; - + &reftitle.seealso; diff --git a/reference/event/eventbase/priorityinit.xml b/reference/event/eventbase/priorityinit.xml index 466f0e408..5655ded1b 100644 --- a/reference/event/eventbase/priorityinit.xml +++ b/reference/event/eventbase/priorityinit.xml @@ -16,9 +16,9 @@ n_priorities - + Sets number of priorities per event base. - + &reftitle.parameters; @@ -28,18 +28,18 @@ n_priorities - + The number of priorities per event base. - + &reftitle.returnvalues; - + &return.success; - + &reftitle.seealso; diff --git a/reference/event/eventbase/reinit.xml b/reference/event/eventbase/reinit.xml index ddbb9f808..afae46ca9 100644 --- a/reference/event/eventbase/reinit.xml +++ b/reference/event/eventbase/reinit.xml @@ -13,9 +13,9 @@ EventBase::reInit - + Re-initialize event base. Should be called after a fork. - + &reftitle.parameters; @@ -23,9 +23,9 @@ &reftitle.returnvalues; - + &return.success; - +
&reftitle.intro; - + EventBuffer represents Libevent's "evbuffer", an utility functionality for buffered I/O. - - + + Event buffers are meant to be generally useful for doing the "buffer" part of buffered network I/O. - +
@@ -97,9 +97,9 @@ length - + The number of bytes stored in an event buffer. - + @@ -107,12 +107,12 @@ contiguous_space - + The number of bytes stored contiguously at the front of the buffer. The bytes in a buffer may be stored in multiple separate chunks of memory; the property returns the number of bytes currently stored in the first chunk. - + @@ -127,11 +127,11 @@ EventBuffer::EOL_ANY - + The end of line is any sequence of any number of carriage return and linefeed characters. This format is not very useful; it exists mainly for backward compatibility. - + @@ -139,7 +139,7 @@ EventBuffer::EOL_CRLF - + The end of the line is an optional carriage return, followed by a linefeed. (In other words, it is either a "\r\n" @@ -150,7 +150,7 @@ "\r\n" line-terminator, but nonconformant clients sometimes say just "\n". - + @@ -158,7 +158,7 @@ EventBuffer::EOL_CRLF_STRICT - + The end of a line is a single carriage return, followed by a single linefeed. (This is also known as "\r\n". @@ -166,7 +166,7 @@ 0x0D 0x0A ). - + @@ -174,14 +174,14 @@ EventBuffer::EOL_LF - + The end of a line is a single linefeed character. (This is also known as "\n". It is ASCII value is 0x0A .) - + @@ -189,12 +189,12 @@ EventBuffer::PTR_SET - + Flag used as argument of EventBuffer::setPosition method. If this flag specified, the position pointer is moved to an absolute position within the buffer. - + @@ -202,14 +202,14 @@ EventBuffer::PTR_ADD - + The same as EventBuffer::PTR_SET, except this flag causes EventBuffer::setPosition method to move position forward up to the specified number of bytes(instead of setting absolute position). - + diff --git a/reference/event/eventbuffer/add.xml b/reference/event/eventbuffer/add.xml index ac232c362..d0e7b948c 100644 --- a/reference/event/eventbuffer/add.xml +++ b/reference/event/eventbuffer/add.xml @@ -16,9 +16,9 @@ data - + Append data to the end of an event buffer. - + &reftitle.parameters; @@ -28,18 +28,18 @@ data - + String to be appended to the end of the buffer. - + &reftitle.returnvalues; - + &return.success; - + &reftitle.seealso; diff --git a/reference/event/eventbuffer/addbuffer.xml b/reference/event/eventbuffer/addbuffer.xml index bb0b8caf4..af7056f5a 100644 --- a/reference/event/eventbuffer/addbuffer.xml +++ b/reference/event/eventbuffer/addbuffer.xml @@ -16,14 +16,14 @@ buf - + Move all data from the buffer provided in buf parameter to the end of current EventBuffer. This is a destructive add. The data from one buffer moves into the other buffer. However, no unnecessary memory copies occur. - + &reftitle.parameters; @@ -33,18 +33,18 @@ buf - + The source EventBuffer object. - + &reftitle.returnvalues; - + &return.success; - + &reftitle.seealso; diff --git a/reference/event/eventbuffer/appendfrom.xml b/reference/event/eventbuffer/appendfrom.xml index f3792ee9c..38f9e9375 100644 --- a/reference/event/eventbuffer/appendfrom.xml +++ b/reference/event/eventbuffer/appendfrom.xml @@ -1,6 +1,6 @@ - + EventBuffer::appendFrom Moves the specified number of bytes from a source buffer to the @@ -21,11 +21,11 @@ len - + Moves the specified number of bytes from a source buffer to the end of the current buffer. If there are fewer number of bytes, it moves all the bytes available from the source buffer. - + &reftitle.parameters; @@ -35,9 +35,9 @@ buf - + Source buffer. - + @@ -52,9 +52,9 @@ &reftitle.returnvalues; - + Returns the number of bytes read. - + &reftitle.changelog; diff --git a/reference/event/eventbuffer/construct.xml b/reference/event/eventbuffer/construct.xml index d8d5c6318..ddcca8bd6 100644 --- a/reference/event/eventbuffer/construct.xml +++ b/reference/event/eventbuffer/construct.xml @@ -12,9 +12,9 @@ EventBuffer::__construct - + Constructs EventBuffer object - + &reftitle.parameters; diff --git a/reference/event/eventbuffer/copyout.xml b/reference/event/eventbuffer/copyout.xml index 5b440c52d..90bdd615e 100644 --- a/reference/event/eventbuffer/copyout.xml +++ b/reference/event/eventbuffer/copyout.xml @@ -20,7 +20,7 @@ max_bytes - + Behaves just like EventBuffer::read, but does not drain any data from the buffer. I.e. it copies the first @@ -30,7 +30,7 @@ If there are fewer than max_bytes bytes available, the function copies all the bytes there are. - + &reftitle.parameters; @@ -40,9 +40,9 @@ data - + Output string. - + @@ -50,20 +50,20 @@ max_bytes - + The number of bytes to copy. - + &reftitle.returnvalues; - + Returns the number of bytes copied, or -1 on failure. - + &reftitle.seealso; diff --git a/reference/event/eventbuffer/drain.xml b/reference/event/eventbuffer/drain.xml index beb303590..236e58969 100644 --- a/reference/event/eventbuffer/drain.xml +++ b/reference/event/eventbuffer/drain.xml @@ -17,12 +17,12 @@ len - + Behaves as EventBuffer::read, except that it does not copy the data: it just removes it from the front of the buffer. - + &reftitle.parameters; @@ -32,18 +32,18 @@ len - + The number of bytes to remove from the buffer. - + &reftitle.returnvalues; - + &return.success; - + &reftitle.seealso; diff --git a/reference/event/eventbuffer/enablelocking.xml b/reference/event/eventbuffer/enablelocking.xml index 3aa585455..222c38e83 100644 --- a/reference/event/eventbuffer/enablelocking.xml +++ b/reference/event/eventbuffer/enablelocking.xml @@ -13,13 +13,13 @@ EventBuffer::enableLocking - + Enable locking on an EventBuffer so that it can safely be used by multiple threads at the same time. When locking is enabled, the lock will be held when callbacks are invoked. This could result in deadlock if you aren't careful. Plan accordingly! - + &reftitle.parameters; @@ -27,9 +27,9 @@ &reftitle.returnvalues; - + &return.void; - + &reftitle.seealso; diff --git a/reference/event/eventbuffer/expand.xml b/reference/event/eventbuffer/expand.xml index e0fcec65e..ad14a9b62 100644 --- a/reference/event/eventbuffer/expand.xml +++ b/reference/event/eventbuffer/expand.xml @@ -16,12 +16,12 @@ len - + Alters the last chunk of memory in the buffer, or adds a new chunk, such that the buffer is now large enough to contain len bytes without any further allocations. - + &reftitle.parameters; @@ -31,18 +31,18 @@ len - + The number of bytes to reserve for the buffer - + &reftitle.returnvalues; - + &return.success; - + - + EventBuffer::read Read data from an evbuffer and drain the bytes read @@ -16,14 +16,14 @@ max_bytes - + Read the first max_bytes from the buffer and drain the bytes read. If more max_bytes are requested than are available in the buffer, it only extracts as many bytes as available. - + &reftitle.parameters; @@ -42,9 +42,9 @@ &reftitle.returnvalues; - + Returns string read, or &false; on failure. - + &reftitle.changelog; diff --git a/reference/event/eventbuffer/readfrom.xml b/reference/event/eventbuffer/readfrom.xml index 5c07316f2..968b549b9 100644 --- a/reference/event/eventbuffer/readfrom.xml +++ b/reference/event/eventbuffer/readfrom.xml @@ -20,11 +20,11 @@ howmuch - + Read data from the file specified by fd onto the end of the buffer. - + &reftitle.parameters; @@ -34,9 +34,9 @@ fd - + Socket resource, stream, or numeric file descriptor. - + @@ -53,9 +53,9 @@ &reftitle.returnvalues; - + Returns the number of bytes read, or &false; on failure. - + &reftitle.seealso; diff --git a/reference/event/eventbuffer/readline.xml b/reference/event/eventbuffer/readline.xml index c953eaf20..782be891f 100644 --- a/reference/event/eventbuffer/readline.xml +++ b/reference/event/eventbuffer/readline.xml @@ -16,11 +16,11 @@ eol_style - + Extracts a line from the front of the buffer and returns it in a newly allocated string. If there is not a whole line to read, the function returns &null;. The line terminator is not included in the copied string. - + &reftitle.parameters; @@ -30,19 +30,19 @@ eol_style - + One of EventBuffer:EOL_* constants. - + &reftitle.returnvalues; - + On success returns the line read from the buffer, otherwise &null;. - + &reftitle.seealso; diff --git a/reference/event/eventbuffer/search.xml b/reference/event/eventbuffer/search.xml index 844e3f8b3..d8a224f51 100644 --- a/reference/event/eventbuffer/search.xml +++ b/reference/event/eventbuffer/search.xml @@ -27,13 +27,13 @@ -1 - + Scans the buffer for an occurrence of the string what. It returns numeric position of the string, or &false; if the string was not found. - - + + If the start argument is provided, it points to the position at which the search should @@ -41,7 +41,7 @@ end argument provided, the search is performed between start and end buffer positions. - + &reftitle.parameters; @@ -51,9 +51,9 @@ what - + String to search. - + @@ -61,9 +61,9 @@ start - + Start search position. - + @@ -71,19 +71,19 @@ end - + End search position. - + &reftitle.returnvalues; - + Returns numeric position of the first occurrence of the string in the buffer, or &false; if string is not found. - + &return.falseproblem; diff --git a/reference/event/eventbuffer/searcheol.xml b/reference/event/eventbuffer/searcheol.xml index 9493f4fd0..5e1659ce5 100644 --- a/reference/event/eventbuffer/searcheol.xml +++ b/reference/event/eventbuffer/searcheol.xml @@ -25,13 +25,13 @@ - + Scans the buffer for an occurrence of an end of line specified by eol_style parameter . It returns numeric position of the string, or &false; if the string was not found. - - + + If the start argument is provided, it represents the position at which the search should @@ -39,7 +39,7 @@ end argument provided, the search is performed between start and end buffer positions. - + &reftitle.parameters; @@ -49,9 +49,9 @@ start - + Start search position. - + @@ -59,20 +59,20 @@ eol_style - + One of EventBuffer:EOL_* constants. - + &reftitle.returnvalues; - + Returns numeric position of the first occurrence of end-of-line symbol in the buffer, or &false; if not found. - + &return.falseproblem; diff --git a/reference/event/eventbuffer/unfreeze.xml b/reference/event/eventbuffer/unfreeze.xml index 4e09c071e..6435a395e 100644 --- a/reference/event/eventbuffer/unfreeze.xml +++ b/reference/event/eventbuffer/unfreeze.xml @@ -16,9 +16,9 @@ at_front - + Re-enable calls that modify an event buffer. - + &reftitle.parameters; @@ -28,18 +28,18 @@ at_front - + Whether to enable events at the front or at the end of the buffer. - + &reftitle.returnvalues; - + &return.success; - + &reftitle.seealso; diff --git a/reference/event/eventbuffer/unlock.xml b/reference/event/eventbuffer/unlock.xml index fdbc74a61..0469864db 100644 --- a/reference/event/eventbuffer/unlock.xml +++ b/reference/event/eventbuffer/unlock.xml @@ -13,10 +13,10 @@ EventBuffer::unlock - + Releases lock acquired by EventBuffer::lock. - + &reftitle.parameters; @@ -24,9 +24,9 @@ &reftitle.returnvalues; - + &return.success; - + &reftitle.seealso; diff --git a/reference/event/eventbuffer/write.xml b/reference/event/eventbuffer/write.xml index f003ca65c..0a8f7e9fc 100644 --- a/reference/event/eventbuffer/write.xml +++ b/reference/event/eventbuffer/write.xml @@ -20,10 +20,10 @@ howmuch - + Write contents of the buffer to a file descriptor. The buffer will be drained after the bytes have been successfully written. - + &reftitle.parameters; @@ -44,18 +44,18 @@ howmuch - + The maximum number of bytes to write. - + &reftitle.returnvalues; - + Returns the number of bytes written, or &false; on error. - + &reftitle.seealso; diff --git a/reference/event/eventbufferevent.about.callbacks.xml b/reference/event/eventbufferevent.about.callbacks.xml index 5ef366d32..64f992055 100644 --- a/reference/event/eventbufferevent.about.callbacks.xml +++ b/reference/event/eventbufferevent.about.callbacks.xml @@ -1,8 +1,8 @@ - + About buffer event callbacks - + An object of EventBufferEvent class represents a @@ -12,10 +12,10 @@ invokes corresponding callbacks when the resource becomes available for reading or writing, or when some event occurs(e.g. error, "end of line" etc.). - - + + Read and write callbacks should match the following prototype: - + void callback @@ -36,11 +36,11 @@ bev - + Associated EventBufferEvent object. - + @@ -48,18 +48,18 @@ arg - + Custom variable attached to all callbacks via EventBufferEvent::__construct, or EventBufferEvent::setCallbacks. - + - + Event callback should match the following prototype: - + void callback @@ -85,11 +85,11 @@ bev - + Associated EventBufferEvent object. - + @@ -97,7 +97,7 @@ events - + Bit mask of events: EventBufferEvent::READING, EventBufferEvent::WRITING, @@ -107,7 +107,7 @@ EventBufferEvent::TIMEOUT. See EventBufferEvent constants - + @@ -115,12 +115,12 @@ arg - + Custom variable attached to all callbacks via EventBufferEvent::__construct, or EventBufferEvent::setCallbacks. - + diff --git a/reference/event/eventbufferevent.xml b/reference/event/eventbufferevent.xml index 02696f7f4..2b7fbc75a 100644 --- a/reference/event/eventbufferevent.xml +++ b/reference/event/eventbufferevent.xml @@ -7,46 +7,46 @@
&reftitle.intro; - + Represents Libevent's buffer event. - - + + Usually an application wants to perform some amount of data buffering in addition to just responding to events. When we want to write data, for example, the usual pattern looks like: - + - + Decide that we want to write some data to a connection; put that data in a buffer. - + - + Wait for the connection to become writable - + - + Write as much of the data as we can - + - + Remember how much we wrote, and if we still have more data to write, wait for the connection to become writable again. - + - + This buffered I/O pattern is common enough that Libevent provides a generic mechanism for it. A "buffer event" consists of an underlying transport (like a socket), a read buffer, and a write buffer. Instead of regular events, which give callbacks when the underlying transport is ready to be read or written, a buffer event invokes its user-supplied callbacks when it has read or written enough data. - +
@@ -181,11 +181,11 @@ fd - + Numeric file descriptor associated with the buffer event. Normally represents a bound socket. Equals to &null;, if there is no file descriptor(socket) associated with the buffer event. - + @@ -193,9 +193,9 @@ priority - + The priority of the events used to implement the buffer event. - + @@ -203,10 +203,10 @@ input - + Underlying input buffer object( EventBuffer) - + @@ -214,10 +214,10 @@ output - + Underlying output buffer object( EventBuffer) - + @@ -232,10 +232,10 @@ EventBufferEvent::READING - + An event occurred during a read operation on the bufferevent. See the other flags for which event it was. - + @@ -243,10 +243,10 @@ EventBufferEvent::WRITING - + An event occurred during a write operation on the bufferevent. See the other flags for which event it was. - + @@ -254,9 +254,9 @@ EventBufferEvent::EOF - + Got an end-of-file indication on the buffer event. - + @@ -264,13 +264,13 @@ EventBufferEvent::ERROR - + An error occurred during a bufferevent operation. For more information on what the error was, call EventUtil::getLastSocketErrno and/or EventUtil::getLastSocketError. - + @@ -278,7 +278,7 @@ EventBufferEvent::TIMEOUT - + @@ -286,9 +286,9 @@ EventBufferEvent::CONNECTED - + Finished a requested connection on the bufferevent. - + @@ -296,10 +296,10 @@ EventBufferEvent::OPT_CLOSE_ON_FREE - + When the buffer event is freed, close the underlying transport. This will close an underlying socket, free an underlying buffer event, etc. - + @@ -307,10 +307,10 @@ EventBufferEvent::OPT_THREADSAFE - + Automatically allocate locks for the bufferevent, so that it’s safe to use from multiple threads. - + @@ -318,12 +318,12 @@ EventBufferEvent::OPT_DEFER_CALLBACKS - + When this flag is set, the bufferevent defers all of its callbacks. See Fast portable non-blocking network programming with Libevent, Deferred callbacks. - + @@ -331,12 +331,12 @@ EventBufferEvent::OPT_UNLOCK_CALLBACKS - + By default, when the bufferevent is set up to be threadsafe, the buffer event’s locks are held whenever the any user-provided callback is invoked. Setting this option makes Libevent release the buffer event’s lock when it’s invoking the callbacks. - + @@ -344,9 +344,9 @@ EventBufferEvent::SSL_OPEN - + The SSL handshake is done - + @@ -354,9 +354,9 @@ EventBufferEvent::SSL_CONNECTING - + SSL is currently performing negotiation as a client - + @@ -364,9 +364,9 @@ EventBufferEvent::SSL_ACCEPTING - + SSL is currently performing negotiation as a server - + diff --git a/reference/event/eventbufferevent/close.xml b/reference/event/eventbufferevent/close.xml index 914426a1c..049494ae5 100644 --- a/reference/event/eventbufferevent/close.xml +++ b/reference/event/eventbufferevent/close.xml @@ -13,13 +13,13 @@ EventBufferEvent::close - + Closes file descriptor associated with the current buffer event. - - + + This method may be used in cases when the EventBufferEvent::OPT_CLOSE_ON_FREE option is not appropriate. - + &reftitle.parameters; @@ -27,9 +27,9 @@ &reftitle.returnvalues; - + &return.void; - + - + EventBufferEvent::createPair Creates two buffer events connected to each other @@ -22,7 +22,7 @@ 0 - + Returns array of two EventBufferEvent objects connected to each other. All the usual options are supported, @@ -31,7 +31,7 @@ which has no effect, and EventBufferEvent::OPT_DEFER_CALLBACKS, which is always on. - + &reftitle.parameters; @@ -41,9 +41,9 @@ base - + Associated event base - + @@ -51,23 +51,23 @@ options - + EventBufferEvent::OPT_* constants combined with bitwise OR operator. - + &reftitle.returnvalues; - + Returns array of two EventBufferEvent objects connected to each other. - + &reftitle.changelog; diff --git a/reference/event/eventbufferevent/disable.xml b/reference/event/eventbufferevent/disable.xml index b7b50dbc8..730e6a8ef 100644 --- a/reference/event/eventbufferevent/disable.xml +++ b/reference/event/eventbufferevent/disable.xml @@ -16,7 +16,7 @@ events - + Disable events Event::READ, Event::WRITE, @@ -25,7 +25,7 @@ | Event::WRITE on a buffer event. - + &reftitle.parameters; @@ -35,16 +35,16 @@ events - + &reftitle.returnvalues; - + &return.success; - + &reftitle.seealso; diff --git a/reference/event/eventbufferevent/enable.xml b/reference/event/eventbufferevent/enable.xml index 26bc794ce..6f205ba69 100644 --- a/reference/event/eventbufferevent/enable.xml +++ b/reference/event/eventbufferevent/enable.xml @@ -16,7 +16,7 @@ events - + Enable events Event::READ, Event::WRITE, @@ -25,7 +25,7 @@ | Event::WRITE on a buffer event. - + &reftitle.parameters; @@ -35,7 +35,7 @@ events - + Event::READ, Event::WRITE, or @@ -43,16 +43,16 @@ | Event::WRITE on a buffer event. - + &reftitle.returnvalues; - + &return.success; - + &reftitle.seealso; diff --git a/reference/event/eventbufferevent/free.xml b/reference/event/eventbufferevent/free.xml index 8462ca361..a1283f7d7 100644 --- a/reference/event/eventbufferevent/free.xml +++ b/reference/event/eventbufferevent/free.xml @@ -13,10 +13,10 @@ EventBufferEvent::free - + Free resources allocated by buffer event. - - + + Usually there is no need to call this method, since normally it is done within internal object destructors. However, sometimes we have a long-time script allocating lots of instances, or a script with a heavy memory usage, @@ -24,7 +24,7 @@ EventBufferEvent::free may be used to protect the script against running up to the memory_limit. - + &reftitle.parameters; @@ -32,9 +32,9 @@ &reftitle.returnvalues; - + &return.void; - + - + EventBufferEvent::sslFilter Create a new SSL buffer event to send its data over another buffer event @@ -34,15 +34,15 @@ 0 - + Create a new SSL buffer event to send its data over another buffer event - + - + This function is available only if Event is compiled with OpenSSL support. - + @@ -53,9 +53,9 @@ base - + Associated event base. - + @@ -63,9 +63,9 @@ underlying - + A socket buffer event to use for this SSL. - + @@ -73,11 +73,11 @@ ctx - + Object of EventSslContext class. - + @@ -85,13 +85,13 @@ state - + The current state of SSL connection: EventBufferEvent::SSL_OPEN, EventBufferEvent::SSL_ACCEPTING or EventBufferEvent::SSL_CONNECTING. - + @@ -99,20 +99,20 @@ options - + One or more buffer event options. - + &reftitle.returnvalues; - + Returns a new SSL EventBufferEvent object. - + &reftitle.examples; diff --git a/reference/event/eventbufferevent/sslgetcipherinfo.xml b/reference/event/eventbufferevent/sslgetcipherinfo.xml index 89ee4d12b..d4b9bfdff 100644 --- a/reference/event/eventbufferevent/sslgetcipherinfo.xml +++ b/reference/event/eventbufferevent/sslgetcipherinfo.xml @@ -13,17 +13,17 @@ EventBufferEvent::sslGetCipherInfo - + Retrieves description of the current cipher by means of the SSL_CIPHER_description SSL API function (see SSL_CIPHER_get_name(3) man page). - + - + This function is available only if Event is compiled with OpenSSL support. - + @@ -32,9 +32,9 @@ &reftitle.returnvalues; - + Returns a textual description of the cipher on success, or &false; on error. - +
&reftitle.intro; - + Represents configuration structure which could be used in construction of the EventBase. - +
@@ -63,9 +63,9 @@ EventConfig::FEATURE_ET - + Requires a backend method that supports edge-triggered I/O. - + @@ -73,10 +73,10 @@ EventConfig::FEATURE_O1 - + Requires a backend method where adding or deleting a single event, or having a single event become active, is an O(1) operation. - + @@ -84,10 +84,10 @@ EventConfig::FEATURE_FDS - + Requires a backend method that can support arbitrary file descriptor types, and not just sockets. - + diff --git a/reference/event/eventconfig/avoidmethod.xml b/reference/event/eventconfig/avoidmethod.xml index 94ae9e109..a84e1c597 100644 --- a/reference/event/eventconfig/avoidmethod.xml +++ b/reference/event/eventconfig/avoidmethod.xml @@ -16,12 +16,12 @@ method - + Tells libevent to avoid specific event method(backend). See Creating an event base. - + &reftitle.parameters; @@ -31,20 +31,20 @@ method - + The backend method to avoid. See EventConfig constants. - + &reftitle.returnvalues; - + &return.success; - + &reftitle.examples; diff --git a/reference/event/eventconfig/construct.xml b/reference/event/eventconfig/construct.xml index b15d65d9a..2fe8d20cb 100644 --- a/reference/event/eventconfig/construct.xml +++ b/reference/event/eventconfig/construct.xml @@ -12,11 +12,11 @@ EventConfig::__construct - + Constructs EventConfig object which could be passed to EventBase::__construct constructor. - + &reftitle.parameters; diff --git a/reference/event/eventconfig/requirefeatures.xml b/reference/event/eventconfig/requirefeatures.xml index 57c61db4f..e010495bc 100644 --- a/reference/event/eventconfig/requirefeatures.xml +++ b/reference/event/eventconfig/requirefeatures.xml @@ -16,9 +16,9 @@ feature - + Enters a required event method feature that the application demands - + &reftitle.parameters; @@ -28,21 +28,21 @@ feature - + Bitmask of required features. See EventConfig::FEATURE_* constants - + &reftitle.returnvalues; - + &return.success; - + &reftitle.examples; diff --git a/reference/event/eventconfig/setflags.xml b/reference/event/eventconfig/setflags.xml index a49949940..598ff498b 100644 --- a/reference/event/eventconfig/setflags.xml +++ b/reference/event/eventconfig/setflags.xml @@ -16,10 +16,10 @@ flags - - Sets one or more flags to configure what parts of + + Sets one or more flags to configure what parts of the eventual EventBase will be initialized, and how they'll work. - + &reftitle.parameters; @@ -29,19 +29,19 @@ flags - - One of EventBase::LOOP_* constants. + + One of EventBase::LOOP_* constants. See EventBase constants. - + &reftitle.returnvalues; - + &return.success; - + &reftitle.seealso; diff --git a/reference/event/eventconfig/setmaxdispatchinterval.xml b/reference/event/eventconfig/setmaxdispatchinterval.xml index 34826bb1b..f8eafeaec 100644 --- a/reference/event/eventconfig/setmaxdispatchinterval.xml +++ b/reference/event/eventconfig/setmaxdispatchinterval.xml @@ -24,15 +24,15 @@ min_priority - + Prevents priority inversion by limiting how many low-priority event callbacks can be invoked before checking for more high-priority events. - + - + Available since libevent 2.1.0-alpha. - + @@ -43,12 +43,12 @@ max_interval - + An interval after which Libevent should stop running callbacks and check for more events, or 0, if there should be no such interval. - + @@ -56,12 +56,12 @@ max_callbacks - + A number of callbacks after which Libevent should stop running callbacks and check for more events, or -1, if there should be no such limit. - + @@ -69,7 +69,7 @@ min_priority - + A priority below which max_interval and @@ -81,16 +81,16 @@ they're enforced for events of priority 1 and above, and so on. - + &reftitle.returnvalues; - + &return.success; - + - + EventDnsBase::__construct Constructs EventDnsBase object @@ -19,9 +19,9 @@ initialize - + Constructs EventDnsBase object. - + &reftitle.parameters; @@ -31,9 +31,9 @@ base - + Event base. - + @@ -88,15 +88,15 @@ &reftitle.errors; - + If initialize has a type other than intbool, a TypeError is thrown. - - + + If the value of initialize is invalid, a EventException is thrown. - + &reftitle.changelog; diff --git a/reference/event/eventdnsbase/countnameservers.xml b/reference/event/eventdnsbase/countnameservers.xml index 360e5b798..2fcb482de 100644 --- a/reference/event/eventdnsbase/countnameservers.xml +++ b/reference/event/eventdnsbase/countnameservers.xml @@ -13,9 +13,9 @@ EventDnsBase::countNameservers - + Gets the number of configured nameservers - + &reftitle.parameters; @@ -23,11 +23,11 @@ &reftitle.returnvalues; - + Returns the number of configured nameservers(not necessarily the number of running nameservers). This is useful for double-checking whether our calls to the various nameserver configuration functions have been successful. - +
&reftitle.intro; - - A EventException is thrown when the Event extension methods + + A EventException is thrown when the Event extension methods encounter invalid user input or identify an unrecoverable error. This exception serves as a signal for developers to handle exceptional situations gracefully. - +
diff --git a/reference/event/eventhttp.xml b/reference/event/eventhttp.xml index 259fadeda..870e16fbc 100644 --- a/reference/event/eventhttp.xml +++ b/reference/event/eventhttp.xml @@ -7,9 +7,9 @@
&reftitle.intro; - + Represents HTTP server. - +
diff --git a/reference/event/eventhttp/accept.xml b/reference/event/eventhttp/accept.xml index 2662c5bbb..cefaae1cc 100644 --- a/reference/event/eventhttp/accept.xml +++ b/reference/event/eventhttp/accept.xml @@ -16,15 +16,15 @@ socket - + Makes an HTTP server accept connections on the specified socket stream or resource. The socket should be ready to accept connections. - - + + Can be called multiple times to accept connections on different sockets. - + - + To bind a socket, listen, and @@ -33,7 +33,7 @@ EventHttp::bind. EventHttp::accept is needed only if one already has a socket ready to accept connections. - + @@ -44,19 +44,19 @@ socket - + Socket resource, stream or numeric file descriptor representing a socket ready to accept connections. - + &reftitle.returnvalues; - + &return.success; - + &reftitle.examples; @@ -119,7 +119,7 @@ $signal->add(); $base->dispatch(); echo "END\n"; // We didn't close sockets, since Libevent already sets -// CLOSE_ON_FREE and CLOSE_ON_EXEC flags on the file +// CLOSE_ON_FREE and CLOSE_ON_EXEC flags on the file // descriptor associated with the sockets. ?> ]]> diff --git a/reference/event/eventhttp/addserveralias.xml b/reference/event/eventhttp/addserveralias.xml index 46cbeeedd..77342f864 100644 --- a/reference/event/eventhttp/addserveralias.xml +++ b/reference/event/eventhttp/addserveralias.xml @@ -16,9 +16,9 @@ alias - + Adds a server alias to the HTTP server object. - + &reftitle.parameters; @@ -28,18 +28,18 @@ alias - + The alias to add. - + &reftitle.returnvalues; - + &return.success; - + &reftitle.examples; diff --git a/reference/event/eventhttp/bind.xml b/reference/event/eventhttp/bind.xml index 741958ee3..5581d1454 100644 --- a/reference/event/eventhttp/bind.xml +++ b/reference/event/eventhttp/bind.xml @@ -20,13 +20,13 @@ port - + Binds an HTTP server on the specified address and port. - - + + Can be called multiple times to bind the same HTTP server to multiple different ports. - + &reftitle.parameters; @@ -36,11 +36,11 @@ address - + A string containing the IP address to listen(2) on. - + @@ -48,18 +48,18 @@ port - + The port number to listen on. - + &reftitle.returnvalues; - + &return.success; - + &reftitle.examples; diff --git a/reference/event/eventhttp/construct.xml b/reference/event/eventhttp/construct.xml index fb6c8d92a..eefa1ac0a 100644 --- a/reference/event/eventhttp/construct.xml +++ b/reference/event/eventhttp/construct.xml @@ -1,6 +1,6 @@ - + EventHttp::__construct Constructs EventHttp object (the HTTP server) @@ -20,9 +20,9 @@ &null; - + Constructs the HTTP server object. - + &reftitle.parameters; @@ -32,9 +32,9 @@ base - + Associated event base. - + @@ -42,23 +42,23 @@ ctx - + EventSslContext class object. Turns plain HTTP server into HTTPS server. It means that if ctx is configured correctly, then the underlying buffer events will be based on OpenSSL sockets. Thus, all traffic will pass through the SSL or TLS. - + - + This parameter is available only if Event is compiled with OpenSSL support and only with Libevent 2.1.0-alpha and higher. - + diff --git a/reference/event/eventhttp/removeserveralias.xml b/reference/event/eventhttp/removeserveralias.xml index efe300a19..8cd178690 100644 --- a/reference/event/eventhttp/removeserveralias.xml +++ b/reference/event/eventhttp/removeserveralias.xml @@ -16,10 +16,10 @@ alias - + Removes server alias added with EventHttp::addServerAlias - + &reftitle.parameters; @@ -29,18 +29,18 @@ alias - + The alias to remove. - + &reftitle.returnvalues; - + &return.success; - + &reftitle.seealso; diff --git a/reference/event/eventhttp/setallowedmethods.xml b/reference/event/eventhttp/setallowedmethods.xml index 780bf1ed3..b7d746699 100644 --- a/reference/event/eventhttp/setallowedmethods.xml +++ b/reference/event/eventhttp/setallowedmethods.xml @@ -20,13 +20,13 @@ Sets which HTTP methods are supported in requests accepted by this server, and passed to user callbacks - + If not supported they will generate a "405 Method not allowed" response. - - + + By default this includes the following methods: GET, POST, @@ -36,7 +36,7 @@ See EventHttpRequest::CMD_* constants. - + &reftitle.parameters; @@ -46,22 +46,22 @@ methods - + A bit mask of EventHttpRequest::CMD_* constants. - + &reftitle.returnvalues; - + &return.void; - + - + EventHttp::setCallback Sets a callback for specified URI @@ -24,9 +24,9 @@ arg - + Sets a callback for specified URI. - + &reftitle.parameters; @@ -36,9 +36,9 @@ path - + The path for which to invoke the callback. - + @@ -46,13 +46,13 @@ cb - + The callback callable that gets invoked on requested path. It should match the following prototype: - + void callback @@ -73,10 +73,10 @@ req - + EventHttpRequest object. - + @@ -84,9 +84,9 @@ arg - + Custom data. - + @@ -97,18 +97,18 @@ arg - + Custom data. - + &reftitle.returnvalues; - + &return.success; - + &reftitle.examples; diff --git a/reference/event/eventhttp/setdefaultcallback.xml b/reference/event/eventhttp/setdefaultcallback.xml index f6214c3c6..91619f46c 100644 --- a/reference/event/eventhttp/setdefaultcallback.xml +++ b/reference/event/eventhttp/setdefaultcallback.xml @@ -1,6 +1,6 @@ - + EventHttp::setDefaultCallback Sets default callback to handle requests that are not caught by specific callbacks @@ -20,10 +20,10 @@ arg - + Sets default callback to handle requests that are not caught by specific callbacks - + &reftitle.parameters; @@ -33,11 +33,11 @@ cb - + The callback callable. It should match the following prototype: - + void callback @@ -58,10 +58,10 @@ req - + EventHttpRequest object. - + @@ -69,9 +69,9 @@ arg - + Custom data. - + @@ -82,18 +82,18 @@ arg - + User custom data passed to the callback. - + &reftitle.returnvalues; - + &return.success; - + &reftitle.examples; diff --git a/reference/event/eventhttp/setmaxbodysize.xml b/reference/event/eventhttp/setmaxbodysize.xml index a6dc4a0b6..0417a7cca 100644 --- a/reference/event/eventhttp/setmaxbodysize.xml +++ b/reference/event/eventhttp/setmaxbodysize.xml @@ -16,9 +16,9 @@ value - + Sets maximum request body size. - + &reftitle.parameters; @@ -28,18 +28,18 @@ value - + The body size in bytes. - + &reftitle.returnvalues; - + &return.void; - + &reftitle.seealso; diff --git a/reference/event/eventhttp/setmaxheaderssize.xml b/reference/event/eventhttp/setmaxheaderssize.xml index 5a495361a..98d2a363a 100644 --- a/reference/event/eventhttp/setmaxheaderssize.xml +++ b/reference/event/eventhttp/setmaxheaderssize.xml @@ -16,9 +16,9 @@ value - + Sets maximum HTTP header size. - + &reftitle.parameters; @@ -28,18 +28,18 @@ value - + The header size in bytes. - + &reftitle.returnvalues; - + &return.void; - + &reftitle.seealso; diff --git a/reference/event/eventhttp/settimeout.xml b/reference/event/eventhttp/settimeout.xml index 57bf0ba1b..1b6ca7185 100644 --- a/reference/event/eventhttp/settimeout.xml +++ b/reference/event/eventhttp/settimeout.xml @@ -16,9 +16,9 @@ value - + Sets the timeout for an HTTP request. - + &reftitle.parameters; @@ -28,18 +28,18 @@ value - + The timeout in seconds. - + &reftitle.returnvalues; - + &return.void; - +
&reftitle.intro; - + Represents an HTTP connection. - +
diff --git a/reference/event/eventhttpconnection/construct.xml b/reference/event/eventhttpconnection/construct.xml index c4daf0498..92727ec22 100644 --- a/reference/event/eventhttpconnection/construct.xml +++ b/reference/event/eventhttpconnection/construct.xml @@ -1,6 +1,6 @@ - + EventHttpConnection::__construct Constructs EventHttpConnection object @@ -32,9 +32,9 @@ &null; - + Constructs EventHttpConnection object. - + &reftitle.parameters; @@ -44,9 +44,9 @@ base - + Associated event base. - + @@ -54,11 +54,11 @@ dns_base - + If dns_base is &null;, hostname resolution will block. - + @@ -66,9 +66,9 @@ address - + The address to connect to. - + @@ -76,9 +76,9 @@ port - + The port to connect to. - + @@ -86,19 +86,19 @@ ctx - + EventSslContext class object. Enables OpenSSL. - + - + This parameter is available only if Event is compiled with OpenSSL support and only with Libevent 2.1.0-alpha and higher. - + diff --git a/reference/event/eventhttpconnection/getbase.xml b/reference/event/eventhttpconnection/getbase.xml index af5b9a71e..8ce343eea 100644 --- a/reference/event/eventhttpconnection/getbase.xml +++ b/reference/event/eventhttpconnection/getbase.xml @@ -13,9 +13,9 @@ EventHttpConnection::getBase - + Returns event base associated with the connection. - + &reftitle.parameters; @@ -23,11 +23,11 @@ &reftitle.returnvalues; - + On success returns EventBase object associated with the connection. Otherwise &false;. - +
&reftitle.intro; - + Represents an HTTP request. - +
@@ -108,9 +108,9 @@ EventHttpRequest::CMD_GET - + GET method(command) - + @@ -118,9 +118,9 @@ EventHttpRequest::CMD_POST - + POST method(command) - + @@ -128,9 +128,9 @@ EventHttpRequest::CMD_HEAD - + HEAD method(command) - + @@ -138,9 +138,9 @@ EventHttpRequest::CMD_PUT - + PUT method(command) - + @@ -148,9 +148,9 @@ EventHttpRequest::CMD_DELETE - + DELETE command(method) - + @@ -158,9 +158,9 @@ EventHttpRequest::CMD_OPTIONS - + OPTIONS method(command) - + @@ -168,9 +168,9 @@ EventHttpRequest::CMD_TRACE - + TRACE method(command) - + @@ -178,9 +178,9 @@ EventHttpRequest::CMD_CONNECT - + CONNECT method(command) - + @@ -188,9 +188,9 @@ EventHttpRequest::CMD_PATCH - + PATCH method(command) - + @@ -198,9 +198,9 @@ EventHttpRequest::INPUT_HEADER - + Request input header type. - + @@ -208,9 +208,9 @@ EventHttpRequest::OUTPUT_HEADER - + Request output header type. - + diff --git a/reference/event/eventhttprequest/addheader.xml b/reference/event/eventhttprequest/addheader.xml index 87ab25beb..46797da18 100644 --- a/reference/event/eventhttprequest/addheader.xml +++ b/reference/event/eventhttprequest/addheader.xml @@ -24,9 +24,9 @@ type - + Adds an HTTP header to the headers of the request. - + &reftitle.parameters; @@ -36,9 +36,9 @@ key - + Header name. - + @@ -46,9 +46,9 @@ value - + Header value. - + @@ -56,20 +56,20 @@ type - + One of EventHttpRequest::*_HEADER constants. - + &reftitle.returnvalues; - + &return.success; - + &reftitle.seealso; diff --git a/reference/event/eventhttprequest/cancel.xml b/reference/event/eventhttprequest/cancel.xml index 0c9caf495..300799cb3 100644 --- a/reference/event/eventhttprequest/cancel.xml +++ b/reference/event/eventhttprequest/cancel.xml @@ -13,20 +13,20 @@ EventHttpRequest::cancel - + Cancels a pending HTTP request. - - + + Cancels an ongoing HTTP request. The callback associated with this request is not executed and the request object is freed. If the request is currently being processed, e.g. it is ongoing, the corresponding EventHttpConnection object is going to get reset. - - + + A request cannot be canceled if its callback has executed already. A request may be canceled reentrantly from its chunked callback. - + &reftitle.parameters; @@ -34,9 +34,9 @@ &reftitle.returnvalues; - + &return.void; - +
&reftitle.intro; - + Represents a connection listener. - +
@@ -79,11 +79,11 @@ fd - + Numeric file descriptor of the underlying socket. (Added in event-1.6.0 .) - + @@ -97,11 +97,11 @@ EventListener::OPT_LEAVE_SOCKETS_BLOCKING - + By default Libevent turns underlying file descriptors, or sockets, to non-blocking mode. This flag tells Libevent to leave them in blocking mode. - + @@ -109,12 +109,12 @@ EventListener::OPT_CLOSE_ON_FREE - + If this option is set, the connection listener closes its underlying socket when the EventListener object is freed. - + @@ -122,14 +122,14 @@ EventListener::OPT_CLOSE_ON_EXEC - + If this option is set, the connection listener sets the close-on-exec flag on the underlying listener socket. See platform documentation for fcntl and FD_CLOEXEC for more information. - + @@ -137,13 +137,13 @@ EventListener::OPT_REUSEABLE - + By default on some platforms, once a listener socket is closed, no other socket can bind to the same port until a while has passed. Setting this option makes Libevent mark the socket as reusable, so that once it is closed, another socket can be opened to listen on the same port. - + @@ -151,10 +151,10 @@ EventListener::OPT_THREADSAFE - + Allocate locks for the listener, so that it’s safe to use it from multiple threads. - + diff --git a/reference/event/eventlistener/construct.xml b/reference/event/eventlistener/construct.xml index af918584b..14c55d74b 100644 --- a/reference/event/eventlistener/construct.xml +++ b/reference/event/eventlistener/construct.xml @@ -1,6 +1,6 @@ - + EventListener::__construct Creates new connection listener associated with an event base @@ -35,9 +35,9 @@ target - + Creates new connection listener associated with an event base. - + &reftitle.parameters; @@ -47,9 +47,9 @@ base - + Associated event base. - + @@ -57,11 +57,11 @@ cb - + A callable that will be invoked when new connection received. - + @@ -69,10 +69,10 @@ data - + Custom user data attached to cb. - + @@ -80,12 +80,12 @@ flags - + Bit mask of EventListener::OPT_* constants. See EventListener constants. - + @@ -93,7 +93,7 @@ backlog - + Controls the maximum number of pending connections that the network stack should allow to wait in a not-yet-accepted state at any time; see documentation for your system’s @@ -105,7 +105,7 @@ ; if it is zero, Event assumes that listen is already called on the socket (target). - + @@ -113,7 +113,7 @@ target - + May be string, socket resource, or a stream associated with a socket. In case if target @@ -122,7 +122,7 @@ 'unix:', e.g. 'unix:/tmp/my.sock'. - + diff --git a/reference/event/eventlistener/disable.xml b/reference/event/eventlistener/disable.xml index e39fe8efb..6a66b1dc0 100644 --- a/reference/event/eventlistener/disable.xml +++ b/reference/event/eventlistener/disable.xml @@ -13,9 +13,9 @@ EventListener::disable - + Disables an event connect listener object - + &reftitle.parameters; @@ -23,9 +23,9 @@ &reftitle.returnvalues; - + &return.success; - + &reftitle.seealso; diff --git a/reference/event/eventlistener/enable.xml b/reference/event/eventlistener/enable.xml index 7ccfad89f..637cf998a 100644 --- a/reference/event/eventlistener/enable.xml +++ b/reference/event/eventlistener/enable.xml @@ -13,9 +13,9 @@ EventListener::enable - + Enables an event connect listener object - + &reftitle.parameters; @@ -23,9 +23,9 @@ &reftitle.returnvalues; - + &return.success; - + &reftitle.seealso; diff --git a/reference/event/eventlistener/getbase.xml b/reference/event/eventlistener/getbase.xml index a59202d8b..dffc8918f 100644 --- a/reference/event/eventlistener/getbase.xml +++ b/reference/event/eventlistener/getbase.xml @@ -13,9 +13,9 @@ EventListener::getBase - + Returns event base associated with the event listener. - + &reftitle.parameters; @@ -23,9 +23,9 @@ &reftitle.returnvalues; - + Returns event base associated with the event listener. - + - + EventListener::setCallback The setCallback purpose @@ -21,10 +21,10 @@ &null; - + Adjust event connect listener's callback and optionally the callback argument. - + &reftitle.parameters; @@ -34,12 +34,12 @@ cb - + The new callback for new connections. Ignored if &null;. - - + + Should match the following prototype: - + void callback @@ -70,11 +70,11 @@ listener - + The EventListener object. - + @@ -82,9 +82,9 @@ fd - + The file descriptor or a resource associated with the listener. - + @@ -92,11 +92,11 @@ address - + Array of two elements: IP address and the server port. - + @@ -104,9 +104,9 @@ arg - + User custom data attached to the callback. - + @@ -117,18 +117,18 @@ arg - + Custom user data attached to the callback. Ignored if &null;. - + &reftitle.returnvalues; - + &return.void; - + - + EventListener::setErrorCallback Set event listener's error callback @@ -16,9 +16,9 @@ cb - + Set event listener's error callback - + &reftitle.parameters; @@ -28,9 +28,9 @@ cb - + The error callback. Should match the following prototype: - + void callback @@ -51,11 +51,11 @@ listener - + The EventListener object. - + @@ -63,9 +63,9 @@ data - + User custom data attached to the callback. - + diff --git a/reference/event/eventsslcontext.xml b/reference/event/eventsslcontext.xml index 846b048bb..ddacc9c32 100644 --- a/reference/event/eventsslcontext.xml +++ b/reference/event/eventsslcontext.xml @@ -7,11 +7,11 @@
&reftitle.intro; - + Represents SSL_CTX structure. Provides methods and properties to configure the SSL context. - +
@@ -158,11 +158,11 @@ local_cert - + Path to local certificate file on filesystem. It must be a PEM-encoded file which contains certificate. It can optionally contain the certificate chain of issuers. - + @@ -170,9 +170,9 @@ local_pk - + Path to local private key file - + @@ -187,11 +187,11 @@ EventSslContext::SSLv2_CLIENT_METHOD - + SSLv2 client method. See SSL_CTX_new(3) man page. - + @@ -199,11 +199,11 @@ EventSslContext::SSLv3_CLIENT_METHOD - + SSLv3 client method. See SSL_CTX_new(3) man page. - + @@ -211,11 +211,11 @@ EventSslContext::SSLv23_CLIENT_METHOD - + SSLv23 client method. See SSL_CTX_new(3) man page. - + @@ -223,11 +223,11 @@ EventSslContext::TLS_CLIENT_METHOD - + TLS client method. See SSL_CTX_new(3) man page. - + @@ -235,11 +235,11 @@ EventSslContext::SSLv2_SERVER_METHOD - + SSLv2 server method. See SSL_CTX_new(3) man page. - + @@ -247,11 +247,11 @@ EventSslContext::SSLv3_SERVER_METHOD - + SSLv3 server method. See SSL_CTX_new(3) man page. - + @@ -259,11 +259,11 @@ EventSslContext::SSLv23_SERVER_METHOD - + SSLv23 server method. See SSL_CTX_new(3) man page. - + @@ -271,11 +271,11 @@ EventSslContext::TLS_SERVER_METHOD - + TLS server method. See SSL_CTX_new(3) man page. - + @@ -283,11 +283,11 @@ EventSslContext::OPT_LOCAL_CERT - + Key for an item of the options' array used in EventSslContext::__construct. The option points to path of local certificate. - + @@ -295,11 +295,11 @@ EventSslContext::OPT_LOCAL_PK - + Key for an item of the options' array used in EventSslContext::__construct. The option points to path of the private key. - + @@ -307,11 +307,11 @@ EventSslContext::OPT_PASSPHRASE - + Key for an item of the options' array used in EventSslContext::__construct. Represents passphrase of the certificate. - + @@ -319,11 +319,11 @@ EventSslContext::OPT_CA_FILE - + Key for an item of the options' array used in EventSslContext::__construct. Represents path of the certificate authority file. - + @@ -331,12 +331,12 @@ EventSslContext::OPT_CA_PATH - + Key for an item of the options' array used in EventSslContext::__construct. Represents path where the certificate authority file should be searched for. - + @@ -344,11 +344,11 @@ EventSslContext::OPT_ALLOW_SELF_SIGNED - + Key for an item of the options' array used in EventSslContext::__construct. Represents option that allows self-signed certificates. - + @@ -356,11 +356,11 @@ EventSslContext::OPT_VERIFY_PEER - + Key for an item of the options' array used in EventSslContext::__construct. Represents option that tells Event to verify peer. - + @@ -368,12 +368,12 @@ EventSslContext::OPT_VERIFY_DEPTH - + Key for an item of the options' array used in EventSslContext::__construct. Represents maximum depth for the certificate chain verification that shall be allowed for the SSL context. - + @@ -381,11 +381,11 @@ EventSslContext::OPT_CIPHERS - + Key for an item of the options' array used in EventSslContext::__construct. Represents the cipher list for the SSL context. - + diff --git a/reference/event/eventsslcontext/construct.xml b/reference/event/eventsslcontext/construct.xml index 673c62525..a26da83bd 100644 --- a/reference/event/eventsslcontext/construct.xml +++ b/reference/event/eventsslcontext/construct.xml @@ -19,11 +19,11 @@ options - + Creates SSL context holding pointer to SSL_CTX (see the system manual). - + &reftitle.parameters; @@ -33,11 +33,11 @@ method - + One of EventSslContext::*_METHOD constants. - + @@ -45,12 +45,12 @@ options - + Associative array of SSL context options One of EventSslContext::OPT_* constants. - + diff --git a/reference/event/eventutil.xml b/reference/event/eventutil.xml index a1ebca725..1bc25ed14 100644 --- a/reference/event/eventutil.xml +++ b/reference/event/eventutil.xml @@ -188,9 +188,9 @@ EventUtil::AF_INET - + IPv4 address family - + @@ -198,9 +198,9 @@ EventUtil::AF_INET6 - + IPv6 address family - + @@ -208,9 +208,9 @@ EventUtil::AF_UNSPEC - + Unspecified IP address family - + @@ -218,14 +218,14 @@ EventUtil::SO_DEBUG - + Socket option. Enable socket debugging. Only allowed for processes with the CAP_NET_ADMIN capability or an effective user ID of 0. (Added in event-1.6.0.) - + @@ -233,14 +233,14 @@ EventUtil::SO_REUSEADDR - + Socket option. Indicates that the rules used in validating addresses supplied in a bind(2) call should allow reuse of local addresses. See the socket(7) manual page. (Added in event-1.6.0.) - + @@ -248,12 +248,12 @@ EventUtil::SO_KEEPALIVE - + Socket option. Enable sending of keep-alive messages on connection-oriented sockets. Expects an integer boolean flag. See the socket(7) manual page. (Added in event-1.6.0.) - + @@ -261,11 +261,11 @@ EventUtil::SO_DONTROUTE - + Socket option. See the socket(7) manual page. (Added in event-1.6.0.) - + @@ -273,7 +273,7 @@ EventUtil::SO_LINGER - + Socket option. When enabled, a close(2) or @@ -284,7 +284,7 @@ See the socket(7) manual page. (Added in event-1.6.0.) - + @@ -292,12 +292,12 @@ EventUtil::SO_BROADCAST - + Socket option. Reports whether transmission of broadcast messages is supported. See the socket(7) manual page. (Added in event-1.6.0.) - + @@ -305,11 +305,11 @@ EventUtil::SO_OOBINLINE - + Socket option. See the socket(7) manual page. (Added in event-1.6.0.) - + @@ -317,11 +317,11 @@ EventUtil::SO_SNDBUF - + Socket option. See the socket(7) manual page. (Added in event-1.6.0.) - + @@ -329,11 +329,11 @@ EventUtil::SO_RCVBUF - + Socket option. See the socket(7) manual page. (Added in event-1.6.0.) - + @@ -341,11 +341,11 @@ EventUtil::SO_SNDLOWAT - + Socket option. See the socket(7) manual page. (Added in event-1.6.0.) - + @@ -353,11 +353,11 @@ EventUtil::SO_RCVLOWAT - + Socket option. See the socket(7) manual page. (Added in event-1.6.0.) - + @@ -365,11 +365,11 @@ EventUtil::SO_SNDTIMEO - + Socket option. See the socket(7) manual page. (Added in event-1.6.0.) - + @@ -377,11 +377,11 @@ EventUtil::SO_RCVTIMEO - + Socket option. See the socket(7) manual page. (Added in event-1.6.0.) - + @@ -389,11 +389,11 @@ EventUtil::SO_TYPE - + Socket option. See the socket(7) manual page. (Added in event-1.6.0.) - + @@ -401,11 +401,11 @@ EventUtil::SO_ERROR - + Socket option. See the socket(7) manual page. (Added in event-1.6.0.) - + @@ -413,11 +413,11 @@ EventUtil::SOL_SOCKET - + Socket option level. See the socket(7) manual page. (Added in event-1.6.0.) - + @@ -425,11 +425,11 @@ EventUtil::SOL_TCP - + Socket option level. See the socket(7) manual page. (Added in event-1.6.0.) - + @@ -437,11 +437,11 @@ EventUtil::SOL_UDP - + Socket option level. See the socket(7) manual page. (Added in event-1.6.0.) - + @@ -449,11 +449,11 @@ EventUtil::IPPROTO_IP - + See the socket(7) manual page. (Added in event-1.6.0.) - + @@ -461,11 +461,11 @@ EventUtil::IPPROTO_IPV6 - + See the socket(7) manual page. (Added in event-1.6.0.) - + @@ -473,10 +473,10 @@ EventUtil::LIBEVENT_VERSION_NUMBER - + Libevent' version number at the time when Event extension had been compiled with the library. - + diff --git a/reference/event/eventutil/construct.xml b/reference/event/eventutil/construct.xml index b3a0d36e0..758db302a 100644 --- a/reference/event/eventutil/construct.xml +++ b/reference/event/eventutil/construct.xml @@ -13,11 +13,11 @@ EventUtil::__construct - + EventUtil is a singleton. Therefore the constructor is abstract, and it is impossible to create objects based on this class. - + &reftitle.parameters; diff --git a/reference/event/eventutil/getlastsocketerrno.xml b/reference/event/eventutil/getlastsocketerrno.xml index 5c6685bb9..0275ad065 100644 --- a/reference/event/eventutil/getlastsocketerrno.xml +++ b/reference/event/eventutil/getlastsocketerrno.xml @@ -19,11 +19,11 @@ &null; - + Returns the most recent socket error number( errno ). - + &reftitle.parameters; @@ -33,20 +33,20 @@ socket - + Socket resource, stream or a file descriptor of a socket. - + &reftitle.returnvalues; - + Returns the most recent socket error number( errno ). - + &reftitle.seealso; diff --git a/reference/event/eventutil/getlastsocketerror.xml b/reference/event/eventutil/getlastsocketerror.xml index 87e033b1c..6f56eb45f 100644 --- a/reference/event/eventutil/getlastsocketerror.xml +++ b/reference/event/eventutil/getlastsocketerror.xml @@ -17,9 +17,9 @@ socket - + Returns the most recent socket error. - + &reftitle.parameters; @@ -29,18 +29,18 @@ socket - + Socket resource, stream or a file descriptor of a socket. - + &reftitle.returnvalues; - + Returns the most recent socket error. - + &reftitle.seealso; diff --git a/reference/event/eventutil/getsocketfd.xml b/reference/event/eventutil/getsocketfd.xml index 917f9c4c9..52bfe8884 100644 --- a/reference/event/eventutil/getsocketfd.xml +++ b/reference/event/eventutil/getsocketfd.xml @@ -17,14 +17,14 @@ socket - + Returns numeric file descriptor of a socket or stream specified by socket argument just like the Event extension does it internally for all methods accepting socket resource or stream. - + &reftitle.parameters; @@ -34,23 +34,23 @@ socket - + Socket resource or stream. - + &reftitle.returnvalues; - + Returns numeric file descriptor of a socket, or stream. EventUtil::getSocketFd returns &false; in case if it is whether failed to recognize the type of the underlying file, or detected that the file descriptor associated with socket is not valid. - + - + Expect diff --git a/reference/expect/configure.xml b/reference/expect/configure.xml index 013a9b2b8..f2993318e 100644 --- a/reference/expect/configure.xml +++ b/reference/expect/configure.xml @@ -1,6 +1,6 @@ -
+
&reftitle.install; &pecl.moved; diff --git a/reference/expect/examples.xml b/reference/expect/examples.xml index 816647900..f49a21f09 100644 --- a/reference/expect/examples.xml +++ b/reference/expect/examples.xml @@ -1,6 +1,6 @@ - + &reftitle.examples;
Expect Usage Examples diff --git a/reference/expect/functions/expect-expectl.xml b/reference/expect/functions/expect-expectl.xml index 62107912a..233ef4db0 100644 --- a/reference/expect/functions/expect-expectl.xml +++ b/reference/expect/functions/expect-expectl.xml @@ -1,6 +1,6 @@ - + expect_expectl Waits until the output from a process matches one diff --git a/reference/expect/functions/expect-popen.xml b/reference/expect/functions/expect-popen.xml index ae96a0228..5bdabdb34 100644 --- a/reference/expect/functions/expect-popen.xml +++ b/reference/expect/functions/expect-popen.xml @@ -1,6 +1,6 @@ - + expect_popen Execute command via Bourne shell, and open the PTY stream to diff --git a/reference/expect/ini.xml b/reference/expect/ini.xml index cdebc6849..0d6126fa4 100644 --- a/reference/expect/ini.xml +++ b/reference/expect/ini.xml @@ -1,6 +1,6 @@ -
+
&reftitle.runtime; &extension.runtime; diff --git a/reference/expect/setup.xml b/reference/expect/setup.xml index dc7b5b1de..c3504e62b 100644 --- a/reference/expect/setup.xml +++ b/reference/expect/setup.xml @@ -1,6 +1,6 @@ - + &reftitle.setup; diff --git a/reference/fann/book.xml b/reference/fann/book.xml index 2f0a02168..28f8635da 100644 --- a/reference/fann/book.xml +++ b/reference/fann/book.xml @@ -8,12 +8,12 @@ &reftitle.intro; - + PHP binding for FANN (Fast Artificial Neural Network) Library which implements multilayer artificial neural networks with support for both fully connected and sparsely connected networks. It includes a framework for easy handling of training data sets. It is easy to use, versatile, well documented, and fast. - + &reference.fann.setup; diff --git a/reference/fann/configure.xml b/reference/fann/configure.xml index 60beca5d9..d8789bb0d 100644 --- a/reference/fann/configure.xml +++ b/reference/fann/configure.xml @@ -4,10 +4,10 @@
&reftitle.install; - + &pecl.info; &url.pecl.package;fann - +
diff --git a/reference/fann/fannconnection.xml b/reference/fann/fannconnection.xml index 38e495f14..c8b494ea1 100644 --- a/reference/fann/fannconnection.xml +++ b/reference/fann/fannconnection.xml @@ -11,10 +11,10 @@
&reftitle.intro; - + FANNConnection is used for the neural network connection. The objects of this class are used in fann_get_connection_array and fann_set_weight_array. - +
@@ -63,19 +63,19 @@ from_neuron - The neuron where the connection starts. + The neuron where the connection starts. to_neuron - The neuron where the connection ends. + The neuron where the connection ends. weight - The weight of the connection. + The weight of the connection. diff --git a/reference/fann/fannconnection/construct.xml b/reference/fann/fannconnection/construct.xml index aac25fa61..99a15b6c1 100644 --- a/reference/fann/fannconnection/construct.xml +++ b/reference/fann/fannconnection/construct.xml @@ -15,9 +15,9 @@ intto_neuron floatweight - + Create new connection and initialize its params. After creating the connection, only weight can be changed. - + @@ -26,25 +26,25 @@ from_neuron - + The position number of starting neuron. - + to_neuron - + The position number of terminating neuron. - + weight - + The connection weight value. - + diff --git a/reference/fann/fannconnection/gettoneuron.xml b/reference/fann/fannconnection/gettoneuron.xml index ab2aaa6d8..da9a2c8a9 100644 --- a/reference/fann/fannconnection/gettoneuron.xml +++ b/reference/fann/fannconnection/gettoneuron.xml @@ -13,9 +13,9 @@ public intFANNConnection::getToNeuron - + Returns the positions of terminating neuron. - + diff --git a/reference/fann/fannconnection/getweight.xml b/reference/fann/fannconnection/getweight.xml index 7eb99699b..d5ddb1e06 100644 --- a/reference/fann/fannconnection/getweight.xml +++ b/reference/fann/fannconnection/getweight.xml @@ -13,9 +13,9 @@ public voidFANNConnection::getWeight - + Returns the connection weight. - + @@ -25,9 +25,9 @@ &reftitle.returnvalues; - + The connection weight. - + diff --git a/reference/fann/fannconnection/setweight.xml b/reference/fann/fannconnection/setweight.xml index c8a54431e..55eebd15f 100644 --- a/reference/fann/fannconnection/setweight.xml +++ b/reference/fann/fannconnection/setweight.xml @@ -13,14 +13,14 @@ public voidFANNConnection::setWeight floatweight - + Sets the connection weight. - - + + This method is different than fann_set_weight. It does not update the weight value in the network. The network value is updated only after calling fann_set_weight_array. - + @@ -30,9 +30,9 @@ weight - + The connection weight. - + diff --git a/reference/fann/functions/fann-cascadetrain-on-data.xml b/reference/fann/functions/fann-cascadetrain-on-data.xml index c9c359d7f..c4e956a0e 100644 --- a/reference/fann/functions/fann-cascadetrain-on-data.xml +++ b/reference/fann/functions/fann-cascadetrain-on-data.xml @@ -17,18 +17,18 @@ intneurons_between_reports floatdesired_error - + The cascade output change fraction is a number between 0 and 1 determining how large a fraction the fann_get_MSE value should change within fann_get_cascade_output_stagnation_epochs during training of the output connections, in order for the training not to stagnate. If the training stagnates, the training of the output connections will be ended and new candidates will be prepared. - - + + This training uses the parameters set using the fann_set_cascade_..., but it also uses another training algorithm as it’s internal training algorithm. This algorithm can be set to either FANN_TRAIN_RPROP or FANN_TRAIN_QUICKPROP by fann_set_training_algorithm, and the parameters set for these training algorithms will also affect the cascade training. - + @@ -49,26 +49,26 @@ max_neurons - + The maximum number of neurons to be added to neural network. - + neurons_between_reports - + The number of neurons between printing a status report. A value of zero means no reports should be printed. - + desired_error - + The desired fann_get_MSE or fann_get_bit_fail, depending on which stop function is chosen by fann_set_train_stop_function - + diff --git a/reference/fann/functions/fann-cascadetrain-on-file.xml b/reference/fann/functions/fann-cascadetrain-on-file.xml index 9c1b97833..295aa0e7d 100644 --- a/reference/fann/functions/fann-cascadetrain-on-file.xml +++ b/reference/fann/functions/fann-cascadetrain-on-file.xml @@ -17,9 +17,9 @@ intneurons_between_reports floatdesired_error - + Does the same as fann_cascadetrain_on_data, but reads the training data directly from a file. - + @@ -34,34 +34,34 @@ filename - - A file containing the data for training. - + + A file containing the data for training. + max_neurons - + The maximum number of neurons to be added to neural network - + neurons_between_reports - + The number of neurons between printing a status report. A value of zero means no reports should be printed. - + desired_error - + The desired fann_get_MSE or fann_get_bit_fail, depending on which stop function is chosen by fann_set_train_stop_function. - + diff --git a/reference/fann/functions/fann-clear-scaling-params.xml b/reference/fann/functions/fann-clear-scaling-params.xml index 8ee61b474..5bd8bae51 100644 --- a/reference/fann/functions/fann-clear-scaling-params.xml +++ b/reference/fann/functions/fann-clear-scaling-params.xml @@ -13,9 +13,9 @@ boolfann_clear_scaling_params resourceann - + Clears scaling parameters. - + diff --git a/reference/fann/functions/fann-copy.xml b/reference/fann/functions/fann-copy.xml index 2a518ac14..7bc756145 100644 --- a/reference/fann/functions/fann-copy.xml +++ b/reference/fann/functions/fann-copy.xml @@ -13,9 +13,9 @@ resourcefann_copy resourceann - + Creates a copy of a fann structure. - + @@ -32,9 +32,9 @@ &reftitle.returnvalues; - + Returns a copy of neural network resource on success, or &false; on error - + diff --git a/reference/fann/functions/fann-create-from-file.xml b/reference/fann/functions/fann-create-from-file.xml index f35844997..3fb789914 100644 --- a/reference/fann/functions/fann-create-from-file.xml +++ b/reference/fann/functions/fann-create-from-file.xml @@ -13,9 +13,9 @@ resourcefann_create_from_file stringconfiguration_file - + Constructs a backpropagation neural network from a configuration file, which have been saved by fann_save. - + @@ -24,9 +24,9 @@ configuration_file - + The configuration file path. - + diff --git a/reference/fann/functions/fann-create-shortcut-array.xml b/reference/fann/functions/fann-create-shortcut-array.xml index 2943e98c6..2cd3423aa 100644 --- a/reference/fann/functions/fann-create-shortcut-array.xml +++ b/reference/fann/functions/fann-create-shortcut-array.xml @@ -25,17 +25,17 @@ num_layers - + The total number of layers including the input and the output layer. - + layers - + An array of layers sizes. - + @@ -43,9 +43,9 @@ &reftitle.returnvalues; - + Returns a neural network resource on success, or &false; on error. - + diff --git a/reference/fann/functions/fann-create-shortcut.xml b/reference/fann/functions/fann-create-shortcut.xml index 734727e43..86a1df02a 100644 --- a/reference/fann/functions/fann-create-shortcut.xml +++ b/reference/fann/functions/fann-create-shortcut.xml @@ -16,13 +16,13 @@ intnum_neurons2 intnum_neuronsN - + Creates a standard backpropagation neural network, which is not fully connected and which also has shortcut connections. - - + + Shortcut connections are connections that skip layers. A fully connected network with shortcut connections, is a network where all neurons are connected to all neurons in later layers. Including direct connections from the input layer to the output layer. - + @@ -31,33 +31,33 @@ num_layers - + The total number of layers including the input and the output layer. - + num_neurons1 - + Number of neurons in the first layer. - + num_neurons2 - + Number of neurons in the second layer. - + num_neuronsN - + Number of neurons in other layers. - + @@ -65,9 +65,9 @@ &reftitle.returnvalues; - + Returns a neural network resource on success, or &false; on error. - + diff --git a/reference/fann/functions/fann-create-sparse-array.xml b/reference/fann/functions/fann-create-sparse-array.xml index 575b67f5a..8588019b3 100644 --- a/reference/fann/functions/fann-create-sparse-array.xml +++ b/reference/fann/functions/fann-create-sparse-array.xml @@ -15,9 +15,9 @@ intnum_layers arraylayers - + Creates a standard backpropagation neural network, which is not fully connected using an array of layer sizes. - + @@ -26,27 +26,27 @@ connection_rate - + The connection rate controls how many connections there will be in the network. If the connection rate is set to 1, the network will be fully connected, but if it is set to 0.5 only half of the connections will be set. A connection rate of 1 will yield the same result as fann_create_standard. - + num_layers - + The total number of layers including the input and the output layer. - + layers - + An array of layer sizes. - + @@ -54,9 +54,9 @@ &reftitle.returnvalues; - + Returns a neural network resource on success, or &false; on error. - + diff --git a/reference/fann/functions/fann-create-sparse.xml b/reference/fann/functions/fann-create-sparse.xml index 89e8019a6..9536ebefe 100644 --- a/reference/fann/functions/fann-create-sparse.xml +++ b/reference/fann/functions/fann-create-sparse.xml @@ -17,9 +17,9 @@ intnum_neurons2 intnum_neuronsN - + Creates a standard backpropagation neural network, which is not fully connected. - + @@ -28,43 +28,43 @@ connection_rate - + The connection rate controls how many connections there will be in the network. If the connection rate is set to 1, the network will be fully connected, but if it is set to 0.5 only half of the connections will be set. A connection rate of 1 will yield the same result as fann_create_standard. - + num_layers - + The total number of layers including the input and the output layer. - + num_neurons1 - + Number of neurons in the first layer. - + num_neurons2 - + Number of neurons in the second layer. - + num_neuronsN - + Number of neurons in other layers. - + @@ -72,9 +72,9 @@ &reftitle.returnvalues; - + Returns a neural network resource on success, or &false; on error. - + diff --git a/reference/fann/functions/fann-create-standard-array.xml b/reference/fann/functions/fann-create-standard-array.xml index adc34ed03..23cd7838e 100644 --- a/reference/fann/functions/fann-create-standard-array.xml +++ b/reference/fann/functions/fann-create-standard-array.xml @@ -14,17 +14,17 @@ intnum_layers arraylayers - + Creates a standard fully connected backpropagation neural network. - - + + There will be a bias neuron in each layer (except the output layer), and this bias neuron will be connected to all neurons in the next layer. When running the network, the bias nodes always emits 1. - - + + To destroy a neural network use the fann_destroy function. - + @@ -33,17 +33,17 @@ num_layers - + The total number of layers including the input and the output layer. - + layers - + An array of layer sizes. - + @@ -51,9 +51,9 @@ &reftitle.returnvalues; - + Returns a neural network resource on success, or &false; on error. - + diff --git a/reference/fann/functions/fann-create-standard.xml b/reference/fann/functions/fann-create-standard.xml index 1f10a8c07..889339796 100644 --- a/reference/fann/functions/fann-create-standard.xml +++ b/reference/fann/functions/fann-create-standard.xml @@ -16,17 +16,17 @@ intnum_neurons2 intnum_neuronsN - + Creates a standard fully connected backpropagation neural network. - - + + There will be a bias neuron in each layer (except the output layer), and this bias neuron will be connected to all neurons in the next layer. When running the network, the bias nodes always emits 1. - - + + To destroy a neural network use the fann_destroy function. - + @@ -35,33 +35,33 @@ num_layers - + The total number of layers including the input and the output layer. - + num_neurons1 - + Number of neurons in the first layer. - + num_neurons2 - + Number of neurons in the second layer. - + num_neuronsN - + Number of neurons in other layers. - + @@ -69,9 +69,9 @@ &reftitle.returnvalues; - + Returns a neural network resource on success, or &false; on error. - + diff --git a/reference/fann/functions/fann-create-train-from-callback.xml b/reference/fann/functions/fann-create-train-from-callback.xml index 49d1860cb..7ad9c09ea 100644 --- a/reference/fann/functions/fann-create-train-from-callback.xml +++ b/reference/fann/functions/fann-create-train-from-callback.xml @@ -16,10 +16,10 @@ intnum_output callableuser_function - + Creates the training data struct from a user supplied function. As the training data are numerable (data 1, data 2...), the user must write a function that receives the number of the training data set (input, output) and returns the set. - + @@ -28,25 +28,25 @@ num_data - + The number of training data - + num_input - + The number of inputs per training data - + num_output - + The number of outputs per training data - + @@ -60,10 +60,10 @@ num_output - The number of outputs per training data - + The function should return an associative array with keys input and output and two array values of input and output. - + diff --git a/reference/fann/functions/fann-create-train.xml b/reference/fann/functions/fann-create-train.xml index 3ff6c5bef..0ad3971a7 100644 --- a/reference/fann/functions/fann-create-train.xml +++ b/reference/fann/functions/fann-create-train.xml @@ -15,9 +15,9 @@ intnum_input intnum_output - + Creates an empty training data struct. - + @@ -26,25 +26,25 @@ num_data - + The number of training data - + num_input - + The number of inputs per training data - + num_output - + The number of outputs per training data - + diff --git a/reference/fann/functions/fann-descale-input.xml b/reference/fann/functions/fann-descale-input.xml index 78c37cabb..c89988ae5 100644 --- a/reference/fann/functions/fann-descale-input.xml +++ b/reference/fann/functions/fann-descale-input.xml @@ -14,9 +14,9 @@ resourceann arrayinput_vector - + Scale data in input vector after get it from ann based on previously calculated parameters. - + @@ -31,9 +31,9 @@ input_vector - + Input vector that will be descaled - + diff --git a/reference/fann/functions/fann-descale-output.xml b/reference/fann/functions/fann-descale-output.xml index 6be803790..c027f74cc 100644 --- a/reference/fann/functions/fann-descale-output.xml +++ b/reference/fann/functions/fann-descale-output.xml @@ -14,9 +14,9 @@ resourceann arrayoutput_vector - + Scale data in output vector after get it from ann based on previously calculated parameters. - + @@ -31,9 +31,9 @@ output_vector - + Output vector that will be descaled - + diff --git a/reference/fann/functions/fann-descale-train.xml b/reference/fann/functions/fann-descale-train.xml index 492208a85..723122e90 100644 --- a/reference/fann/functions/fann-descale-train.xml +++ b/reference/fann/functions/fann-descale-train.xml @@ -14,9 +14,9 @@ resourceann resourcetrain_data - + Descale input and output data based on previously calculated parameters. - + diff --git a/reference/fann/functions/fann-destroy-train.xml b/reference/fann/functions/fann-destroy-train.xml index 809693996..7b09c5c8c 100644 --- a/reference/fann/functions/fann-destroy-train.xml +++ b/reference/fann/functions/fann-destroy-train.xml @@ -13,9 +13,9 @@ boolfann_destroy_train resourcetrain_data - + Destructs the training data - + diff --git a/reference/fann/functions/fann-destroy.xml b/reference/fann/functions/fann-destroy.xml index 781fc2a8e..8d3431171 100644 --- a/reference/fann/functions/fann-destroy.xml +++ b/reference/fann/functions/fann-destroy.xml @@ -13,9 +13,9 @@ boolfann_destroy resourceann - + Destroys the entire network and properly freeing all the associated memory. - + diff --git a/reference/fann/functions/fann-duplicate-train-data.xml b/reference/fann/functions/fann-duplicate-train-data.xml index cfc7c3135..96d303c41 100644 --- a/reference/fann/functions/fann-duplicate-train-data.xml +++ b/reference/fann/functions/fann-duplicate-train-data.xml @@ -13,9 +13,9 @@ resourcefann_duplicate_train_data resourcedata - + Returns an exact copy of a fann train data resource. - + diff --git a/reference/fann/functions/fann-get-activation-function.xml b/reference/fann/functions/fann-get-activation-function.xml index 2cc6a3e73..ae9b01240 100644 --- a/reference/fann/functions/fann-get-activation-function.xml +++ b/reference/fann/functions/fann-get-activation-function.xml @@ -15,16 +15,16 @@ intlayer intneuron - + Get the activation function for neuron number neuron in layer number layer, counting the input layer as layer 0. - - + + It is not possible to get activation functions for the neurons in the input layer. - - + + The return value is one of the activation functions constants. - + @@ -39,17 +39,17 @@ layer - + Layer number. - + neuron - + Neuron number. - + diff --git a/reference/fann/functions/fann-get-activation-steepness.xml b/reference/fann/functions/fann-get-activation-steepness.xml index 144202bc5..13d13a146 100644 --- a/reference/fann/functions/fann-get-activation-steepness.xml +++ b/reference/fann/functions/fann-get-activation-steepness.xml @@ -15,24 +15,24 @@ intlayer intneuron - + Get the activation steepness for neuron number neuron in layer number layer, counting the input layer as layer 0. - - + + It is not possible to get activation steepness for the neurons in the input layer. - - + + The steepness of an activation function says something about how fast the activation function goes from the minimum to the maximum. A high value for the activation function will also give a more aggressive training. - - + + When training neural networks where the output values should be at the extremes (usually 0 and 1, depending on the activation function), a steep activation function can be used (e.g. 1.0). - - + + The default activation steepness is 0.5. - + @@ -47,17 +47,17 @@ layer - + Layer number - + neuron - + Neuron number - + @@ -65,9 +65,9 @@ &reftitle.returnvalues; - + The activation steepness for the neuron or -1 if the neuron is not defined in the neural network, or &false; on error. - + diff --git a/reference/fann/functions/fann-get-bias-array.xml b/reference/fann/functions/fann-get-bias-array.xml index 3cf70f0b5..6ca9cba03 100644 --- a/reference/fann/functions/fann-get-bias-array.xml +++ b/reference/fann/functions/fann-get-bias-array.xml @@ -13,9 +13,9 @@ arrayfann_get_bias_array resourceann - + Get the number of bias in each layer in the network. - + @@ -32,9 +32,9 @@ &reftitle.returnvalues; - + An array of numbers of bias in each layer - + diff --git a/reference/fann/functions/fann-get-bit-fail-limit.xml b/reference/fann/functions/fann-get-bit-fail-limit.xml index c1bc09a4c..fb51c576c 100644 --- a/reference/fann/functions/fann-get-bit-fail-limit.xml +++ b/reference/fann/functions/fann-get-bit-fail-limit.xml @@ -13,22 +13,22 @@ floatfann_get_bit_fail_limit resourceann - + Returns the bit fail limit used during training. - - + + The bit fail limit is used during training where the stop function is set to FANN_STOPFUNC_BIT. - - + + The limit is the maximum accepted difference between the desired output and the actual output during training. Each output that diverges more than this limit is counted as an error bit. This difference is divided by two when dealing with symmetric activation functions, so that symmetric and not symmetric activation functions can use the same limit. - - + + The default bit fail limit is 0.35. - + @@ -45,9 +45,9 @@ &reftitle.returnvalues; - + The bit fail limit, or &false; on error. - + diff --git a/reference/fann/functions/fann-get-bit-fail.xml b/reference/fann/functions/fann-get-bit-fail.xml index 54a211084..ca028e362 100644 --- a/reference/fann/functions/fann-get-bit-fail.xml +++ b/reference/fann/functions/fann-get-bit-fail.xml @@ -13,15 +13,15 @@ intfann_get_bit_fail resourceann - + The number of fail bits; means the number of output neurons which differ more than the bit fail limit (see fann_get_bit_fail_limit, fann_set_bit_fail_limit). The bits are counted in all of the training data, so this number can be higher than the number of training data. - - + + This value is reset by fann_reset_MSE and updated by all the same functions which also updates the MSE value (e.g. fann_test_data, fann_train_epoch) - + @@ -38,9 +38,9 @@ &reftitle.returnvalues; - + The number of bits fail, or &false; on error. - + diff --git a/reference/fann/functions/fann-get-cascade-activation-functions-count.xml b/reference/fann/functions/fann-get-cascade-activation-functions-count.xml index c40e4778c..2d5f27fe3 100644 --- a/reference/fann/functions/fann-get-cascade-activation-functions-count.xml +++ b/reference/fann/functions/fann-get-cascade-activation-functions-count.xml @@ -13,12 +13,12 @@ intfann_get_cascade_activation_functions_count resourceann - + The number of activation functions in the fann_get_cascade_activation_functions array. - - + + The default number of activation functions is 6. - + @@ -35,9 +35,9 @@ &reftitle.returnvalues; - + The number of cascade activation functions, or &false; on error. - + diff --git a/reference/fann/functions/fann-get-cascade-activation-functions.xml b/reference/fann/functions/fann-get-cascade-activation-functions.xml index 31a07e183..3d6a46a29 100644 --- a/reference/fann/functions/fann-get-cascade-activation-functions.xml +++ b/reference/fann/functions/fann-get-cascade-activation-functions.xml @@ -13,17 +13,17 @@ arrayfann_get_cascade_activation_functions resourceann - + The cascade activation functions array is an array of the different activation functions used by the candidates - - + + See fann_get_cascade_num_candidates for a description of which candidate neurons will be generated by this array. - - + + The default activation functions are FANN_SIGMOID, FANN_SIGMOID_SYMMETRIC, FANN_GAUSSIAN, FANN_GAUSSIAN_SYMMETRIC, FANN_ELLIOT, FANN_ELLIOT_SYMMETRIC. - + @@ -40,9 +40,9 @@ &reftitle.returnvalues; - + The cascade activation functions, or &false; on error. - + diff --git a/reference/fann/functions/fann-get-cascade-activation-steepnesses-count.xml b/reference/fann/functions/fann-get-cascade-activation-steepnesses-count.xml index 396aca1c8..11d4248cc 100644 --- a/reference/fann/functions/fann-get-cascade-activation-steepnesses-count.xml +++ b/reference/fann/functions/fann-get-cascade-activation-steepnesses-count.xml @@ -13,12 +13,12 @@ intfann_get_cascade_activation_steepnesses_count resourceann - + The number of activation steepnesses in the fann_get_cascade_activation_functions array. - - + + The default number of activation steepnesses is 4. - + @@ -35,9 +35,9 @@ &reftitle.returnvalues; - + The number of activation steepnesses, or &false; on error. - + diff --git a/reference/fann/functions/fann-get-cascade-activation-steepnesses.xml b/reference/fann/functions/fann-get-cascade-activation-steepnesses.xml index ad42c7a83..a04cafded 100644 --- a/reference/fann/functions/fann-get-cascade-activation-steepnesses.xml +++ b/reference/fann/functions/fann-get-cascade-activation-steepnesses.xml @@ -13,15 +13,15 @@ arrayfann_get_cascade_activation_steepnesses resourceann - + The cascade activation steepnesses array is an array of the different activation functions used by the candidates. - - + + See fann_get_cascade_num_candidates for a description of which candidate neurons will be generated by this array. - - + + The default activation steepnesses are {0.25, 0.50, 0.75, 1.00}. - + @@ -38,9 +38,9 @@ &reftitle.returnvalues; - + The cascade activation steepnesses, or &false; on error. - + diff --git a/reference/fann/functions/fann-get-cascade-candidate-change-fraction.xml b/reference/fann/functions/fann-get-cascade-candidate-change-fraction.xml index aa28b5cfe..31ba0b160 100644 --- a/reference/fann/functions/fann-get-cascade-candidate-change-fraction.xml +++ b/reference/fann/functions/fann-get-cascade-candidate-change-fraction.xml @@ -13,20 +13,20 @@ floatfann_get_cascade_candidate_change_fraction resourceann - + The cascade candidate change fraction is a number between 0 and 1 determining how large a fraction the fann_get_MSE value should change within fann_get_cascade_candidate_stagnation_epochs during training of the candidate neurons, in order for the training not to stagnate. If the training stagnates, the training of the candidate neurons will be ended and the best candidate will be selected. - - + + It means that if the MSE does not change by a fraction of fann_get_cascade_candidate_change_fraction during a period of fann_get_cascade_candidate_stagnation_epochs, the training of the candidate neurons is stopped because the training has stagnated. - - + + If the cascade candidate change fraction is low, the candidate neurons will be trained more and if the fraction is high they will be trained less. - + The default cascade candidate change fraction is 0.01, which is equivalent to a 1% change in MSE. @@ -46,9 +46,9 @@ &reftitle.returnvalues; - + The cascade candidate change fraction, or &false; on error. - + diff --git a/reference/fann/functions/fann-get-cascade-candidate-limit.xml b/reference/fann/functions/fann-get-cascade-candidate-limit.xml index 06829b921..10f539fe2 100644 --- a/reference/fann/functions/fann-get-cascade-candidate-limit.xml +++ b/reference/fann/functions/fann-get-cascade-candidate-limit.xml @@ -13,16 +13,16 @@ floatfann_get_cascade_candidate_limit resourceann - + The candidate limit is a limit for how much the candidate neuron may be trained. The limit is a limit on the proportion between the MSE and candidate score. - - + + Set this to a lower value to avoid overfitting and to a higher if overfitting is not a problem. - - + + The default candidate limit is 1000.0. - + @@ -39,9 +39,9 @@ &reftitle.returnvalues; - + The candidate limit, or &false; on error. - + diff --git a/reference/fann/functions/fann-get-cascade-candidate-stagnation-epochs.xml b/reference/fann/functions/fann-get-cascade-candidate-stagnation-epochs.xml index ae98c4b6a..ad51f5f1d 100644 --- a/reference/fann/functions/fann-get-cascade-candidate-stagnation-epochs.xml +++ b/reference/fann/functions/fann-get-cascade-candidate-stagnation-epochs.xml @@ -13,16 +13,16 @@ intfann_get_cascade_candidate_stagnation_epochs resourceann - + The number of cascade candidate stagnation epochs determines the number of epochs training is allowed to continue without changing the MSE by a fraction of fann_get_cascade_candidate_change_fraction. - - + + See more info about this parameter in fann_get_cascade_candidate_change_fraction. - - + + The default number of cascade candidate stagnation epochs is 12. - + @@ -39,9 +39,9 @@ &reftitle.returnvalues; - + The number of cascade candidate stagnation epochs, or &false; on error. - + diff --git a/reference/fann/functions/fann-get-cascade-max-cand-epochs.xml b/reference/fann/functions/fann-get-cascade-max-cand-epochs.xml index 748774231..84b481ab2 100644 --- a/reference/fann/functions/fann-get-cascade-max-cand-epochs.xml +++ b/reference/fann/functions/fann-get-cascade-max-cand-epochs.xml @@ -13,13 +13,13 @@ intfann_get_cascade_max_cand_epochs resourceann - + The maximum candidate epochs determines the maximum number of epochs the input connections to the candidates may be trained before adding a new candidate neuron. - - + + The default max candidate epochs is 150. - + @@ -36,9 +36,9 @@ &reftitle.returnvalues; - + The maximum candidate epochs, or &false; on error. - + diff --git a/reference/fann/functions/fann-get-cascade-max-out-epochs.xml b/reference/fann/functions/fann-get-cascade-max-out-epochs.xml index 13bf56d74..0fe656f65 100644 --- a/reference/fann/functions/fann-get-cascade-max-out-epochs.xml +++ b/reference/fann/functions/fann-get-cascade-max-out-epochs.xml @@ -13,13 +13,13 @@ intfann_get_cascade_max_out_epochs resourceann - + The maximum out epochs determines the maximum number of epochs the output connections may be trained after adding a new candidate neuron. - - + + The default max out epochs is 150. - + @@ -36,9 +36,9 @@ &reftitle.returnvalues; - + The maximum out epochs, or &false; on error. - + diff --git a/reference/fann/functions/fann-get-cascade-min-cand-epochs.xml b/reference/fann/functions/fann-get-cascade-min-cand-epochs.xml index 2460f5cba..ee3118b18 100644 --- a/reference/fann/functions/fann-get-cascade-min-cand-epochs.xml +++ b/reference/fann/functions/fann-get-cascade-min-cand-epochs.xml @@ -13,13 +13,13 @@ intfann_get_cascade_min_cand_epochs resourceann - + The minimum candidate epochs determines the minimum number of epochs the input connections to the candidates may be trained before adding a new candidate neuron. - - + + The default min candidate epochs is 50. - + @@ -36,9 +36,9 @@ &reftitle.returnvalues; - + The minimum candidate epochs, or &false; on error. - + diff --git a/reference/fann/functions/fann-get-cascade-min-out-epochs.xml b/reference/fann/functions/fann-get-cascade-min-out-epochs.xml index c95413674..c3cfcba8e 100644 --- a/reference/fann/functions/fann-get-cascade-min-out-epochs.xml +++ b/reference/fann/functions/fann-get-cascade-min-out-epochs.xml @@ -13,13 +13,13 @@ intfann_get_cascade_min_out_epochs resourceann - + The minimum out epochs determines the minimum number of epochs the output connections must be trained after adding a new candidate neuron. - - + + The default min out epochs is 50. - + @@ -36,9 +36,9 @@ &reftitle.returnvalues; - + The minimum out epochs, or &false; on error. - + diff --git a/reference/fann/functions/fann-get-cascade-num-candidate-groups.xml b/reference/fann/functions/fann-get-cascade-num-candidate-groups.xml index fe08e6970..73e238eb7 100644 --- a/reference/fann/functions/fann-get-cascade-num-candidate-groups.xml +++ b/reference/fann/functions/fann-get-cascade-num-candidate-groups.xml @@ -13,19 +13,19 @@ intfann_get_cascade_num_candidate_groups resourceann - + The number of candidate groups is the number of groups of identical candidates which will be used during training. - - + + This number can be used to have more candidates without having to define new parameters for the candidates. - - + + See fann_get_cascade_num_candidates for a description of which candidate neurons will be generated by this parameter. - - + + The default number of candidate groups is 2. - + @@ -42,9 +42,9 @@ &reftitle.returnvalues; - + The number of candidate groups, or &false; on error. - + diff --git a/reference/fann/functions/fann-get-cascade-num-candidates.xml b/reference/fann/functions/fann-get-cascade-num-candidates.xml index a462f53ab..b26cb66cb 100644 --- a/reference/fann/functions/fann-get-cascade-num-candidates.xml +++ b/reference/fann/functions/fann-get-cascade-num-candidates.xml @@ -13,13 +13,13 @@ intfann_get_cascade_num_candidates resourceann - + The number of candidates used during training (calculated by multiplying fann_get_cascade_activation_functions_count, fann_get_cascade_activation_steepnesses_count and fann_get_cascade_num_candidate_groups). - - + + The actual candidates is defined by the fann_get_cascade_activation_functions and fann_get_cascade_activation_steepnesses arrays. These arrays define the activation functions and activation steepnesses used for the candidate neurons. If there are 2 activation functions in the activation function array and @@ -27,10 +27,10 @@ candidates can be copied into several candidate groups, where the only difference between these groups is the initial weights. If the number of groups is set to 2, then the number of candidate neurons will be 2x3x2=12. The number of candidate groups is defined by fann_set_cascade_num_candidate_groups. - - + + The default number of candidates is 6x4x2 = 48 - + @@ -47,9 +47,9 @@ &reftitle.returnvalues; - + The number of candidates used during training, or &false; on error. - + diff --git a/reference/fann/functions/fann-get-cascade-output-change-fraction.xml b/reference/fann/functions/fann-get-cascade-output-change-fraction.xml index 27f5cc48a..fd66ba92a 100644 --- a/reference/fann/functions/fann-get-cascade-output-change-fraction.xml +++ b/reference/fann/functions/fann-get-cascade-output-change-fraction.xml @@ -13,21 +13,21 @@ floatfann_get_cascade_output_change_fraction resourceann - + The cascade output change fraction is a number between 0 and 1 determining how large a fraction of the fann_get_MSE value should change within fann_get_cascade_output_stagnation_epochs during training of the output connections, in order for the training not to stagnate. If the training stagnates, the training of the output connections will be ended and new candidates will be prepared. - - + + It means that if the MSE does not change by a fraction of fann_get_cascade_output_change_fraction during a period of fann_get_cascade_output_stagnation_epochs, the training of the output connections is stopped because the training has stagnated. - - + + If the cascade output change fraction is low, the output connections will be trained more and if the fraction is high, they will be trained less. - + The default cascade output change fraction is 0.01, which is equivalent to a 1% change in MSE. @@ -47,9 +47,9 @@ &reftitle.returnvalues; - + The cascade output change fraction, or &false; on error. - + diff --git a/reference/fann/functions/fann-get-cascade-output-stagnation-epochs.xml b/reference/fann/functions/fann-get-cascade-output-stagnation-epochs.xml index 2456714c7..4570143e0 100644 --- a/reference/fann/functions/fann-get-cascade-output-stagnation-epochs.xml +++ b/reference/fann/functions/fann-get-cascade-output-stagnation-epochs.xml @@ -13,16 +13,16 @@ intfann_get_cascade_output_stagnation_epochs resourceann - + The number of cascade output stagnation epochs determines the number of epochs training is allowed to continue without changing the MSE by a fraction of fann_get_cascade_output_change_fraction. - - + + See more info about this parameter in fann_get_cascade_output_change_fraction. - - + + The default number of cascade output stagnation epochs is 12. - + @@ -39,9 +39,9 @@ &reftitle.returnvalues; - + The number of cascade output stagnation epochs, or &false; on error. - + diff --git a/reference/fann/functions/fann-get-cascade-weight-multiplier.xml b/reference/fann/functions/fann-get-cascade-weight-multiplier.xml index 05832c9c6..f792d727f 100644 --- a/reference/fann/functions/fann-get-cascade-weight-multiplier.xml +++ b/reference/fann/functions/fann-get-cascade-weight-multiplier.xml @@ -13,13 +13,13 @@ floatfann_get_cascade_weight_multiplier resourceann - + The weight multiplier is a parameter which is used to multiply the weights from the candidate neuron before adding the neuron to the neural network. This parameter is usually between 0 and 1, and is used to make the training a bit less aggressive. - - + + The default weight multiplier is 0.4. - + @@ -36,9 +36,9 @@ &reftitle.returnvalues; - + The weight multiplier, or &false; on error. - + diff --git a/reference/fann/functions/fann-get-connection-array.xml b/reference/fann/functions/fann-get-connection-array.xml index d883dcc5a..1c069151b 100644 --- a/reference/fann/functions/fann-get-connection-array.xml +++ b/reference/fann/functions/fann-get-connection-array.xml @@ -13,9 +13,9 @@ arrayfann_get_connection_array resourceann - + Get connections in the network. - + @@ -32,9 +32,9 @@ &reftitle.returnvalues; - + An array of connections in the network - + diff --git a/reference/fann/functions/fann-get-connection-rate.xml b/reference/fann/functions/fann-get-connection-rate.xml index 8564cde90..29b0b32c6 100644 --- a/reference/fann/functions/fann-get-connection-rate.xml +++ b/reference/fann/functions/fann-get-connection-rate.xml @@ -13,9 +13,9 @@ floatfann_get_connection_rate resourceann - + Get the connection rate used when the network was created. - + @@ -32,9 +32,9 @@ &reftitle.returnvalues; - + The connection rate used when the network was created, or &false; on error. - + diff --git a/reference/fann/functions/fann-get-errno.xml b/reference/fann/functions/fann-get-errno.xml index 7412ba6e2..7826f8ce0 100644 --- a/reference/fann/functions/fann-get-errno.xml +++ b/reference/fann/functions/fann-get-errno.xml @@ -13,9 +13,9 @@ intfann_get_errno resourceerrdat - + Returns the last error number. - + @@ -32,9 +32,9 @@ &reftitle.returnvalues; - + The error number, or &false; on error. - + diff --git a/reference/fann/functions/fann-get-errstr.xml b/reference/fann/functions/fann-get-errstr.xml index e353761d9..bd5a6b170 100644 --- a/reference/fann/functions/fann-get-errstr.xml +++ b/reference/fann/functions/fann-get-errstr.xml @@ -13,9 +13,9 @@ stringfann_get_errstr resourceerrdat - + Returns the last errstr. - + @@ -32,9 +32,9 @@ &reftitle.returnvalues; - + The last error string, or &false; on error. - + diff --git a/reference/fann/functions/fann-get-layer-array.xml b/reference/fann/functions/fann-get-layer-array.xml index f56aa7377..9c66db60f 100644 --- a/reference/fann/functions/fann-get-layer-array.xml +++ b/reference/fann/functions/fann-get-layer-array.xml @@ -13,12 +13,12 @@ arrayfann_get_layer_array resourceann - + Get the number of neurons in each layer in the neural network. - - + + Bias is not included so the layers match the fann_create functions. - + diff --git a/reference/fann/functions/fann-get-learning-momentum.xml b/reference/fann/functions/fann-get-learning-momentum.xml index 107acdda1..99bdc310f 100644 --- a/reference/fann/functions/fann-get-learning-momentum.xml +++ b/reference/fann/functions/fann-get-learning-momentum.xml @@ -13,14 +13,14 @@ floatfann_get_learning_momentum resourceann - + The learning momentum can be used to speed up FANN_TRAIN_INCREMENTAL training. A too high momentum will however not benefit training. Setting momentum to 0 will be the same as not using the momentum parameter. The recommended value of this parameter is between 0.0 and 1.0. - - + + The default momentum is 0. - + @@ -38,9 +38,9 @@ &reftitle.returnvalues; &fann.return.bool; - + The learning momentum, or &false; on error. - + diff --git a/reference/fann/functions/fann-get-learning-rate.xml b/reference/fann/functions/fann-get-learning-rate.xml index 436c28c8c..eea2d0f4a 100644 --- a/reference/fann/functions/fann-get-learning-rate.xml +++ b/reference/fann/functions/fann-get-learning-rate.xml @@ -13,14 +13,14 @@ floatfann_get_learning_rate resourceann - + The learning rate is used to determine how aggressive training should be for some of the training algorithms (FANN_TRAIN_INCREMENTAL, FANN_TRAIN_BATCH, FANN_TRAIN_QUICKPROP). Do however note that it is not used in FANN_TRAIN_RPROP. - - + + The default learning rate is 0.7. - + @@ -37,9 +37,9 @@ &reftitle.returnvalues; - + The learning rate, or &false; on error. - + diff --git a/reference/fann/functions/fann-get-mse.xml b/reference/fann/functions/fann-get-mse.xml index f426cf7ae..c5c65b1f3 100644 --- a/reference/fann/functions/fann-get-mse.xml +++ b/reference/fann/functions/fann-get-mse.xml @@ -13,13 +13,13 @@ floatfann_get_MSE resourceann - + Reads the mean square error from the network. - - + + Reads the mean square error from the network. This value is calculated during training or testing and can therefore sometimes be a bit off if the weights have been changed since the last calculation of the value. - + @@ -36,9 +36,9 @@ &reftitle.returnvalues; - + The mean square error, or &false; on error. - + diff --git a/reference/fann/functions/fann-get-network-type.xml b/reference/fann/functions/fann-get-network-type.xml index acc17c461..bc92c9358 100644 --- a/reference/fann/functions/fann-get-network-type.xml +++ b/reference/fann/functions/fann-get-network-type.xml @@ -13,9 +13,9 @@ intfann_get_network_type resourceann - + Get the type of neural network it was created as. - + @@ -32,9 +32,9 @@ &reftitle.returnvalues; - + Network type constant, or &false; on error. - + diff --git a/reference/fann/functions/fann-get-num-input.xml b/reference/fann/functions/fann-get-num-input.xml index a6ddb561c..751e2f026 100644 --- a/reference/fann/functions/fann-get-num-input.xml +++ b/reference/fann/functions/fann-get-num-input.xml @@ -13,9 +13,9 @@ intfann_get_num_input resourceann - + Get the number of input neurons. - + @@ -32,9 +32,9 @@ &reftitle.returnvalues; - + Number of input neurons, or &false; on error - + diff --git a/reference/fann/functions/fann-get-num-layers.xml b/reference/fann/functions/fann-get-num-layers.xml index 3ad2c4f7f..868a08023 100644 --- a/reference/fann/functions/fann-get-num-layers.xml +++ b/reference/fann/functions/fann-get-num-layers.xml @@ -13,9 +13,9 @@ intfann_get_num_layers resourceann - + Get the number of layers in the neural network. - + diff --git a/reference/fann/functions/fann-get-num-output.xml b/reference/fann/functions/fann-get-num-output.xml index 7430ddb64..c3c05f498 100644 --- a/reference/fann/functions/fann-get-num-output.xml +++ b/reference/fann/functions/fann-get-num-output.xml @@ -13,9 +13,9 @@ intfann_get_num_output resourceann - + Get the number of output neurons. - + @@ -32,9 +32,9 @@ &reftitle.returnvalues; - + Number of output neurons, or &false; on error - + diff --git a/reference/fann/functions/fann-get-quickprop-decay.xml b/reference/fann/functions/fann-get-quickprop-decay.xml index dfb72706a..0bc34a555 100644 --- a/reference/fann/functions/fann-get-quickprop-decay.xml +++ b/reference/fann/functions/fann-get-quickprop-decay.xml @@ -13,13 +13,13 @@ floatfann_get_quickprop_decay resourceann - + The decay is a small negative valued number which is a factor that the weights should decrease in each iteration during quickprop training. This is used to make sure that the weights do not become too high during training. - - + + The default decay is -0.0001. - + @@ -36,9 +36,9 @@ &reftitle.returnvalues; - + The decay, or &false; on error. - + diff --git a/reference/fann/functions/fann-get-quickprop-mu.xml b/reference/fann/functions/fann-get-quickprop-mu.xml index a64d7f740..48de770bf 100644 --- a/reference/fann/functions/fann-get-quickprop-mu.xml +++ b/reference/fann/functions/fann-get-quickprop-mu.xml @@ -13,13 +13,13 @@ floatfann_get_quickprop_mu resourceann - + The mu factor is used to increase and decrease the step-size during quickprop training. The mu factor should always be above 1, since it would otherwise decrease the step-size when it was suppose to increase it. - - + + The default mu factor is 1.75. - + @@ -36,9 +36,9 @@ &reftitle.returnvalues; - + The mu factor, or &false; on error. - + diff --git a/reference/fann/functions/fann-get-rprop-decrease-factor.xml b/reference/fann/functions/fann-get-rprop-decrease-factor.xml index 78cdf3fe9..c73d3c924 100644 --- a/reference/fann/functions/fann-get-rprop-decrease-factor.xml +++ b/reference/fann/functions/fann-get-rprop-decrease-factor.xml @@ -13,12 +13,12 @@ floatfann_get_rprop_decrease_factor resourceann - + The decrease factor is a value smaller than 1, which is used to decrease the step-size during RPROP training. - - + + The default decrease factor is 0.5. - + @@ -35,9 +35,9 @@ &reftitle.returnvalues; - + The decrease factor, or &false; on error. - + diff --git a/reference/fann/functions/fann-get-rprop-delta-max.xml b/reference/fann/functions/fann-get-rprop-delta-max.xml index 54dca2db9..5b2ad32f7 100644 --- a/reference/fann/functions/fann-get-rprop-delta-max.xml +++ b/reference/fann/functions/fann-get-rprop-delta-max.xml @@ -13,12 +13,12 @@ floatfann_get_rprop_delta_max resourceann - + The maximum step-size is a positive number determining how large the maximum step-size may be. - - + + The default delta max is 50.0. - + @@ -35,9 +35,9 @@ &reftitle.returnvalues; - + The maximum step-size, or &false; on error. - + diff --git a/reference/fann/functions/fann-get-rprop-delta-min.xml b/reference/fann/functions/fann-get-rprop-delta-min.xml index 560d29529..8231daa94 100644 --- a/reference/fann/functions/fann-get-rprop-delta-min.xml +++ b/reference/fann/functions/fann-get-rprop-delta-min.xml @@ -13,12 +13,12 @@ floatfann_get_rprop_delta_min resourceann - + The minimum step-size is a small positive number determining how small the minimum step-size may be. - - + + The default value delta min is 0.0. - + @@ -35,9 +35,9 @@ &reftitle.returnvalues; - + The minimum step-size, or &false; on error. - + diff --git a/reference/fann/functions/fann-get-rprop-delta-zero.xml b/reference/fann/functions/fann-get-rprop-delta-zero.xml index 182ef0a44..eaccd4cff 100644 --- a/reference/fann/functions/fann-get-rprop-delta-zero.xml +++ b/reference/fann/functions/fann-get-rprop-delta-zero.xml @@ -13,12 +13,12 @@ intfann_get_rprop_delta_zero resourceann - + The initial step-size is a positive number determining the initial step size. - - + + The default delta zero is 0.1. - + @@ -35,9 +35,9 @@ &reftitle.returnvalues; - + The initial step-size, or &false; on error. - + diff --git a/reference/fann/functions/fann-get-rprop-increase-factor.xml b/reference/fann/functions/fann-get-rprop-increase-factor.xml index 7a433b02c..56819a6ac 100644 --- a/reference/fann/functions/fann-get-rprop-increase-factor.xml +++ b/reference/fann/functions/fann-get-rprop-increase-factor.xml @@ -13,12 +13,12 @@ floatfann_get_rprop_increase_factor resourceann - + The increase factor is a value larger than 1, which is used to increase the step-size during RPROP training. - - + + The default increase factor is 1.2. - + @@ -35,9 +35,9 @@ &reftitle.returnvalues; - + The increase factor, or &false; on error. - + diff --git a/reference/fann/functions/fann-get-sarprop-step-error-shift.xml b/reference/fann/functions/fann-get-sarprop-step-error-shift.xml index aade12f78..dbe433743 100644 --- a/reference/fann/functions/fann-get-sarprop-step-error-shift.xml +++ b/reference/fann/functions/fann-get-sarprop-step-error-shift.xml @@ -13,12 +13,12 @@ floatfann_get_sarprop_step_error_shift resourceann - + Returns the sarprop step error shift. - - + + The default step error shift is 1.385. - + @@ -35,9 +35,9 @@ &reftitle.returnvalues; - + The sarprop step error shift , or &false; on error. - + diff --git a/reference/fann/functions/fann-get-sarprop-step-error-threshold-factor.xml b/reference/fann/functions/fann-get-sarprop-step-error-threshold-factor.xml index 62ba4170c..24440488a 100644 --- a/reference/fann/functions/fann-get-sarprop-step-error-threshold-factor.xml +++ b/reference/fann/functions/fann-get-sarprop-step-error-threshold-factor.xml @@ -13,12 +13,12 @@ floatfann_get_sarprop_step_error_threshold_factor resourceann - + The sarprop step error threshold factor. - - + + The default factor is 0.1. - + @@ -35,9 +35,9 @@ &reftitle.returnvalues; - + The sarprop step error threshold factor, or &false; on error. - + diff --git a/reference/fann/functions/fann-get-sarprop-temperature.xml b/reference/fann/functions/fann-get-sarprop-temperature.xml index f4371a722..d6b50fdd5 100644 --- a/reference/fann/functions/fann-get-sarprop-temperature.xml +++ b/reference/fann/functions/fann-get-sarprop-temperature.xml @@ -13,12 +13,12 @@ floatfann_get_sarprop_temperature resourceann - + Returns the sarprop temperature. - - + + The default temperature is 0.015. - + @@ -35,9 +35,9 @@ &reftitle.returnvalues; - + The sarprop temperature, or &false; on error. - + diff --git a/reference/fann/functions/fann-get-sarprop-weight-decay-shift.xml b/reference/fann/functions/fann-get-sarprop-weight-decay-shift.xml index 226ac5ec5..2e9d624ab 100644 --- a/reference/fann/functions/fann-get-sarprop-weight-decay-shift.xml +++ b/reference/fann/functions/fann-get-sarprop-weight-decay-shift.xml @@ -13,12 +13,12 @@ floatfann_get_sarprop_weight_decay_shift resourceann - + The sarprop weight decay shift. - - + + The default delta max is -6.644. - + @@ -35,9 +35,9 @@ &reftitle.returnvalues; - + The sarprop weight decay shift, or &false; on error. - + diff --git a/reference/fann/functions/fann-get-total-connections.xml b/reference/fann/functions/fann-get-total-connections.xml index a3e38b353..c528e0ebf 100644 --- a/reference/fann/functions/fann-get-total-connections.xml +++ b/reference/fann/functions/fann-get-total-connections.xml @@ -13,9 +13,9 @@ intfann_get_total_connections resourceann - + Get the total number of connections in the entire network. - + @@ -32,9 +32,9 @@ &reftitle.returnvalues; - + Total number of connections in the entire network, or &false; on error - + diff --git a/reference/fann/functions/fann-get-total-neurons.xml b/reference/fann/functions/fann-get-total-neurons.xml index 45739d2f1..75232e7aa 100644 --- a/reference/fann/functions/fann-get-total-neurons.xml +++ b/reference/fann/functions/fann-get-total-neurons.xml @@ -13,10 +13,10 @@ intfann_get_total_neurons resourceann - + Get the total number of neurons in the entire network. This number does also include the bias neurons, so a 2-4-2 network has 2+4+2 +2(bias) = 10 neurons. - + @@ -33,9 +33,9 @@ &reftitle.returnvalues; - + Total number of neurons in the entire network, or &false; on error. - + diff --git a/reference/fann/functions/fann-get-train-error-function.xml b/reference/fann/functions/fann-get-train-error-function.xml index 1bc0cc8b4..0b9412345 100644 --- a/reference/fann/functions/fann-get-train-error-function.xml +++ b/reference/fann/functions/fann-get-train-error-function.xml @@ -13,15 +13,15 @@ intfann_get_train_error_function resourceann - + Returns the error function used during training. - - + + The error functions are described further in error functions constants. - - + + The default error function is FANN_ERRORFUNC_TANH. - + @@ -38,9 +38,9 @@ &reftitle.returnvalues; - + The error function constant, or &false; on error. - + diff --git a/reference/fann/functions/fann-get-train-stop-function.xml b/reference/fann/functions/fann-get-train-stop-function.xml index 348aebdd8..2ba0e751d 100644 --- a/reference/fann/functions/fann-get-train-stop-function.xml +++ b/reference/fann/functions/fann-get-train-stop-function.xml @@ -13,15 +13,15 @@ intfann_get_train_stop_function resourceann - + Returns the stop function used during training. - - + + The stop functions are described further in stop functions constants. - - + + The default stop function is FANN_STOPFUNC_MSE. - + @@ -38,9 +38,9 @@ &reftitle.returnvalues; - + The stop function constant, or &false; on error. - + diff --git a/reference/fann/functions/fann-get-training-algorithm.xml b/reference/fann/functions/fann-get-training-algorithm.xml index 19f6f923c..a579292c8 100644 --- a/reference/fann/functions/fann-get-training-algorithm.xml +++ b/reference/fann/functions/fann-get-training-algorithm.xml @@ -13,13 +13,13 @@ intfann_get_training_algorithm resourceann - + Returns the training algorithm. This training algorithm is used by fann_train_on_data and associated functions. - - + + Note that this algorithm is also used during fann_cascadetrain_on_data, although only FANN_TRAIN_RPROP and FANN_TRAIN_QUICKPROP is allowed during cascade training. - + @@ -36,9 +36,9 @@ &reftitle.returnvalues; - + Training algorithm constant, or &false; on error. - + diff --git a/reference/fann/functions/fann-init-weights.xml b/reference/fann/functions/fann-init-weights.xml index fa90b10d4..880fe40e5 100644 --- a/reference/fann/functions/fann-init-weights.xml +++ b/reference/fann/functions/fann-init-weights.xml @@ -14,18 +14,18 @@ resourceann resourcetrain_data - + Initialize the weights using Widrow + Nguyen’s algorithm. - - + + This function behaves similarly to fann_randomize_weights. It will use the algorithm developed by Derrick Nguyen and Bernard Widrow to set the weights in such a way as to speed up training. This technique is not always successful, and in some cases can be less efficient than a purely random initialization. - - + + The algorithm requires access to the range of the input data (for example largest and smallest input), and therefore accepts a second argument, data, which is the training data that will be used to train the network. - + diff --git a/reference/fann/functions/fann-length-train-data.xml b/reference/fann/functions/fann-length-train-data.xml index 3076f0f12..a89a6da0b 100644 --- a/reference/fann/functions/fann-length-train-data.xml +++ b/reference/fann/functions/fann-length-train-data.xml @@ -13,9 +13,9 @@ intfann_length_train_data resourcedata - + Returns the number of training patterns in the train data resource. - + @@ -32,9 +32,9 @@ &reftitle.returnvalues; - + Number of elements in the train data resource, or &false; on error. - + diff --git a/reference/fann/functions/fann-merge-train-data.xml b/reference/fann/functions/fann-merge-train-data.xml index ec2d3dda9..ab9ca242c 100644 --- a/reference/fann/functions/fann-merge-train-data.xml +++ b/reference/fann/functions/fann-merge-train-data.xml @@ -14,9 +14,9 @@ resourcedata1 resourcedata2 - + Merges the data from data1 and data2 into a new train data resource. - + @@ -39,9 +39,9 @@ &reftitle.returnvalues; - + New merged train data resource, or &false; on error. - + diff --git a/reference/fann/functions/fann-num-input-train-data.xml b/reference/fann/functions/fann-num-input-train-data.xml index 9120aee90..a0b8c1513 100644 --- a/reference/fann/functions/fann-num-input-train-data.xml +++ b/reference/fann/functions/fann-num-input-train-data.xml @@ -13,9 +13,9 @@ intfann_num_input_train_data resourcedata - + Returns the number of inputs in each of the training patterns in the train data resource. - + @@ -32,9 +32,9 @@ &reftitle.returnvalues; - + The number of inputs, or &false; on error. - + diff --git a/reference/fann/functions/fann-num-output-train-data.xml b/reference/fann/functions/fann-num-output-train-data.xml index 7c784faf0..8d0742034 100644 --- a/reference/fann/functions/fann-num-output-train-data.xml +++ b/reference/fann/functions/fann-num-output-train-data.xml @@ -13,9 +13,9 @@ intfann_num_output_train_data resourcedata - + Returns the number of outputs in each of the training patterns in the train data resource. - + @@ -32,9 +32,9 @@ &reftitle.returnvalues; - + The number of outputs, or &false; on error. - + diff --git a/reference/fann/functions/fann-print-error.xml b/reference/fann/functions/fann-print-error.xml index 8762bd019..c325bb12a 100644 --- a/reference/fann/functions/fann-print-error.xml +++ b/reference/fann/functions/fann-print-error.xml @@ -13,9 +13,9 @@ voidfann_print_error resourceerrdat - + Prints the error string. - + diff --git a/reference/fann/functions/fann-randomize-weights.xml b/reference/fann/functions/fann-randomize-weights.xml index 52cbea8cd..d1aa64d6a 100644 --- a/reference/fann/functions/fann-randomize-weights.xml +++ b/reference/fann/functions/fann-randomize-weights.xml @@ -15,12 +15,12 @@ floatmin_weight floatmax_weight - + Give each connection a random weight between min_weight and max_weight - - + + From the beginning the weights are random between -0.1 and 0.1. - + @@ -35,17 +35,17 @@ min_weight - + Minimum weight value - + max_weight - + Maximum weight value - + diff --git a/reference/fann/functions/fann-read-train-from-file.xml b/reference/fann/functions/fann-read-train-from-file.xml index 4780e144e..0148b283c 100644 --- a/reference/fann/functions/fann-read-train-from-file.xml +++ b/reference/fann/functions/fann-read-train-from-file.xml @@ -13,9 +13,9 @@ resourcefann_read_train_from_file stringfilename - + Reads a file that stores training data. - + @@ -24,9 +24,9 @@ filename - + The input file in the following format: - + ]]> - Contents of xor.data + Contents of xor.data voidfann_reset_errno resourceerrdat - + Resets the last error number. - + diff --git a/reference/fann/functions/fann-reset-errstr.xml b/reference/fann/functions/fann-reset-errstr.xml index a3b05bf34..229211e43 100644 --- a/reference/fann/functions/fann-reset-errstr.xml +++ b/reference/fann/functions/fann-reset-errstr.xml @@ -13,9 +13,9 @@ voidfann_reset_errstr resourceerrdat - + Resets the last error string. - + diff --git a/reference/fann/functions/fann-reset-mse.xml b/reference/fann/functions/fann-reset-mse.xml index 79bc135dd..ee7256a4c 100644 --- a/reference/fann/functions/fann-reset-mse.xml +++ b/reference/fann/functions/fann-reset-mse.xml @@ -13,12 +13,12 @@ boolfann_reset_MSE stringann - + Resets the mean square error from the network. - - + + This function also resets the number of bits that fail. - + diff --git a/reference/fann/functions/fann-run.xml b/reference/fann/functions/fann-run.xml index d1ad08ec4..633ee5c58 100644 --- a/reference/fann/functions/fann-run.xml +++ b/reference/fann/functions/fann-run.xml @@ -14,10 +14,10 @@ resourceann arrayinput - + Will run input through the neural network, returning an array of outputs, the number of which being equal to the number of neurons in the output layer. - + @@ -32,9 +32,9 @@ input - + Array of input values - + @@ -42,9 +42,9 @@ &reftitle.returnvalues; - + Array of output values, or &false; on error - + diff --git a/reference/fann/functions/fann-save-train.xml b/reference/fann/functions/fann-save-train.xml index e3974a968..2f09c270e 100644 --- a/reference/fann/functions/fann-save-train.xml +++ b/reference/fann/functions/fann-save-train.xml @@ -14,9 +14,9 @@ resourcedata stringfile_name - + Save the training data to a file, with the format as specified in fann_read_train_from_file. - + @@ -31,9 +31,9 @@ file_name - + The file name of the file where training data is saved to. - + diff --git a/reference/fann/functions/fann-save.xml b/reference/fann/functions/fann-save.xml index 3bccb6a2b..94bfee273 100644 --- a/reference/fann/functions/fann-save.xml +++ b/reference/fann/functions/fann-save.xml @@ -14,20 +14,20 @@ resourceann stringconfiguration_file - + Saves the entire network to a configuration file. - - + + The configuration file contains all information about the neural network and enables fann_create_from_file to create an exact copy of the neural network and all of the parameters associated with the neural network. - - + + These three parameters (fann_set_callback, fann_set_error_log, fann_set_user_data) are NOT saved to the file because they cannot safely be ported to a different location. Also temporary parameters generated during training like fann_get_MSE is not saved. - + @@ -42,9 +42,9 @@ configuration_file - + The configuration file path. - + diff --git a/reference/fann/functions/fann-scale-input-train-data.xml b/reference/fann/functions/fann-scale-input-train-data.xml index 7a1445eb9..691be2ae8 100644 --- a/reference/fann/functions/fann-scale-input-train-data.xml +++ b/reference/fann/functions/fann-scale-input-train-data.xml @@ -15,9 +15,9 @@ floatnew_min floatnew_max - + Scales the inputs in the training data to the specified range. - + @@ -32,17 +32,17 @@ new_min - + New minimum after scaling inputs in training data. - + new_max - + New maximum after scaling inputs in training data. - + diff --git a/reference/fann/functions/fann-scale-input.xml b/reference/fann/functions/fann-scale-input.xml index c1f97c260..245fc5115 100644 --- a/reference/fann/functions/fann-scale-input.xml +++ b/reference/fann/functions/fann-scale-input.xml @@ -14,9 +14,9 @@ resourceann arrayinput_vector - + Scale data in input vector before feed it to ann based on previously calculated parameters. - + @@ -31,9 +31,9 @@ input_vector - + Input vector that will be scaled - + diff --git a/reference/fann/functions/fann-scale-output-train-data.xml b/reference/fann/functions/fann-scale-output-train-data.xml index 2445dad3d..5bbf64c4d 100644 --- a/reference/fann/functions/fann-scale-output-train-data.xml +++ b/reference/fann/functions/fann-scale-output-train-data.xml @@ -15,9 +15,9 @@ floatnew_min floatnew_max - + Scales the outputs in the training data to the specified range. - + @@ -32,17 +32,17 @@ new_min - + New minimum after scaling outputs in training data. - + new_max - + New maximum after scaling outputs in training data. - + diff --git a/reference/fann/functions/fann-scale-output.xml b/reference/fann/functions/fann-scale-output.xml index cc3723b52..fcf88bbc1 100644 --- a/reference/fann/functions/fann-scale-output.xml +++ b/reference/fann/functions/fann-scale-output.xml @@ -14,9 +14,9 @@ resourceann arrayoutput_vector - + Scale data in output vector before feed it to ann based on previously calculated parameters. - + @@ -31,9 +31,9 @@ output_vector - + Output vector that will be scaled - + diff --git a/reference/fann/functions/fann-scale-train-data.xml b/reference/fann/functions/fann-scale-train-data.xml index ee1196c02..ce319749c 100644 --- a/reference/fann/functions/fann-scale-train-data.xml +++ b/reference/fann/functions/fann-scale-train-data.xml @@ -15,9 +15,9 @@ floatnew_min floatnew_max - + Scales the inputs and outputs in the training data to the specified range. - + @@ -32,17 +32,17 @@ new_min - + New minimum after scaling inputs and outputs in training data. - + new_max - + New maximum after scaling inputs and outputs in training data. - + diff --git a/reference/fann/functions/fann-scale-train.xml b/reference/fann/functions/fann-scale-train.xml index db220b473..6fc6262e5 100644 --- a/reference/fann/functions/fann-scale-train.xml +++ b/reference/fann/functions/fann-scale-train.xml @@ -14,9 +14,9 @@ resourceann resourcetrain_data - + Scale input and output data based on previously calculated parameters. - + diff --git a/reference/fann/functions/fann-set-activation-function-hidden.xml b/reference/fann/functions/fann-set-activation-function-hidden.xml index c7441abe0..add60496d 100644 --- a/reference/fann/functions/fann-set-activation-function-hidden.xml +++ b/reference/fann/functions/fann-set-activation-function-hidden.xml @@ -14,9 +14,9 @@ resourceann intactivation_function - + Sets the activation function for all of the hidden layers. - + @@ -31,9 +31,9 @@ activation_function - + The activation functions constant. - + diff --git a/reference/fann/functions/fann-set-activation-function-layer.xml b/reference/fann/functions/fann-set-activation-function-layer.xml index 1fc85e87e..6cb83fedf 100644 --- a/reference/fann/functions/fann-set-activation-function-layer.xml +++ b/reference/fann/functions/fann-set-activation-function-layer.xml @@ -15,12 +15,12 @@ intactivation_function intlayer - + Set the activation function for all the neurons in the layer number layer, counting the input layer as layer 0. - - + + It is not possible to set activation functions for the neurons in the input layer. - + @@ -35,17 +35,17 @@ activation_function - + The activation functions constant. - + layer - + Layer number. - + diff --git a/reference/fann/functions/fann-set-activation-function-output.xml b/reference/fann/functions/fann-set-activation-function-output.xml index d884d4df6..9aa6a0fb0 100644 --- a/reference/fann/functions/fann-set-activation-function-output.xml +++ b/reference/fann/functions/fann-set-activation-function-output.xml @@ -14,9 +14,9 @@ resourceann intactivation_function - + Sets the activation function for the output layer. - + @@ -31,9 +31,9 @@ activation_function - + The activation functions constant. - + diff --git a/reference/fann/functions/fann-set-activation-function.xml b/reference/fann/functions/fann-set-activation-function.xml index e2bad143d..5e3376984 100644 --- a/reference/fann/functions/fann-set-activation-function.xml +++ b/reference/fann/functions/fann-set-activation-function.xml @@ -16,25 +16,25 @@ intlayer intneuron - + Set the activation function for neuron number neuron in layer number layer, counting the input layer as layer 0. - - + + It is not possible to set activation functions for the neurons in the input layer. - - + + When choosing an activation function it is important to note that the activation functions have different range. FANN_SIGMOID is e.g. in the 0 - 1 range while FANN_SIGMOID_SYMMETRIC is in the -1 - 1 range and FANN_LINEAR is unbound. - - + + The supplied activation_function value must be one of the activation functions constants. - - + + The return value is one of the activation functions constants. - + @@ -49,25 +49,25 @@ activation_function - + The activation functions constant. - + layer - + Layer number. - + neuron - + Neuron number. - + diff --git a/reference/fann/functions/fann-set-activation-steepness-hidden.xml b/reference/fann/functions/fann-set-activation-steepness-hidden.xml index d8295308e..0db01078a 100644 --- a/reference/fann/functions/fann-set-activation-steepness-hidden.xml +++ b/reference/fann/functions/fann-set-activation-steepness-hidden.xml @@ -14,9 +14,9 @@ resourceann floatactivation_steepness - + Sets the steepness of the activation steepness for all neurons in the all hidden layers. - + @@ -31,9 +31,9 @@ activation_steepness - + The activation steepness. - + diff --git a/reference/fann/functions/fann-set-activation-steepness-layer.xml b/reference/fann/functions/fann-set-activation-steepness-layer.xml index 535171cbc..728084351 100644 --- a/reference/fann/functions/fann-set-activation-steepness-layer.xml +++ b/reference/fann/functions/fann-set-activation-steepness-layer.xml @@ -15,13 +15,13 @@ floatactivation_steepness intlayer - + Set the activation steepness for all of the neurons in layer number layer, counting the input layer as layer 0. - - + + It is not possible to set activation steepness for the neurons in the input layer. - + @@ -36,17 +36,17 @@ activation_steepness - + The activation steepness. - + layer - + Layer number. - + diff --git a/reference/fann/functions/fann-set-activation-steepness-output.xml b/reference/fann/functions/fann-set-activation-steepness-output.xml index 82b33fc47..5c59339b9 100644 --- a/reference/fann/functions/fann-set-activation-steepness-output.xml +++ b/reference/fann/functions/fann-set-activation-steepness-output.xml @@ -14,9 +14,9 @@ resourceann floatactivation_steepness - + Sets the steepness of the activation steepness in the output layer. - + @@ -31,9 +31,9 @@ activation_steepness - + The activation steepness. - + diff --git a/reference/fann/functions/fann-set-activation-steepness.xml b/reference/fann/functions/fann-set-activation-steepness.xml index 098dc48dc..168c80387 100644 --- a/reference/fann/functions/fann-set-activation-steepness.xml +++ b/reference/fann/functions/fann-set-activation-steepness.xml @@ -16,24 +16,24 @@ intlayer intneuron - + Set the activation steepness for neuron number neuron in layer number layer, counting the input layer as layer 0. - - + + It is not possible to set activation steepness for the neurons in the input layer. - - + + The steepness of an activation function says something about how fast the activation function goes from the minimum to the maximum. A high value for the activation function will also give a more aggressive training. - - + + When training neural networks where the output values should be at the extremes (usually 0 and 1, depending on the activation function), a steep activation function can be used (e.g. 1.0). - - + + The default activation steepness is 0.5. - + @@ -48,25 +48,25 @@ activation_steepness - + The activation steepness. - + layer - + Layer number. - + neuron - + Neuron number. - + diff --git a/reference/fann/functions/fann-set-bit-fail-limit.xml b/reference/fann/functions/fann-set-bit-fail-limit.xml index eba0f2904..6bccddaa8 100644 --- a/reference/fann/functions/fann-set-bit-fail-limit.xml +++ b/reference/fann/functions/fann-set-bit-fail-limit.xml @@ -14,9 +14,9 @@ resourceann floatbit_fail_limit - + Set the bit fail limit used during training. - + @@ -31,9 +31,9 @@ bit_fail_limit - + The bit fail limit. - + diff --git a/reference/fann/functions/fann-set-callback.xml b/reference/fann/functions/fann-set-callback.xml index e73eb3963..afcf29ab8 100644 --- a/reference/fann/functions/fann-set-callback.xml +++ b/reference/fann/functions/fann-set-callback.xml @@ -14,10 +14,10 @@ resourceann callablecallback - + Sets the callback function for use during training. It means that it is called from fann_train_on_data or fann_train_on_file. - + @@ -46,9 +46,9 @@ epochs - The current epoch - + The callback should return &true;. If it returns &false;, the training will terminate. - + diff --git a/reference/fann/functions/fann-set-cascade-activation-functions.xml b/reference/fann/functions/fann-set-cascade-activation-functions.xml index 95a62a147..35f1cc649 100644 --- a/reference/fann/functions/fann-set-cascade-activation-functions.xml +++ b/reference/fann/functions/fann-set-cascade-activation-functions.xml @@ -14,12 +14,12 @@ resourceann arraycascade_activation_functions - + Sets the array of cascade candidate activation functions. - - + + See fann_get_cascade_num_candidates for a description of which candidate neurons will be generated by this array. - + @@ -34,9 +34,9 @@ cascade_activation_functions - + The array of cascade candidate activation functions. - + diff --git a/reference/fann/functions/fann-set-cascade-activation-steepnesses.xml b/reference/fann/functions/fann-set-cascade-activation-steepnesses.xml index 3e9dbddb3..e766e5cc1 100644 --- a/reference/fann/functions/fann-set-cascade-activation-steepnesses.xml +++ b/reference/fann/functions/fann-set-cascade-activation-steepnesses.xml @@ -14,12 +14,12 @@ resourceann arraycascade_activation_steepnesses_count - + Sets the array of cascade candidate activation steepnesses. - - + + See fann_get_cascade_num_candidates for a description of which candidate neurons will be generated by this array. - + @@ -34,9 +34,9 @@ cascade_activation_steepnesses_count - + The array of cascade candidate activation steepnesses. - + diff --git a/reference/fann/functions/fann-set-cascade-candidate-change-fraction.xml b/reference/fann/functions/fann-set-cascade-candidate-change-fraction.xml index 34584f0df..10fe0ab21 100644 --- a/reference/fann/functions/fann-set-cascade-candidate-change-fraction.xml +++ b/reference/fann/functions/fann-set-cascade-candidate-change-fraction.xml @@ -14,9 +14,9 @@ resourceann floatcascade_candidate_change_fraction - + Sets the cascade candidate change fraction. - + @@ -31,9 +31,9 @@ cascade_candidate_change_fraction - + The cascade candidate change fraction. - + diff --git a/reference/fann/functions/fann-set-cascade-candidate-limit.xml b/reference/fann/functions/fann-set-cascade-candidate-limit.xml index ab404a1cd..b3c1ce393 100644 --- a/reference/fann/functions/fann-set-cascade-candidate-limit.xml +++ b/reference/fann/functions/fann-set-cascade-candidate-limit.xml @@ -14,9 +14,9 @@ resourceann floatcascade_candidate_limit - + Sets the candidate limit. - + @@ -31,9 +31,9 @@ cascade_candidate_limit - + The candidate limit. - + diff --git a/reference/fann/functions/fann-set-cascade-candidate-stagnation-epochs.xml b/reference/fann/functions/fann-set-cascade-candidate-stagnation-epochs.xml index 0493f3a41..b429d5916 100644 --- a/reference/fann/functions/fann-set-cascade-candidate-stagnation-epochs.xml +++ b/reference/fann/functions/fann-set-cascade-candidate-stagnation-epochs.xml @@ -14,9 +14,9 @@ resourceann intcascade_candidate_stagnation_epochs - + Sets the number of cascade candidate stagnation epochs. - + @@ -31,9 +31,9 @@ cascade_candidate_stagnation_epochs - + The number of cascade candidate stagnation epochs. - + diff --git a/reference/fann/functions/fann-set-cascade-max-cand-epochs.xml b/reference/fann/functions/fann-set-cascade-max-cand-epochs.xml index 8f0806a69..7748febc9 100644 --- a/reference/fann/functions/fann-set-cascade-max-cand-epochs.xml +++ b/reference/fann/functions/fann-set-cascade-max-cand-epochs.xml @@ -14,9 +14,9 @@ resourceann intcascade_max_cand_epochs - + Sets the max candidate epochs. - + @@ -31,9 +31,9 @@ cascade_max_cand_epochs - + The max candidate epochs. - + diff --git a/reference/fann/functions/fann-set-cascade-max-out-epochs.xml b/reference/fann/functions/fann-set-cascade-max-out-epochs.xml index b563be842..a99a8d682 100644 --- a/reference/fann/functions/fann-set-cascade-max-out-epochs.xml +++ b/reference/fann/functions/fann-set-cascade-max-out-epochs.xml @@ -14,9 +14,9 @@ resourceann intcascade_max_out_epochs - + Sets the maximum out epochs. - + @@ -31,9 +31,9 @@ cascade_max_out_epochs - + The maximum out epochs. - + diff --git a/reference/fann/functions/fann-set-cascade-min-cand-epochs.xml b/reference/fann/functions/fann-set-cascade-min-cand-epochs.xml index d7efc010e..350cb60ac 100644 --- a/reference/fann/functions/fann-set-cascade-min-cand-epochs.xml +++ b/reference/fann/functions/fann-set-cascade-min-cand-epochs.xml @@ -14,9 +14,9 @@ resourceann intcascade_min_cand_epochs - + Sets the min candidate epochs. - + @@ -31,9 +31,9 @@ cascade_min_cand_epochs - + The minimum candidate epochs. - + diff --git a/reference/fann/functions/fann-set-cascade-min-out-epochs.xml b/reference/fann/functions/fann-set-cascade-min-out-epochs.xml index fe44d428c..303f5aed5 100644 --- a/reference/fann/functions/fann-set-cascade-min-out-epochs.xml +++ b/reference/fann/functions/fann-set-cascade-min-out-epochs.xml @@ -14,9 +14,9 @@ resourceann intcascade_min_out_epochs - + Sets the minimum out epochs. - + @@ -31,9 +31,9 @@ cascade_min_out_epochs - + The minimum out epochs. - + diff --git a/reference/fann/functions/fann-set-cascade-num-candidate-groups.xml b/reference/fann/functions/fann-set-cascade-num-candidate-groups.xml index 53d24b861..a4921f93d 100644 --- a/reference/fann/functions/fann-set-cascade-num-candidate-groups.xml +++ b/reference/fann/functions/fann-set-cascade-num-candidate-groups.xml @@ -14,9 +14,9 @@ resourceann intcascade_num_candidate_groups - + Sets the number of candidate groups. - + @@ -31,9 +31,9 @@ cascade_num_candidate_groups - + The number of candidate groups. - + diff --git a/reference/fann/functions/fann-set-cascade-output-change-fraction.xml b/reference/fann/functions/fann-set-cascade-output-change-fraction.xml index c9f7a106e..ab6950e4b 100644 --- a/reference/fann/functions/fann-set-cascade-output-change-fraction.xml +++ b/reference/fann/functions/fann-set-cascade-output-change-fraction.xml @@ -14,9 +14,9 @@ resourceann floatcascade_output_change_fraction - + Sets the cascade output change fraction. - + @@ -31,9 +31,9 @@ cascade_output_change_fraction - + The cascade output change fraction. - + diff --git a/reference/fann/functions/fann-set-cascade-output-stagnation-epochs.xml b/reference/fann/functions/fann-set-cascade-output-stagnation-epochs.xml index 30d9863b3..77980bd33 100644 --- a/reference/fann/functions/fann-set-cascade-output-stagnation-epochs.xml +++ b/reference/fann/functions/fann-set-cascade-output-stagnation-epochs.xml @@ -14,9 +14,9 @@ resourceann intcascade_output_stagnation_epochs - + Sets the number of cascade output stagnation epochs. - + @@ -31,9 +31,9 @@ cascade_output_stagnation_epochs - + The number of cascade output stagnation epochs. - + diff --git a/reference/fann/functions/fann-set-cascade-weight-multiplier.xml b/reference/fann/functions/fann-set-cascade-weight-multiplier.xml index f05d39979..21aece693 100644 --- a/reference/fann/functions/fann-set-cascade-weight-multiplier.xml +++ b/reference/fann/functions/fann-set-cascade-weight-multiplier.xml @@ -14,9 +14,9 @@ resourceann floatcascade_weight_multiplier - + Sets the weight multiplier. - + @@ -31,9 +31,9 @@ cascade_weight_multiplier - + The weight multiplier. - + diff --git a/reference/fann/functions/fann-set-error-log.xml b/reference/fann/functions/fann-set-error-log.xml index 76673d94e..ec72808ad 100644 --- a/reference/fann/functions/fann-set-error-log.xml +++ b/reference/fann/functions/fann-set-error-log.xml @@ -14,9 +14,9 @@ resourceerrdat stringlog_file - + Sets where the errors are logged to. - + @@ -31,9 +31,9 @@ log_file - + The log file path. - + diff --git a/reference/fann/functions/fann-set-input-scaling-params.xml b/reference/fann/functions/fann-set-input-scaling-params.xml index e7d7e0705..f1b42a1c7 100644 --- a/reference/fann/functions/fann-set-input-scaling-params.xml +++ b/reference/fann/functions/fann-set-input-scaling-params.xml @@ -16,9 +16,9 @@ floatnew_input_min floatnew_input_max - + Calculate input scaling parameters for future use based on training data. - + @@ -39,17 +39,17 @@ new_input_min - + The desired lower bound in input data after scaling (not strictly followed) - + new_input_max - + The desired upper bound in input data after scaling (not strictly followed) - + diff --git a/reference/fann/functions/fann-set-learning-momentum.xml b/reference/fann/functions/fann-set-learning-momentum.xml index 785aa72ad..362418dd0 100644 --- a/reference/fann/functions/fann-set-learning-momentum.xml +++ b/reference/fann/functions/fann-set-learning-momentum.xml @@ -14,12 +14,12 @@ resourceann floatlearning_momentum - + Sets the learning momentum. - - + + More info available in fann_get_learning_momentum. - + @@ -34,9 +34,9 @@ learning_momentum - + The learning momentum. - + diff --git a/reference/fann/functions/fann-set-learning-rate.xml b/reference/fann/functions/fann-set-learning-rate.xml index bc5b803e1..d33018ddd 100644 --- a/reference/fann/functions/fann-set-learning-rate.xml +++ b/reference/fann/functions/fann-set-learning-rate.xml @@ -14,12 +14,12 @@ resourceann floatlearning_rate - + Sets the learning rate. - - + + More info available in fann_get_learning_rate. - + @@ -34,9 +34,9 @@ learning_rate - + The learning rate. - + diff --git a/reference/fann/functions/fann-set-output-scaling-params.xml b/reference/fann/functions/fann-set-output-scaling-params.xml index f5f3bb05c..3c6a606e9 100644 --- a/reference/fann/functions/fann-set-output-scaling-params.xml +++ b/reference/fann/functions/fann-set-output-scaling-params.xml @@ -16,9 +16,9 @@ floatnew_output_min floatnew_output_max - + Calculate output scaling parameters for future use based on training data. - + @@ -39,17 +39,17 @@ new_output_min - + The desired lower bound in output data after scaling (not strictly followed) - + new_output_max - + The desired upper bound in output data after scaling (not strictly followed) - + diff --git a/reference/fann/functions/fann-set-quickprop-decay.xml b/reference/fann/functions/fann-set-quickprop-decay.xml index 49b2f76b2..6becf35b2 100644 --- a/reference/fann/functions/fann-set-quickprop-decay.xml +++ b/reference/fann/functions/fann-set-quickprop-decay.xml @@ -14,9 +14,9 @@ resourceann floatquickprop_decay - + Sets the quickprop decay factor. - + @@ -31,9 +31,9 @@ quickprop_decay - + The quickprop decay factor. - + diff --git a/reference/fann/functions/fann-set-quickprop-mu.xml b/reference/fann/functions/fann-set-quickprop-mu.xml index 6060276fa..16e0170f4 100644 --- a/reference/fann/functions/fann-set-quickprop-mu.xml +++ b/reference/fann/functions/fann-set-quickprop-mu.xml @@ -14,9 +14,9 @@ resourceann floatquickprop_mu - + Sets the quickprop mu factor. - + @@ -31,9 +31,9 @@ quickprop_mu - + The mu factor. - + diff --git a/reference/fann/functions/fann-set-rprop-decrease-factor.xml b/reference/fann/functions/fann-set-rprop-decrease-factor.xml index 173e49ae1..8f62d8bd4 100644 --- a/reference/fann/functions/fann-set-rprop-decrease-factor.xml +++ b/reference/fann/functions/fann-set-rprop-decrease-factor.xml @@ -14,9 +14,9 @@ resourceann floatrprop_decrease_factor - + Sets the decrease factor used during RPROP training. - + @@ -31,9 +31,9 @@ rprop_decrease_factor - + The decrease factor. - + diff --git a/reference/fann/functions/fann-set-rprop-delta-max.xml b/reference/fann/functions/fann-set-rprop-delta-max.xml index dc4b44390..6d32d3a4b 100644 --- a/reference/fann/functions/fann-set-rprop-delta-max.xml +++ b/reference/fann/functions/fann-set-rprop-delta-max.xml @@ -14,9 +14,9 @@ resourceann floatrprop_delta_max - + The maximum step-size is a positive number determining how large the maximum step-size may be. - + @@ -31,9 +31,9 @@ rprop_delta_max - + The maximum step-size. - + diff --git a/reference/fann/functions/fann-set-rprop-delta-min.xml b/reference/fann/functions/fann-set-rprop-delta-min.xml index 79702e47b..6c3e37f63 100644 --- a/reference/fann/functions/fann-set-rprop-delta-min.xml +++ b/reference/fann/functions/fann-set-rprop-delta-min.xml @@ -14,9 +14,9 @@ resourceann floatrprop_delta_min - + The minimum step-size is a small positive number determining how small the minimum step-size may be. - + @@ -31,9 +31,9 @@ rprop_delta_min - + The minimum step-size. - + diff --git a/reference/fann/functions/fann-set-rprop-delta-zero.xml b/reference/fann/functions/fann-set-rprop-delta-zero.xml index f47e0f149..ccb2dee61 100644 --- a/reference/fann/functions/fann-set-rprop-delta-zero.xml +++ b/reference/fann/functions/fann-set-rprop-delta-zero.xml @@ -14,9 +14,9 @@ resourceann floatrprop_delta_zero - + The initial step-size is a positive number determining the initial step size. - + @@ -31,9 +31,9 @@ rprop_delta_zero - + The initial step-size. - + diff --git a/reference/fann/functions/fann-set-rprop-increase-factor.xml b/reference/fann/functions/fann-set-rprop-increase-factor.xml index 07b186986..a82bbaed3 100644 --- a/reference/fann/functions/fann-set-rprop-increase-factor.xml +++ b/reference/fann/functions/fann-set-rprop-increase-factor.xml @@ -14,9 +14,9 @@ resourceann floatrprop_increase_factor - + Sets the increase factor used during RPROP training. - + @@ -31,9 +31,9 @@ rprop_increase_factor - + The increase factor. - + diff --git a/reference/fann/functions/fann-set-sarprop-step-error-shift.xml b/reference/fann/functions/fann-set-sarprop-step-error-shift.xml index 7fc21fc90..2bba46bab 100644 --- a/reference/fann/functions/fann-set-sarprop-step-error-shift.xml +++ b/reference/fann/functions/fann-set-sarprop-step-error-shift.xml @@ -14,9 +14,9 @@ resourceann floatsarprop_step_error_shift - + Sets the sarprop step error shift. - + @@ -31,9 +31,9 @@ sarprop_step_error_shift - + The sarprop step error shift. - + diff --git a/reference/fann/functions/fann-set-sarprop-step-error-threshold-factor.xml b/reference/fann/functions/fann-set-sarprop-step-error-threshold-factor.xml index f4b2a5512..a488478e4 100644 --- a/reference/fann/functions/fann-set-sarprop-step-error-threshold-factor.xml +++ b/reference/fann/functions/fann-set-sarprop-step-error-threshold-factor.xml @@ -14,9 +14,9 @@ resourceann floatsarprop_step_error_threshold_factor - + Sets the sarprop step error threshold factor. - + @@ -31,9 +31,9 @@ sarprop_step_error_threshold_factor - + The sarprop step error threshold factor. - + diff --git a/reference/fann/functions/fann-set-sarprop-temperature.xml b/reference/fann/functions/fann-set-sarprop-temperature.xml index 7756ab3f7..fda413801 100644 --- a/reference/fann/functions/fann-set-sarprop-temperature.xml +++ b/reference/fann/functions/fann-set-sarprop-temperature.xml @@ -14,9 +14,9 @@ resourceann floatsarprop_temperature - + Sets the sarprop temperature. - + @@ -31,9 +31,9 @@ sarprop_temperature - + The sarprop temperature. - + diff --git a/reference/fann/functions/fann-set-sarprop-weight-decay-shift.xml b/reference/fann/functions/fann-set-sarprop-weight-decay-shift.xml index f21916f3d..00066cc26 100644 --- a/reference/fann/functions/fann-set-sarprop-weight-decay-shift.xml +++ b/reference/fann/functions/fann-set-sarprop-weight-decay-shift.xml @@ -14,9 +14,9 @@ resourceann floatsarprop_weight_decay_shift - + Sets the sarprop weight decay shift. - + @@ -31,9 +31,9 @@ sarprop_weight_decay_shift - + The sarprop weight decay shift. - + diff --git a/reference/fann/functions/fann-set-scaling-params.xml b/reference/fann/functions/fann-set-scaling-params.xml index c6b7db44c..006fab6c2 100644 --- a/reference/fann/functions/fann-set-scaling-params.xml +++ b/reference/fann/functions/fann-set-scaling-params.xml @@ -18,9 +18,9 @@ floatnew_output_min floatnew_output_max - + Calculate input and output scaling parameters for future use based on training data. - + @@ -41,33 +41,33 @@ new_input_min - + The desired lower bound in input data after scaling (not strictly followed) - + new_input_max - + The desired upper bound in input data after scaling (not strictly followed) - + new_output_min - + The desired lower bound in output data after scaling (not strictly followed) - + new_output_max - + The desired upper bound in output data after scaling (not strictly followed) - + diff --git a/reference/fann/functions/fann-set-train-error-function.xml b/reference/fann/functions/fann-set-train-error-function.xml index a275e1a63..3476d4e91 100644 --- a/reference/fann/functions/fann-set-train-error-function.xml +++ b/reference/fann/functions/fann-set-train-error-function.xml @@ -14,12 +14,12 @@ resourceann interror_function - + Sets the error function used during training. - - + + The error functions are described further in error functions constants. - + @@ -34,9 +34,9 @@ error_function - + The error function constant - + diff --git a/reference/fann/functions/fann-set-train-stop-function.xml b/reference/fann/functions/fann-set-train-stop-function.xml index abed909f8..dc46e382b 100644 --- a/reference/fann/functions/fann-set-train-stop-function.xml +++ b/reference/fann/functions/fann-set-train-stop-function.xml @@ -14,12 +14,12 @@ resourceann intstop_function - + Sets the stop function used during training. - - + + The stop functions are described further in stop functions constants. - + @@ -34,9 +34,9 @@ stop_function - + The stop function constant. - + diff --git a/reference/fann/functions/fann-set-training-algorithm.xml b/reference/fann/functions/fann-set-training-algorithm.xml index 8cde682ce..6d71dc969 100644 --- a/reference/fann/functions/fann-set-training-algorithm.xml +++ b/reference/fann/functions/fann-set-training-algorithm.xml @@ -14,12 +14,12 @@ resourceann inttraining_algorithm - + Sets the training algorithm. - - + + More info available in fann_get_training_algorithm. - + @@ -34,9 +34,9 @@ training_algorithm - + Training algorithm constant - + diff --git a/reference/fann/functions/fann-set-weight-array.xml b/reference/fann/functions/fann-set-weight-array.xml index 8d84b377f..a4feaf211 100644 --- a/reference/fann/functions/fann-set-weight-array.xml +++ b/reference/fann/functions/fann-set-weight-array.xml @@ -14,12 +14,12 @@ resourceann arrayconnections - + Set connections in the network. - - + + Only the weights can be changed, connections and weights are ignored if they do not already exist in the network. - + @@ -34,9 +34,9 @@ connections - + An array of FANNConnection objects - + diff --git a/reference/fann/functions/fann-set-weight.xml b/reference/fann/functions/fann-set-weight.xml index f63b86945..7f68f7a38 100644 --- a/reference/fann/functions/fann-set-weight.xml +++ b/reference/fann/functions/fann-set-weight.xml @@ -16,9 +16,9 @@ intto_neuron floatweight - + Set a connections in the network. - + @@ -33,25 +33,25 @@ from_neuron - + The neuron where the connection starts - + to_neuron - + The neuron where the connection ends - + weight - + Connection weight - + diff --git a/reference/fann/functions/fann-shuffle-train-data.xml b/reference/fann/functions/fann-shuffle-train-data.xml index 67d5afd5c..9510a3cad 100644 --- a/reference/fann/functions/fann-shuffle-train-data.xml +++ b/reference/fann/functions/fann-shuffle-train-data.xml @@ -13,10 +13,10 @@ boolfann_shuffle_train_data resourcetrain_data - + Shuffles training data, randomizing the order. This is recommended for incremental training, while it have no influence during batch training. - + diff --git a/reference/fann/functions/fann-subset-train-data.xml b/reference/fann/functions/fann-subset-train-data.xml index 37b719797..df494bd4e 100644 --- a/reference/fann/functions/fann-subset-train-data.xml +++ b/reference/fann/functions/fann-subset-train-data.xml @@ -15,14 +15,14 @@ intpos intlength - + Returns an copy of a subset of the train data resource, starting at position pos and length elements forward. - - + + The fann_subset_train_data(train_data, 0, fann_length_train_data(train_data)) do the same as fann_duplicate_train_data - + @@ -37,17 +37,17 @@ pos - + Starting position. - + length - + The number of copied elements. - + diff --git a/reference/fann/functions/fann-test-data.xml b/reference/fann/functions/fann-test-data.xml index 313e847d4..9a324a2f9 100644 --- a/reference/fann/functions/fann-test-data.xml +++ b/reference/fann/functions/fann-test-data.xml @@ -14,12 +14,12 @@ resourceann resourcedata - + Test a set of training data and calculates the MSE for the training data. - - + + This function updates the MSE and the bit fail values. - + @@ -42,9 +42,9 @@ &reftitle.returnvalues; - + The updated MSE, or &false; on error. - + diff --git a/reference/fann/functions/fann-test.xml b/reference/fann/functions/fann-test.xml index 8d2f261b1..6aae92c2a 100644 --- a/reference/fann/functions/fann-test.xml +++ b/reference/fann/functions/fann-test.xml @@ -15,10 +15,10 @@ arrayinput arraydesired_output - + Test with a set of inputs, and a set of desired outputs. This operation updates the mean square error, but does not change the network in any way. - + @@ -33,17 +33,17 @@ input - + An array of inputs. This array must be exactly fann_get_num_input long. - + desired_output - + An array of desired outputs. This array must be exactly fann_get_num_output long. - + @@ -51,7 +51,7 @@ &reftitle.returnvalues; - Returns test outputs on success, or &false; on error. + Returns test outputs on success, or &false; on error. diff --git a/reference/fann/functions/fann-train-epoch.xml b/reference/fann/functions/fann-train-epoch.xml index 06e391732..d291b7753 100644 --- a/reference/fann/functions/fann-train-epoch.xml +++ b/reference/fann/functions/fann-train-epoch.xml @@ -14,19 +14,19 @@ resourceann resourcedata - + Train one epoch with the training data stored in data. One epoch is where all of the training data is considered exactly once. - + This function returns the MSE error as it is calculated either before or during the actual training. This is not the actual MSE after the training epoch, but since calculating this would require going through the entire training set once more, it is more than adequate to use this value during training. - + The training algorithm used by this function is chosen by fann_set_training_algorithm function. - + @@ -49,9 +49,9 @@ &reftitle.returnvalues; - + The MSE, or &false; on error. - + diff --git a/reference/fann/functions/fann-train-on-data.xml b/reference/fann/functions/fann-train-on-data.xml index ea4ccb5c1..6666f87e0 100644 --- a/reference/fann/functions/fann-train-on-data.xml +++ b/reference/fann/functions/fann-train-on-data.xml @@ -17,13 +17,13 @@ intepochs_between_reports floatdesired_error - + Trains on an entire dataset for a period of time. - - + + This training uses the training algorithm chosen by fann_set_training_algorithm and the parameters set for these training algorithms. - + @@ -44,26 +44,26 @@ max_epochs - + The maximum number of epochs the training should continue - + epochs_between_reports - + The number of epochs between calling a callback function. A value of zero means that user function is not called. - + desired_error - + The desired fann_get_MSE or fann_get_bit_fail, depending on the stop function chosen by fann_set_train_stop_function - + diff --git a/reference/fann/functions/fann-train-on-file.xml b/reference/fann/functions/fann-train-on-file.xml index e0f6ec6b1..43832d54a 100644 --- a/reference/fann/functions/fann-train-on-file.xml +++ b/reference/fann/functions/fann-train-on-file.xml @@ -17,13 +17,13 @@ intepochs_between_reports floatdesired_error - + Trains on an entire dataset, which is read from file, for a period of time. - - + + This training uses the training algorithm chosen by fann_set_training_algorithm and the parameters set for these training algorithms. - + @@ -39,34 +39,34 @@ filename - + The file containing train data - + max_epochs - + The maximum number of epochs the training should continue - + epochs_between_reports - + The number of epochs between calling a user function. A value of zero means that user function is not called. - + desired_error - + The desired fann_get_MSE or fann_get_bit_fail, depending on the stop function chosen by fann_set_train_stop_function - + diff --git a/reference/fann/functions/fann-train.xml b/reference/fann/functions/fann-train.xml index a30ebadb8..9d5a042f8 100644 --- a/reference/fann/functions/fann-train.xml +++ b/reference/fann/functions/fann-train.xml @@ -15,10 +15,10 @@ arrayinput arraydesired_output - + Train one iteration with a set of inputs, and a set of desired outputs. This training is always incremental training, since only one pattern is presented. - + @@ -33,17 +33,17 @@ input - + An array of inputs. This array must be exactly fann_get_num_input long. - + desired_output - + An array of desired outputs. This array must be exactly fann_get_num_output long. - + diff --git a/reference/fann/setup.xml b/reference/fann/setup.xml index fad1af04a..aa81be541 100644 --- a/reference/fann/setup.xml +++ b/reference/fann/setup.xml @@ -6,16 +6,16 @@
&reftitle.required; - + PHP >= 5.2.0 and libfann >= 2.1.0 - +
&reftitle.install; - + The FANN PHP extension should work on all Linux systems. - + @@ -33,11 +33,11 @@ FANN Library Installation - + Before you start installation make sure that libfann is installed on your system. It's part of the main repository in the most Linux distributions (search for fann). You need a development version. - + If it is not installed, you need to install it first. Either download it from the official site or get it from your distro @@ -58,10 +58,10 @@ $ sudo apt-get install libfann-dev ]]> - + If the library is re-installed manually, then all old library file should be removed before re-installing otherwise the old library version could be linked. - +
@@ -104,9 +104,9 @@ $ sudo make install - + Make the following changes to php.ini: - + @@ -158,9 +158,9 @@ extension=fann.so
&reftitle.resources; - + - +
diff --git a/reference/fdf/book.xml b/reference/fdf/book.xml index 3aac7c4c1..da8bde6e7 100644 --- a/reference/fdf/book.xml +++ b/reference/fdf/book.xml @@ -1,17 +1,17 @@ - + Forms Data Format FDF - + &reftitle.intro; Forms Data Format (FDF) is a format for handling - forms within PDF documents. You should read the documentation at + forms within PDF documents. You should read the documentation at &spec.pdf.fdf; for more information on what FDF is and how it is used in general. @@ -48,7 +48,7 @@ - + &reference.fdf.setup; &reference.fdf.constants; &reference.fdf.examples; diff --git a/reference/fdf/configure.xml b/reference/fdf/configure.xml index 308336a88..854da30da 100644 --- a/reference/fdf/configure.xml +++ b/reference/fdf/configure.xml @@ -1,6 +1,6 @@ -
+
&reftitle.install; &pecl.info.dead; diff --git a/reference/fdf/constants.xml b/reference/fdf/constants.xml index 0168e2cb3..4c89de670 100644 --- a/reference/fdf/constants.xml +++ b/reference/fdf/constants.xml @@ -3,14 +3,14 @@ &reftitle.constants; &extension.constants; - + FDFValue (int) - - - + + + @@ -19,42 +19,42 @@ FDFStatus (int) - - - + + + - FDFFile + FDFFile (int) - - - + + + - FDFID + FDFID (int) - - - + + + - FDFFf + FDFFf (int) - - - + + + @@ -63,20 +63,20 @@ FDFSetFf (int) - - - + + + - FDFClearFf + FDFClearFf (int) - - - + + + @@ -85,53 +85,53 @@ FDFFlags (int) - - - + + + - FDFSetF + FDFSetF (int) - - - + + + - FDFClrF + FDFClrF (int) - - - + + + - FDFAP + FDFAP (int) - - - + + + - FDFAS + FDFAS (int) - - - + + + @@ -140,20 +140,20 @@ FDFAction (int) - - - + + + - FDFAA + FDFAA (int) - - - + + + @@ -162,20 +162,20 @@ FDFAPRef (int) - - - + + + - FDFIF + FDFIF (int) - - - + + + @@ -184,42 +184,42 @@ FDFEnter (int) - - - + + + - FDFExit + FDFExit (int) - - - + + + - FDFDown + FDFDown (int) - - - + + + - FDFUp + FDFUp (int) - - - + + + @@ -228,9 +228,9 @@ FDFFormat (int) - - - + + + @@ -239,64 +239,64 @@ FDFValidate (int) - - - + + + - FDFKeystroke + FDFKeystroke (int) - - - + + + - FDFCalculate + FDFCalculate (int) - - - + + + - FDFNormalAP + FDFNormalAP (int) - - - + + + - FDFRolloverAP + FDFRolloverAP (int) - - - + + + - FDFDownAP + FDFDownAP (int) - - - + + + diff --git a/reference/fdf/functions/fdf-add-doc-javascript.xml b/reference/fdf/functions/fdf-add-doc-javascript.xml index 823a5f1f7..e8467e0fa 100644 --- a/reference/fdf/functions/fdf-add-doc-javascript.xml +++ b/reference/fdf/functions/fdf-add-doc-javascript.xml @@ -1,6 +1,6 @@ - + fdf_add_doc_javascript Adds javascript code to the FDF document diff --git a/reference/fdf/functions/fdf-add-template.xml b/reference/fdf/functions/fdf-add-template.xml index 9143bb53b..1832a4883 100644 --- a/reference/fdf/functions/fdf-add-template.xml +++ b/reference/fdf/functions/fdf-add-template.xml @@ -5,7 +5,7 @@ fdf_add_template Adds a template into the FDF document - + &reftitle.description; diff --git a/reference/fdf/functions/fdf-close.xml b/reference/fdf/functions/fdf-close.xml index e96e6ad88..d1598956f 100644 --- a/reference/fdf/functions/fdf-close.xml +++ b/reference/fdf/functions/fdf-close.xml @@ -1,6 +1,6 @@ - + fdf_close Close an FDF document diff --git a/reference/fdf/functions/fdf-create.xml b/reference/fdf/functions/fdf-create.xml index c0d9347ce..a778bab8c 100644 --- a/reference/fdf/functions/fdf-create.xml +++ b/reference/fdf/functions/fdf-create.xml @@ -1,6 +1,6 @@ - + fdf_create Create a new FDF document diff --git a/reference/fdf/functions/fdf-enum-values.xml b/reference/fdf/functions/fdf-enum-values.xml index 36f9706ff..c52f86459 100644 --- a/reference/fdf/functions/fdf-enum-values.xml +++ b/reference/fdf/functions/fdf-enum-values.xml @@ -5,7 +5,7 @@ fdf_enum_values Call a user defined function for each document value - + &reftitle.description; diff --git a/reference/fdf/functions/fdf-errno.xml b/reference/fdf/functions/fdf-errno.xml index 5a03d2474..9fd9e31fc 100644 --- a/reference/fdf/functions/fdf-errno.xml +++ b/reference/fdf/functions/fdf-errno.xml @@ -1,6 +1,6 @@ - + fdf_errno Return error code for last fdf operation diff --git a/reference/fdf/functions/fdf-error.xml b/reference/fdf/functions/fdf-error.xml index fd94f600f..cbf7fdfe2 100644 --- a/reference/fdf/functions/fdf-error.xml +++ b/reference/fdf/functions/fdf-error.xml @@ -1,6 +1,6 @@ - + fdf_error Return error description for FDF error code diff --git a/reference/fdf/functions/fdf-get-ap.xml b/reference/fdf/functions/fdf-get-ap.xml index e8f2b8679..1e975a28b 100644 --- a/reference/fdf/functions/fdf-get-ap.xml +++ b/reference/fdf/functions/fdf-get-ap.xml @@ -1,6 +1,6 @@ - + fdf_get_ap Get the appearance of a field diff --git a/reference/fdf/functions/fdf-get-attachment.xml b/reference/fdf/functions/fdf-get-attachment.xml index 5a5399997..9e1366be5 100644 --- a/reference/fdf/functions/fdf-get-attachment.xml +++ b/reference/fdf/functions/fdf-get-attachment.xml @@ -1,6 +1,6 @@ - + fdf_get_attachment Extracts uploaded file embedded in the FDF diff --git a/reference/fdf/functions/fdf-get-encoding.xml b/reference/fdf/functions/fdf-get-encoding.xml index fe44fe24a..d06a12c9e 100644 --- a/reference/fdf/functions/fdf-get-encoding.xml +++ b/reference/fdf/functions/fdf-get-encoding.xml @@ -1,6 +1,6 @@ - + fdf_get_encoding Get the value of the /Encoding key diff --git a/reference/fdf/functions/fdf-get-file.xml b/reference/fdf/functions/fdf-get-file.xml index 0b1e83ce1..676582375 100644 --- a/reference/fdf/functions/fdf-get-file.xml +++ b/reference/fdf/functions/fdf-get-file.xml @@ -1,6 +1,6 @@ - + fdf_get_file Get the value of the /F key diff --git a/reference/fdf/functions/fdf-get-flags.xml b/reference/fdf/functions/fdf-get-flags.xml index 1f3a6edfe..e58074bdd 100644 --- a/reference/fdf/functions/fdf-get-flags.xml +++ b/reference/fdf/functions/fdf-get-flags.xml @@ -5,7 +5,7 @@ fdf_get_flags Gets the flags of a field - + &reftitle.description; diff --git a/reference/fdf/functions/fdf-get-opt.xml b/reference/fdf/functions/fdf-get-opt.xml index a9b24dfab..f680c74c2 100644 --- a/reference/fdf/functions/fdf-get-opt.xml +++ b/reference/fdf/functions/fdf-get-opt.xml @@ -5,7 +5,7 @@ fdf_get_opt Gets a value from the opt array of a field - + &reftitle.description; diff --git a/reference/fdf/functions/fdf-get-status.xml b/reference/fdf/functions/fdf-get-status.xml index bb3664b54..05c1ef3f2 100644 --- a/reference/fdf/functions/fdf-get-status.xml +++ b/reference/fdf/functions/fdf-get-status.xml @@ -1,6 +1,6 @@ - + fdf_get_status Get the value of the /STATUS key diff --git a/reference/fdf/functions/fdf-get-value.xml b/reference/fdf/functions/fdf-get-value.xml index 8d9854d8b..34c4c0a26 100644 --- a/reference/fdf/functions/fdf-get-value.xml +++ b/reference/fdf/functions/fdf-get-value.xml @@ -1,6 +1,6 @@ - + fdf_get_value Get the value of a field diff --git a/reference/fdf/functions/fdf-get-version.xml b/reference/fdf/functions/fdf-get-version.xml index 411fb2601..4f42fced6 100644 --- a/reference/fdf/functions/fdf-get-version.xml +++ b/reference/fdf/functions/fdf-get-version.xml @@ -1,6 +1,6 @@ - + fdf_get_version Gets version number for FDF API or file diff --git a/reference/fdf/functions/fdf-header.xml b/reference/fdf/functions/fdf-header.xml index 5b0908c49..36590acf3 100644 --- a/reference/fdf/functions/fdf-header.xml +++ b/reference/fdf/functions/fdf-header.xml @@ -1,6 +1,6 @@ - + fdf_header Sets FDF-specific output headers diff --git a/reference/fdf/functions/fdf-next-field-name.xml b/reference/fdf/functions/fdf-next-field-name.xml index 8fc131fbe..822eb8c80 100644 --- a/reference/fdf/functions/fdf-next-field-name.xml +++ b/reference/fdf/functions/fdf-next-field-name.xml @@ -1,6 +1,6 @@ - + fdf_next_field_name Get the next field name diff --git a/reference/fdf/functions/fdf-open-string.xml b/reference/fdf/functions/fdf-open-string.xml index fabfa0a36..cfa46c283 100644 --- a/reference/fdf/functions/fdf-open-string.xml +++ b/reference/fdf/functions/fdf-open-string.xml @@ -1,6 +1,6 @@ - + fdf_open_string Read a FDF document from a string diff --git a/reference/fdf/functions/fdf-open.xml b/reference/fdf/functions/fdf-open.xml index 53b2571ca..c418d772f 100644 --- a/reference/fdf/functions/fdf-open.xml +++ b/reference/fdf/functions/fdf-open.xml @@ -1,6 +1,6 @@ - + fdf_open Open a FDF document diff --git a/reference/fdf/functions/fdf-remove-item.xml b/reference/fdf/functions/fdf-remove-item.xml index f4398abcb..cb37a8653 100644 --- a/reference/fdf/functions/fdf-remove-item.xml +++ b/reference/fdf/functions/fdf-remove-item.xml @@ -5,7 +5,7 @@ fdf_remove_item Sets target frame for form - + &reftitle.description; diff --git a/reference/fdf/functions/fdf-save-string.xml b/reference/fdf/functions/fdf-save-string.xml index f5cdeb19d..ac7306c15 100644 --- a/reference/fdf/functions/fdf-save-string.xml +++ b/reference/fdf/functions/fdf-save-string.xml @@ -1,6 +1,6 @@ - + fdf_save_string Returns the FDF document as a string diff --git a/reference/fdf/functions/fdf-save.xml b/reference/fdf/functions/fdf-save.xml index a8f298ea5..793d5ce41 100644 --- a/reference/fdf/functions/fdf-save.xml +++ b/reference/fdf/functions/fdf-save.xml @@ -1,6 +1,6 @@ - + fdf_save Save a FDF document diff --git a/reference/fdf/functions/fdf-set-ap.xml b/reference/fdf/functions/fdf-set-ap.xml index d481b0c55..6634e018e 100644 --- a/reference/fdf/functions/fdf-set-ap.xml +++ b/reference/fdf/functions/fdf-set-ap.xml @@ -1,6 +1,6 @@ - + fdf_set_ap Set the appearance of a field diff --git a/reference/fdf/functions/fdf-set-encoding.xml b/reference/fdf/functions/fdf-set-encoding.xml index 02b23a6c6..80bc49233 100644 --- a/reference/fdf/functions/fdf-set-encoding.xml +++ b/reference/fdf/functions/fdf-set-encoding.xml @@ -1,6 +1,6 @@ - + fdf_set_encoding Sets FDF character encoding diff --git a/reference/fdf/functions/fdf-set-file.xml b/reference/fdf/functions/fdf-set-file.xml index 0ac7ef084..47f5e17df 100644 --- a/reference/fdf/functions/fdf-set-file.xml +++ b/reference/fdf/functions/fdf-set-file.xml @@ -1,6 +1,6 @@ - + fdf_set_file Set PDF document to display FDF data in diff --git a/reference/fdf/functions/fdf-set-flags.xml b/reference/fdf/functions/fdf-set-flags.xml index 5f3dff996..158645c31 100644 --- a/reference/fdf/functions/fdf-set-flags.xml +++ b/reference/fdf/functions/fdf-set-flags.xml @@ -1,6 +1,6 @@ - + fdf_set_flags Sets a flag of a field diff --git a/reference/fdf/functions/fdf-set-javascript-action.xml b/reference/fdf/functions/fdf-set-javascript-action.xml index 5835231d2..a46cb5347 100644 --- a/reference/fdf/functions/fdf-set-javascript-action.xml +++ b/reference/fdf/functions/fdf-set-javascript-action.xml @@ -1,6 +1,6 @@ - + fdf_set_javascript_action Sets an javascript action of a field diff --git a/reference/fdf/functions/fdf-set-on-import-javascript.xml b/reference/fdf/functions/fdf-set-on-import-javascript.xml index f74439ddc..33a451594 100644 --- a/reference/fdf/functions/fdf-set-on-import-javascript.xml +++ b/reference/fdf/functions/fdf-set-on-import-javascript.xml @@ -1,6 +1,6 @@ - + fdf_set_on_import_javascript Adds javascript code to be executed when Acrobat opens the FDF diff --git a/reference/fdf/functions/fdf-set-opt.xml b/reference/fdf/functions/fdf-set-opt.xml index 2cbeb1e6c..e2aaba621 100644 --- a/reference/fdf/functions/fdf-set-opt.xml +++ b/reference/fdf/functions/fdf-set-opt.xml @@ -1,6 +1,6 @@ - + fdf_set_opt Sets an option of a field diff --git a/reference/fdf/functions/fdf-set-status.xml b/reference/fdf/functions/fdf-set-status.xml index aff9ae493..ec3282f1f 100644 --- a/reference/fdf/functions/fdf-set-status.xml +++ b/reference/fdf/functions/fdf-set-status.xml @@ -1,6 +1,6 @@ - + fdf_set_status Set the value of the /STATUS key diff --git a/reference/fdf/functions/fdf-set-submit-form-action.xml b/reference/fdf/functions/fdf-set-submit-form-action.xml index 2d23c88c3..2f84019db 100644 --- a/reference/fdf/functions/fdf-set-submit-form-action.xml +++ b/reference/fdf/functions/fdf-set-submit-form-action.xml @@ -1,6 +1,6 @@ - + fdf_set_submit_form_action Sets a submit form action of a field diff --git a/reference/fdf/functions/fdf-set-target-frame.xml b/reference/fdf/functions/fdf-set-target-frame.xml index b7d5380bb..5f50217ca 100644 --- a/reference/fdf/functions/fdf-set-target-frame.xml +++ b/reference/fdf/functions/fdf-set-target-frame.xml @@ -1,6 +1,6 @@ - + fdf_set_target_frame Set target frame for form display diff --git a/reference/fdf/functions/fdf-set-value.xml b/reference/fdf/functions/fdf-set-value.xml index cafea9572..ca45e9912 100644 --- a/reference/fdf/functions/fdf-set-value.xml +++ b/reference/fdf/functions/fdf-set-value.xml @@ -1,6 +1,6 @@ - + fdf_set_value Set the value of a field diff --git a/reference/fdf/functions/fdf-set-version.xml b/reference/fdf/functions/fdf-set-version.xml index 2dc2cb04a..834a9bbab 100644 --- a/reference/fdf/functions/fdf-set-version.xml +++ b/reference/fdf/functions/fdf-set-version.xml @@ -1,6 +1,6 @@ - + fdf_set_version Sets version number for a FDF file diff --git a/reference/fdf/setup.xml b/reference/fdf/setup.xml index 59b85146a..7dac86b98 100644 --- a/reference/fdf/setup.xml +++ b/reference/fdf/setup.xml @@ -1,6 +1,6 @@ - + &reftitle.setup; diff --git a/reference/gearman/book.xml b/reference/gearman/book.xml index fabf4015e..f330362d7 100644 --- a/reference/gearman/book.xml +++ b/reference/gearman/book.xml @@ -1,6 +1,6 @@ - + Gearman Gearman diff --git a/reference/gearman/configure.xml b/reference/gearman/configure.xml index 6ad8137ad..e0fc525e6 100644 --- a/reference/gearman/configure.xml +++ b/reference/gearman/configure.xml @@ -1,6 +1,6 @@ -
+
&reftitle.install; diff --git a/reference/gearman/constants.xml b/reference/gearman/constants.xml index 0d72d7e4a..0fad8a553 100644 --- a/reference/gearman/constants.xml +++ b/reference/gearman/constants.xml @@ -1,6 +1,6 @@ - + &reftitle.constants; &extension.constants; diff --git a/reference/gearman/examples.xml b/reference/gearman/examples.xml index 0d0e7a157..328bdec19 100644 --- a/reference/gearman/examples.xml +++ b/reference/gearman/examples.xml @@ -1,6 +1,6 @@ - + &reftitle.examples;
Basic usage diff --git a/reference/gearman/gearmanclient.xml b/reference/gearman/gearmanclient.xml index 778ca848f..b8cae020e 100644 --- a/reference/gearman/gearmanclient.xml +++ b/reference/gearman/gearmanclient.xml @@ -1,6 +1,6 @@ - + The GearmanClient class GearmanClient diff --git a/reference/gearman/gearmanclient/addoptions.xml b/reference/gearman/gearmanclient/addoptions.xml index 8039ef67c..6fb94a238 100644 --- a/reference/gearman/gearmanclient/addoptions.xml +++ b/reference/gearman/gearmanclient/addoptions.xml @@ -1,6 +1,6 @@ - + GearmanClient::addOptions Add client options diff --git a/reference/gearman/gearmanclient/addserver.xml b/reference/gearman/gearmanclient/addserver.xml index 9a3ada521..1c529c4ac 100644 --- a/reference/gearman/gearmanclient/addserver.xml +++ b/reference/gearman/gearmanclient/addserver.xml @@ -1,6 +1,6 @@ - + GearmanClient::addServer Add a job server to the client diff --git a/reference/gearman/gearmanclient/addservers.xml b/reference/gearman/gearmanclient/addservers.xml index e2b173c45..85e406600 100644 --- a/reference/gearman/gearmanclient/addservers.xml +++ b/reference/gearman/gearmanclient/addservers.xml @@ -1,6 +1,6 @@ - + GearmanClient::addServers Add a list of job servers to the client diff --git a/reference/gearman/gearmanclient/addtask.xml b/reference/gearman/gearmanclient/addtask.xml index 13320269a..895a20feb 100644 --- a/reference/gearman/gearmanclient/addtask.xml +++ b/reference/gearman/gearmanclient/addtask.xml @@ -1,6 +1,6 @@ - + GearmanClient::addTask Add a task to be run in parallel diff --git a/reference/gearman/gearmanclient/addtaskbackground.xml b/reference/gearman/gearmanclient/addtaskbackground.xml index 63549ceb7..fb3da18a1 100644 --- a/reference/gearman/gearmanclient/addtaskbackground.xml +++ b/reference/gearman/gearmanclient/addtaskbackground.xml @@ -1,6 +1,6 @@ - + GearmanClient::addTaskBackground Add a background task to be run in parallel diff --git a/reference/gearman/gearmanclient/addtaskhigh.xml b/reference/gearman/gearmanclient/addtaskhigh.xml index db6b75276..4c81ba7dc 100644 --- a/reference/gearman/gearmanclient/addtaskhigh.xml +++ b/reference/gearman/gearmanclient/addtaskhigh.xml @@ -1,6 +1,6 @@ - + GearmanClient::addTaskHigh Add a high priority task to run in parallel diff --git a/reference/gearman/gearmanclient/addtaskhighbackground.xml b/reference/gearman/gearmanclient/addtaskhighbackground.xml index fe7c877cd..b64ade60c 100644 --- a/reference/gearman/gearmanclient/addtaskhighbackground.xml +++ b/reference/gearman/gearmanclient/addtaskhighbackground.xml @@ -1,6 +1,6 @@ - + GearmanClient::addTaskHighBackground Add a high priority background task to be run in parallel diff --git a/reference/gearman/gearmanclient/addtasklow.xml b/reference/gearman/gearmanclient/addtasklow.xml index 90d168b96..ce25cd159 100644 --- a/reference/gearman/gearmanclient/addtasklow.xml +++ b/reference/gearman/gearmanclient/addtasklow.xml @@ -1,6 +1,6 @@ - + GearmanClient::addTaskLow Add a low priority task to run in parallel diff --git a/reference/gearman/gearmanclient/addtasklowbackground.xml b/reference/gearman/gearmanclient/addtasklowbackground.xml index 808735094..49138a56a 100644 --- a/reference/gearman/gearmanclient/addtasklowbackground.xml +++ b/reference/gearman/gearmanclient/addtasklowbackground.xml @@ -1,6 +1,6 @@ - + GearmanClient::addTaskLowBackground Add a low priority background task to be run in parallel diff --git a/reference/gearman/gearmanclient/addtaskstatus.xml b/reference/gearman/gearmanclient/addtaskstatus.xml index effcff323..46d6d10cf 100644 --- a/reference/gearman/gearmanclient/addtaskstatus.xml +++ b/reference/gearman/gearmanclient/addtaskstatus.xml @@ -1,6 +1,6 @@ - + GearmanClient::addTaskStatus Add a task to get status diff --git a/reference/gearman/gearmanclient/clearcallbacks.xml b/reference/gearman/gearmanclient/clearcallbacks.xml index 114927ab1..1e1d99f5f 100644 --- a/reference/gearman/gearmanclient/clearcallbacks.xml +++ b/reference/gearman/gearmanclient/clearcallbacks.xml @@ -1,6 +1,6 @@ - + GearmanClient::clearCallbacks Clear all task callback functions diff --git a/reference/gearman/gearmanclient/clone.xml b/reference/gearman/gearmanclient/clone.xml index 7f5925895..b6b1f2432 100644 --- a/reference/gearman/gearmanclient/clone.xml +++ b/reference/gearman/gearmanclient/clone.xml @@ -1,6 +1,6 @@ - + GearmanClient::clone Create a copy of a GearmanClient object diff --git a/reference/gearman/gearmanclient/construct.xml b/reference/gearman/gearmanclient/construct.xml index 8c7f01bc4..41ca3d178 100644 --- a/reference/gearman/gearmanclient/construct.xml +++ b/reference/gearman/gearmanclient/construct.xml @@ -1,6 +1,6 @@ - + GearmanClient::__construct Create a GearmanClient instance diff --git a/reference/gearman/gearmanclient/context.xml b/reference/gearman/gearmanclient/context.xml index b9b1e5a65..78d8333d2 100644 --- a/reference/gearman/gearmanclient/context.xml +++ b/reference/gearman/gearmanclient/context.xml @@ -1,6 +1,6 @@ - + GearmanClient::context Get the application context diff --git a/reference/gearman/gearmanclient/data.xml b/reference/gearman/gearmanclient/data.xml index 1cad9960b..1d5ee8a61 100644 --- a/reference/gearman/gearmanclient/data.xml +++ b/reference/gearman/gearmanclient/data.xml @@ -1,6 +1,6 @@ - + GearmanClient::data Get the application data (deprecated) diff --git a/reference/gearman/gearmanclient/do.xml b/reference/gearman/gearmanclient/do.xml index dcc415469..e6995369b 100644 --- a/reference/gearman/gearmanclient/do.xml +++ b/reference/gearman/gearmanclient/do.xml @@ -1,6 +1,6 @@ - + GearmanClient::do Run a single task and return a result [deprecated] diff --git a/reference/gearman/gearmanclient/dobackground.xml b/reference/gearman/gearmanclient/dobackground.xml index f2aae86ee..a5f23b55a 100644 --- a/reference/gearman/gearmanclient/dobackground.xml +++ b/reference/gearman/gearmanclient/dobackground.xml @@ -1,6 +1,6 @@ - + GearmanClient::doBackground Run a task in the background diff --git a/reference/gearman/gearmanclient/dohigh.xml b/reference/gearman/gearmanclient/dohigh.xml index 2952d132b..48506bb86 100644 --- a/reference/gearman/gearmanclient/dohigh.xml +++ b/reference/gearman/gearmanclient/dohigh.xml @@ -1,6 +1,6 @@ - + GearmanClient::doHigh Run a single high priority task diff --git a/reference/gearman/gearmanclient/dohighbackground.xml b/reference/gearman/gearmanclient/dohighbackground.xml index 57cb25dec..a0b97aeed 100644 --- a/reference/gearman/gearmanclient/dohighbackground.xml +++ b/reference/gearman/gearmanclient/dohighbackground.xml @@ -1,6 +1,6 @@ - + GearmanClient::doHighBackground Run a high priority task in the background diff --git a/reference/gearman/gearmanclient/dojobhandle.xml b/reference/gearman/gearmanclient/dojobhandle.xml index d0b5e063a..b83e0928a 100644 --- a/reference/gearman/gearmanclient/dojobhandle.xml +++ b/reference/gearman/gearmanclient/dojobhandle.xml @@ -1,6 +1,6 @@ - + GearmanClient::doJobHandle Get the job handle for the running task diff --git a/reference/gearman/gearmanclient/dolow.xml b/reference/gearman/gearmanclient/dolow.xml index e2c7f8f16..c707389eb 100644 --- a/reference/gearman/gearmanclient/dolow.xml +++ b/reference/gearman/gearmanclient/dolow.xml @@ -1,6 +1,6 @@ - + GearmanClient::doLow Run a single low priority task diff --git a/reference/gearman/gearmanclient/dolowbackground.xml b/reference/gearman/gearmanclient/dolowbackground.xml index a44921345..9815bf103 100644 --- a/reference/gearman/gearmanclient/dolowbackground.xml +++ b/reference/gearman/gearmanclient/dolowbackground.xml @@ -1,6 +1,6 @@ - + GearmanClient::doLowBackground Run a low priority task in the background diff --git a/reference/gearman/gearmanclient/donormal.xml b/reference/gearman/gearmanclient/donormal.xml index 7927f0be1..9de5d6944 100644 --- a/reference/gearman/gearmanclient/donormal.xml +++ b/reference/gearman/gearmanclient/donormal.xml @@ -1,6 +1,6 @@ - + GearmanClient::doNormal Run a single task and return a result diff --git a/reference/gearman/gearmanclient/dostatus.xml b/reference/gearman/gearmanclient/dostatus.xml index 7cea79105..fc362b1bb 100644 --- a/reference/gearman/gearmanclient/dostatus.xml +++ b/reference/gearman/gearmanclient/dostatus.xml @@ -1,6 +1,6 @@ - + GearmanClient::doStatus Get the status for the running task diff --git a/reference/gearman/gearmanclient/echo.xml b/reference/gearman/gearmanclient/echo.xml index 8a0725deb..7b37d56d6 100644 --- a/reference/gearman/gearmanclient/echo.xml +++ b/reference/gearman/gearmanclient/echo.xml @@ -1,6 +1,6 @@ - + GearmanClient::echo Send data to all job servers to see if they echo it back [deprecated] diff --git a/reference/gearman/gearmanclient/error.xml b/reference/gearman/gearmanclient/error.xml index 9b5fc5b1a..ed548bde1 100644 --- a/reference/gearman/gearmanclient/error.xml +++ b/reference/gearman/gearmanclient/error.xml @@ -1,6 +1,6 @@ - + GearmanClient::error Returns an error string for the last error encountered diff --git a/reference/gearman/gearmanclient/geterrno.xml b/reference/gearman/gearmanclient/geterrno.xml index ed05d4ae1..3be7cd113 100644 --- a/reference/gearman/gearmanclient/geterrno.xml +++ b/reference/gearman/gearmanclient/geterrno.xml @@ -1,6 +1,6 @@ - + GearmanClient::getErrno Get an errno value diff --git a/reference/gearman/gearmanclient/jobstatus.xml b/reference/gearman/gearmanclient/jobstatus.xml index 66361d197..09b6fe9c2 100644 --- a/reference/gearman/gearmanclient/jobstatus.xml +++ b/reference/gearman/gearmanclient/jobstatus.xml @@ -1,6 +1,6 @@ - + GearmanClient::jobStatus gearman_job_status diff --git a/reference/gearman/gearmanclient/ping.xml b/reference/gearman/gearmanclient/ping.xml index 2e9c6e039..ecc806874 100644 --- a/reference/gearman/gearmanclient/ping.xml +++ b/reference/gearman/gearmanclient/ping.xml @@ -1,6 +1,6 @@ - + GearmanClient::ping Send data to all job servers to see if they echo it back diff --git a/reference/gearman/gearmanclient/removeoptions.xml b/reference/gearman/gearmanclient/removeoptions.xml index 563cc33f7..62202113d 100644 --- a/reference/gearman/gearmanclient/removeoptions.xml +++ b/reference/gearman/gearmanclient/removeoptions.xml @@ -1,6 +1,6 @@ - + GearmanClient::removeOptions Remove client options diff --git a/reference/gearman/gearmanclient/returncode.xml b/reference/gearman/gearmanclient/returncode.xml index f2338fe14..6b15b8378 100644 --- a/reference/gearman/gearmanclient/returncode.xml +++ b/reference/gearman/gearmanclient/returncode.xml @@ -1,6 +1,6 @@ - + GearmanClient::returnCode Get the last Gearman return code diff --git a/reference/gearman/gearmanclient/runtasks.xml b/reference/gearman/gearmanclient/runtasks.xml index e402e0e1c..c1eed792c 100644 --- a/reference/gearman/gearmanclient/runtasks.xml +++ b/reference/gearman/gearmanclient/runtasks.xml @@ -1,6 +1,6 @@ - + GearmanClient::runTasks Run a list of tasks in parallel diff --git a/reference/gearman/gearmanclient/setclientcallback.xml b/reference/gearman/gearmanclient/setclientcallback.xml index be7c5e009..ccbede276 100644 --- a/reference/gearman/gearmanclient/setclientcallback.xml +++ b/reference/gearman/gearmanclient/setclientcallback.xml @@ -1,6 +1,6 @@ - + GearmanClient::setClientCallback Callback function when there is a data packet for a task (deprecated) diff --git a/reference/gearman/gearmanclient/setcompletecallback.xml b/reference/gearman/gearmanclient/setcompletecallback.xml index 35526ecbf..6b0a0f6a3 100644 --- a/reference/gearman/gearmanclient/setcompletecallback.xml +++ b/reference/gearman/gearmanclient/setcompletecallback.xml @@ -1,6 +1,6 @@ - + GearmanClient::setCompleteCallback Set a function to be called on task completion diff --git a/reference/gearman/gearmanclient/setcontext.xml b/reference/gearman/gearmanclient/setcontext.xml index 80d994808..43db2cef7 100644 --- a/reference/gearman/gearmanclient/setcontext.xml +++ b/reference/gearman/gearmanclient/setcontext.xml @@ -1,6 +1,6 @@ - + GearmanClient::setContext Set application context diff --git a/reference/gearman/gearmanclient/setcreatedcallback.xml b/reference/gearman/gearmanclient/setcreatedcallback.xml index 2ee9194e1..958023f9a 100644 --- a/reference/gearman/gearmanclient/setcreatedcallback.xml +++ b/reference/gearman/gearmanclient/setcreatedcallback.xml @@ -1,6 +1,6 @@ - + GearmanClient::setCreatedCallback Set a callback for when a task is queued diff --git a/reference/gearman/gearmanclient/setdata.xml b/reference/gearman/gearmanclient/setdata.xml index 8f003262c..bc7fbee7f 100644 --- a/reference/gearman/gearmanclient/setdata.xml +++ b/reference/gearman/gearmanclient/setdata.xml @@ -1,6 +1,6 @@ - + GearmanClient::setData Set application data (deprecated) diff --git a/reference/gearman/gearmanclient/setdatacallback.xml b/reference/gearman/gearmanclient/setdatacallback.xml index 2e8279365..e8906c5cf 100644 --- a/reference/gearman/gearmanclient/setdatacallback.xml +++ b/reference/gearman/gearmanclient/setdatacallback.xml @@ -1,6 +1,6 @@ - + GearmanClient::setDataCallback Callback function when there is a data packet for a task diff --git a/reference/gearman/gearmanclient/setexceptioncallback.xml b/reference/gearman/gearmanclient/setexceptioncallback.xml index 3bca216cd..31366b5c6 100644 --- a/reference/gearman/gearmanclient/setexceptioncallback.xml +++ b/reference/gearman/gearmanclient/setexceptioncallback.xml @@ -1,6 +1,6 @@ - + GearmanClient::setExceptionCallback Set a callback for worker exceptions diff --git a/reference/gearman/gearmanclient/setfailcallback.xml b/reference/gearman/gearmanclient/setfailcallback.xml index 099c594cf..b5b02efb3 100644 --- a/reference/gearman/gearmanclient/setfailcallback.xml +++ b/reference/gearman/gearmanclient/setfailcallback.xml @@ -1,6 +1,6 @@ - + GearmanClient::setFailCallback Set callback for job failure diff --git a/reference/gearman/gearmanclient/setoptions.xml b/reference/gearman/gearmanclient/setoptions.xml index fa9d8ef05..bbf9dd5be 100644 --- a/reference/gearman/gearmanclient/setoptions.xml +++ b/reference/gearman/gearmanclient/setoptions.xml @@ -1,6 +1,6 @@ - + GearmanClient::setOptions Set client options diff --git a/reference/gearman/gearmanclient/setstatuscallback.xml b/reference/gearman/gearmanclient/setstatuscallback.xml index 342802a92..de2140b29 100644 --- a/reference/gearman/gearmanclient/setstatuscallback.xml +++ b/reference/gearman/gearmanclient/setstatuscallback.xml @@ -1,6 +1,6 @@ - + GearmanClient::setStatusCallback Set a callback for collecting task status diff --git a/reference/gearman/gearmanclient/settimeout.xml b/reference/gearman/gearmanclient/settimeout.xml index 5cc7acb1f..fa992f1ba 100644 --- a/reference/gearman/gearmanclient/settimeout.xml +++ b/reference/gearman/gearmanclient/settimeout.xml @@ -1,6 +1,6 @@ - + GearmanClient::setTimeout Set socket I/O activity timeout diff --git a/reference/gearman/gearmanclient/setwarningcallback.xml b/reference/gearman/gearmanclient/setwarningcallback.xml index 68b9f3ec3..a3c7a2127 100644 --- a/reference/gearman/gearmanclient/setwarningcallback.xml +++ b/reference/gearman/gearmanclient/setwarningcallback.xml @@ -1,6 +1,6 @@ - + GearmanClient::setWarningCallback Set a callback for worker warnings diff --git a/reference/gearman/gearmanclient/setworkloadcallback.xml b/reference/gearman/gearmanclient/setworkloadcallback.xml index 41cf4aedb..8ca060148 100644 --- a/reference/gearman/gearmanclient/setworkloadcallback.xml +++ b/reference/gearman/gearmanclient/setworkloadcallback.xml @@ -1,6 +1,6 @@ - + GearmanClient::setWorkloadCallback Set a callback for accepting incremental data updates diff --git a/reference/gearman/gearmanclient/timeout.xml b/reference/gearman/gearmanclient/timeout.xml index 0ea97ef9d..afc858ad0 100644 --- a/reference/gearman/gearmanclient/timeout.xml +++ b/reference/gearman/gearmanclient/timeout.xml @@ -1,6 +1,6 @@ - + GearmanClient::timeout Get current socket I/O activity timeout value diff --git a/reference/gearman/gearmanclient/wait.xml b/reference/gearman/gearmanclient/wait.xml index 79ff587cc..bd1ae8124 100644 --- a/reference/gearman/gearmanclient/wait.xml +++ b/reference/gearman/gearmanclient/wait.xml @@ -1,6 +1,6 @@ - + GearmanClient::wait Wait for I/O activity on all connections in a client diff --git a/reference/gearman/gearmanexception.xml b/reference/gearman/gearmanexception.xml index 937711b1e..3f16a7c1a 100644 --- a/reference/gearman/gearmanexception.xml +++ b/reference/gearman/gearmanexception.xml @@ -1,6 +1,6 @@ - + The GearmanException class GearmanException diff --git a/reference/gearman/gearmanjob.xml b/reference/gearman/gearmanjob.xml index e6809a1e1..46ac5636d 100644 --- a/reference/gearman/gearmanjob.xml +++ b/reference/gearman/gearmanjob.xml @@ -1,6 +1,6 @@ - + The GearmanJob class GearmanJob diff --git a/reference/gearman/gearmanjob/complete.xml b/reference/gearman/gearmanjob/complete.xml index 503f14924..876855ca5 100644 --- a/reference/gearman/gearmanjob/complete.xml +++ b/reference/gearman/gearmanjob/complete.xml @@ -1,6 +1,6 @@ - + GearmanJob::complete Send the result and complete status (deprecated) diff --git a/reference/gearman/gearmanjob/construct.xml b/reference/gearman/gearmanjob/construct.xml index 1576347c0..36e0d6ba0 100644 --- a/reference/gearman/gearmanjob/construct.xml +++ b/reference/gearman/gearmanjob/construct.xml @@ -1,6 +1,6 @@ - + GearmanJob::__construct Create a GearmanJob instance diff --git a/reference/gearman/gearmanjob/data.xml b/reference/gearman/gearmanjob/data.xml index a684e6f11..b2d650a9c 100644 --- a/reference/gearman/gearmanjob/data.xml +++ b/reference/gearman/gearmanjob/data.xml @@ -1,6 +1,6 @@ - + GearmanJob::data Send data for a running job (deprecated) diff --git a/reference/gearman/gearmanjob/exception.xml b/reference/gearman/gearmanjob/exception.xml index d0da0d662..72b117802 100644 --- a/reference/gearman/gearmanjob/exception.xml +++ b/reference/gearman/gearmanjob/exception.xml @@ -1,6 +1,6 @@ - + GearmanJob::exception Send exception for running job (deprecated) diff --git a/reference/gearman/gearmanjob/fail.xml b/reference/gearman/gearmanjob/fail.xml index c6348610b..0e6580ff0 100644 --- a/reference/gearman/gearmanjob/fail.xml +++ b/reference/gearman/gearmanjob/fail.xml @@ -1,6 +1,6 @@ - + GearmanJob::fail Send fail status (deprecated) diff --git a/reference/gearman/gearmanjob/functionname.xml b/reference/gearman/gearmanjob/functionname.xml index 55120761f..814e76c02 100644 --- a/reference/gearman/gearmanjob/functionname.xml +++ b/reference/gearman/gearmanjob/functionname.xml @@ -1,6 +1,6 @@ - + GearmanJob::functionName Get function name diff --git a/reference/gearman/gearmanjob/handle.xml b/reference/gearman/gearmanjob/handle.xml index 6c566f844..9e59ad009 100644 --- a/reference/gearman/gearmanjob/handle.xml +++ b/reference/gearman/gearmanjob/handle.xml @@ -1,6 +1,6 @@ - + GearmanJob::handle Get the job handle diff --git a/reference/gearman/gearmanjob/returncode.xml b/reference/gearman/gearmanjob/returncode.xml index e41c88c48..7e80e0e1f 100644 --- a/reference/gearman/gearmanjob/returncode.xml +++ b/reference/gearman/gearmanjob/returncode.xml @@ -1,6 +1,6 @@ - + GearmanJob::returnCode Get last return code diff --git a/reference/gearman/gearmanjob/sendcomplete.xml b/reference/gearman/gearmanjob/sendcomplete.xml index 4518c3593..364c86071 100644 --- a/reference/gearman/gearmanjob/sendcomplete.xml +++ b/reference/gearman/gearmanjob/sendcomplete.xml @@ -1,6 +1,6 @@ - + GearmanJob::sendComplete Send the result and complete status diff --git a/reference/gearman/gearmanjob/senddata.xml b/reference/gearman/gearmanjob/senddata.xml index 5d5ce173a..2aa710315 100644 --- a/reference/gearman/gearmanjob/senddata.xml +++ b/reference/gearman/gearmanjob/senddata.xml @@ -1,6 +1,6 @@ - + GearmanJob::sendData Send data for a running job diff --git a/reference/gearman/gearmanjob/sendexception.xml b/reference/gearman/gearmanjob/sendexception.xml index 19ed94858..f49aa1fcf 100644 --- a/reference/gearman/gearmanjob/sendexception.xml +++ b/reference/gearman/gearmanjob/sendexception.xml @@ -1,6 +1,6 @@ - + GearmanJob::sendException Send exception for running job (exception) diff --git a/reference/gearman/gearmanjob/sendfail.xml b/reference/gearman/gearmanjob/sendfail.xml index fbe029ad0..ba1cdf86b 100644 --- a/reference/gearman/gearmanjob/sendfail.xml +++ b/reference/gearman/gearmanjob/sendfail.xml @@ -1,6 +1,6 @@ - + GearmanJob::sendFail Send fail status diff --git a/reference/gearman/gearmanjob/sendstatus.xml b/reference/gearman/gearmanjob/sendstatus.xml index df4638770..511b4f5bc 100644 --- a/reference/gearman/gearmanjob/sendstatus.xml +++ b/reference/gearman/gearmanjob/sendstatus.xml @@ -1,6 +1,6 @@ - + GearmanJob::sendStatus Send status diff --git a/reference/gearman/gearmanjob/sendwarning.xml b/reference/gearman/gearmanjob/sendwarning.xml index a58339869..fe36d301e 100644 --- a/reference/gearman/gearmanjob/sendwarning.xml +++ b/reference/gearman/gearmanjob/sendwarning.xml @@ -1,6 +1,6 @@ - + GearmanJob::sendWarning Send a warning diff --git a/reference/gearman/gearmanjob/setreturn.xml b/reference/gearman/gearmanjob/setreturn.xml index 1c8d19052..3d5c0d674 100644 --- a/reference/gearman/gearmanjob/setreturn.xml +++ b/reference/gearman/gearmanjob/setreturn.xml @@ -1,6 +1,6 @@ - + GearmanJob::setReturn Set a return value diff --git a/reference/gearman/gearmanjob/status.xml b/reference/gearman/gearmanjob/status.xml index fc3d2523e..53898e438 100644 --- a/reference/gearman/gearmanjob/status.xml +++ b/reference/gearman/gearmanjob/status.xml @@ -1,6 +1,6 @@ - + GearmanJob::status Send status (deprecated) diff --git a/reference/gearman/gearmanjob/unique.xml b/reference/gearman/gearmanjob/unique.xml index f8502413a..41fe4e00a 100644 --- a/reference/gearman/gearmanjob/unique.xml +++ b/reference/gearman/gearmanjob/unique.xml @@ -1,6 +1,6 @@ - + GearmanJob::unique Get the unique identifier diff --git a/reference/gearman/gearmanjob/warning.xml b/reference/gearman/gearmanjob/warning.xml index 0507b0523..30b68fef7 100644 --- a/reference/gearman/gearmanjob/warning.xml +++ b/reference/gearman/gearmanjob/warning.xml @@ -1,6 +1,6 @@ - + GearmanJob::warning Send a warning (deprecated) diff --git a/reference/gearman/gearmanjob/workload.xml b/reference/gearman/gearmanjob/workload.xml index b6d3dd620..a6529fbc7 100644 --- a/reference/gearman/gearmanjob/workload.xml +++ b/reference/gearman/gearmanjob/workload.xml @@ -1,6 +1,6 @@ - + GearmanJob::workload Get workload diff --git a/reference/gearman/gearmanjob/workloadsize.xml b/reference/gearman/gearmanjob/workloadsize.xml index ddca7a5ea..5b6fe441b 100644 --- a/reference/gearman/gearmanjob/workloadsize.xml +++ b/reference/gearman/gearmanjob/workloadsize.xml @@ -1,6 +1,6 @@ - + GearmanJob::workloadSize Get size of work load diff --git a/reference/gearman/gearmantask.xml b/reference/gearman/gearmantask.xml index 90bb62a17..87f1cd732 100644 --- a/reference/gearman/gearmantask.xml +++ b/reference/gearman/gearmantask.xml @@ -1,6 +1,6 @@ - + The GearmanTask class GearmanTask diff --git a/reference/gearman/gearmantask/construct.xml b/reference/gearman/gearmantask/construct.xml index 4801bc0d3..41333528e 100644 --- a/reference/gearman/gearmantask/construct.xml +++ b/reference/gearman/gearmantask/construct.xml @@ -1,6 +1,6 @@ - + GearmanTask::__construct Create a GearmanTask instance diff --git a/reference/gearman/gearmantask/data.xml b/reference/gearman/gearmantask/data.xml index 95060de34..6bb99b51e 100644 --- a/reference/gearman/gearmantask/data.xml +++ b/reference/gearman/gearmantask/data.xml @@ -1,6 +1,6 @@ - + GearmanTask::data Get data returned for a task diff --git a/reference/gearman/gearmantask/datasize.xml b/reference/gearman/gearmantask/datasize.xml index 5479b7238..8440fe760 100644 --- a/reference/gearman/gearmantask/datasize.xml +++ b/reference/gearman/gearmantask/datasize.xml @@ -1,6 +1,6 @@ - + GearmanTask::dataSize Get the size of returned data diff --git a/reference/gearman/gearmantask/function.xml b/reference/gearman/gearmantask/function.xml index 0ee371eee..d8539c584 100644 --- a/reference/gearman/gearmantask/function.xml +++ b/reference/gearman/gearmantask/function.xml @@ -1,6 +1,6 @@ - + GearmanTask::function Get associated function name (deprecated) diff --git a/reference/gearman/gearmantask/functionname.xml b/reference/gearman/gearmantask/functionname.xml index 3231f1359..77fa6267e 100644 --- a/reference/gearman/gearmantask/functionname.xml +++ b/reference/gearman/gearmantask/functionname.xml @@ -1,6 +1,6 @@ - + GearmanTask::functionName Get associated function name diff --git a/reference/gearman/gearmantask/isknown.xml b/reference/gearman/gearmantask/isknown.xml index 541adee28..7c683f176 100644 --- a/reference/gearman/gearmantask/isknown.xml +++ b/reference/gearman/gearmantask/isknown.xml @@ -1,6 +1,6 @@ - + GearmanTask::isKnown Determine if task is known diff --git a/reference/gearman/gearmantask/isrunning.xml b/reference/gearman/gearmantask/isrunning.xml index c1e76632d..b16ac182a 100644 --- a/reference/gearman/gearmantask/isrunning.xml +++ b/reference/gearman/gearmantask/isrunning.xml @@ -1,6 +1,6 @@ - + GearmanTask::isRunning Test whether the task is currently running diff --git a/reference/gearman/gearmantask/jobhandle.xml b/reference/gearman/gearmantask/jobhandle.xml index 502f7aa7d..72f431e1c 100644 --- a/reference/gearman/gearmantask/jobhandle.xml +++ b/reference/gearman/gearmantask/jobhandle.xml @@ -1,6 +1,6 @@ - + GearmanTask::jobHandle gearman_job_handle diff --git a/reference/gearman/gearmantask/recvdata.xml b/reference/gearman/gearmantask/recvdata.xml index cdbd943dc..97ca4fa4b 100644 --- a/reference/gearman/gearmantask/recvdata.xml +++ b/reference/gearman/gearmantask/recvdata.xml @@ -1,6 +1,6 @@ - + GearmanTask::recvData Read work or result data into a buffer for a task diff --git a/reference/gearman/gearmantask/returncode.xml b/reference/gearman/gearmantask/returncode.xml index 8d1dfe8d2..556ad258c 100644 --- a/reference/gearman/gearmantask/returncode.xml +++ b/reference/gearman/gearmantask/returncode.xml @@ -1,6 +1,6 @@ - + GearmanTask::returnCode Get the last return code diff --git a/reference/gearman/gearmantask/senddata.xml b/reference/gearman/gearmantask/senddata.xml index 4aaf05d67..5754c5082 100644 --- a/reference/gearman/gearmantask/senddata.xml +++ b/reference/gearman/gearmantask/senddata.xml @@ -1,6 +1,6 @@ - + GearmanTask::sendData Send data for a task (deprecated) diff --git a/reference/gearman/gearmantask/sendworkload.xml b/reference/gearman/gearmantask/sendworkload.xml index 6e47847ec..547ef1930 100644 --- a/reference/gearman/gearmantask/sendworkload.xml +++ b/reference/gearman/gearmantask/sendworkload.xml @@ -1,6 +1,6 @@ - + GearmanTask::sendWorkload Send data for a task diff --git a/reference/gearman/gearmantask/taskdenominator.xml b/reference/gearman/gearmantask/taskdenominator.xml index 7b0ec3778..083ed15d2 100644 --- a/reference/gearman/gearmantask/taskdenominator.xml +++ b/reference/gearman/gearmantask/taskdenominator.xml @@ -1,6 +1,6 @@ - + GearmanTask::taskDenominator Get completion percentage denominator diff --git a/reference/gearman/gearmantask/tasknumerator.xml b/reference/gearman/gearmantask/tasknumerator.xml index 6343e6d3c..8fd0cbe03 100644 --- a/reference/gearman/gearmantask/tasknumerator.xml +++ b/reference/gearman/gearmantask/tasknumerator.xml @@ -1,6 +1,6 @@ - + GearmanTask::taskNumerator Get completion percentage numerator diff --git a/reference/gearman/gearmantask/unique.xml b/reference/gearman/gearmantask/unique.xml index af6742b03..7033df9e8 100644 --- a/reference/gearman/gearmantask/unique.xml +++ b/reference/gearman/gearmantask/unique.xml @@ -1,6 +1,6 @@ - + GearmanTask::unique Get the unique identifier for a task diff --git a/reference/gearman/gearmantask/uuid.xml b/reference/gearman/gearmantask/uuid.xml index f9fdfabec..21785d782 100644 --- a/reference/gearman/gearmantask/uuid.xml +++ b/reference/gearman/gearmantask/uuid.xml @@ -1,6 +1,6 @@ - + GearmanTask::uuid Get the unique identifier for a task (deprecated) diff --git a/reference/gearman/gearmanworker.xml b/reference/gearman/gearmanworker.xml index bc152dc2a..cfa5e6baf 100644 --- a/reference/gearman/gearmanworker.xml +++ b/reference/gearman/gearmanworker.xml @@ -1,6 +1,6 @@ - + The GearmanWorker class GearmanWorker diff --git a/reference/gearman/gearmanworker/addfunction.xml b/reference/gearman/gearmanworker/addfunction.xml index 0e922fc87..80798f42a 100644 --- a/reference/gearman/gearmanworker/addfunction.xml +++ b/reference/gearman/gearmanworker/addfunction.xml @@ -1,6 +1,6 @@ - + GearmanWorker::addFunction Register and add callback function diff --git a/reference/gearman/gearmanworker/addoptions.xml b/reference/gearman/gearmanworker/addoptions.xml index 7de428bdb..7e6a66096 100644 --- a/reference/gearman/gearmanworker/addoptions.xml +++ b/reference/gearman/gearmanworker/addoptions.xml @@ -1,6 +1,6 @@ - + GearmanWorker::addOptions Add worker options diff --git a/reference/gearman/gearmanworker/addserver.xml b/reference/gearman/gearmanworker/addserver.xml index f6e966d55..4c23ecb20 100644 --- a/reference/gearman/gearmanworker/addserver.xml +++ b/reference/gearman/gearmanworker/addserver.xml @@ -1,6 +1,6 @@ - + GearmanWorker::addServer Add a job server diff --git a/reference/gearman/gearmanworker/addservers.xml b/reference/gearman/gearmanworker/addservers.xml index ddf5611e0..7123efa7c 100644 --- a/reference/gearman/gearmanworker/addservers.xml +++ b/reference/gearman/gearmanworker/addservers.xml @@ -1,6 +1,6 @@ - + GearmanWorker::addServers Add job servers diff --git a/reference/gearman/gearmanworker/clone.xml b/reference/gearman/gearmanworker/clone.xml index 8ff0bfe3c..d54e726f3 100644 --- a/reference/gearman/gearmanworker/clone.xml +++ b/reference/gearman/gearmanworker/clone.xml @@ -1,6 +1,6 @@ - + GearmanWorker::clone Create a copy of the worker diff --git a/reference/gearman/gearmanworker/construct.xml b/reference/gearman/gearmanworker/construct.xml index f267e4ae8..17a81ff1f 100644 --- a/reference/gearman/gearmanworker/construct.xml +++ b/reference/gearman/gearmanworker/construct.xml @@ -1,6 +1,6 @@ - + GearmanWorker::__construct Create a GearmanWorker instance diff --git a/reference/gearman/gearmanworker/echo.xml b/reference/gearman/gearmanworker/echo.xml index ee368bd6c..37eb4968d 100644 --- a/reference/gearman/gearmanworker/echo.xml +++ b/reference/gearman/gearmanworker/echo.xml @@ -1,6 +1,6 @@ - + GearmanWorker::echo Test job server response diff --git a/reference/gearman/gearmanworker/error.xml b/reference/gearman/gearmanworker/error.xml index a039ae7c3..3372f4761 100644 --- a/reference/gearman/gearmanworker/error.xml +++ b/reference/gearman/gearmanworker/error.xml @@ -1,6 +1,6 @@ - + GearmanWorker::error Get the last error encountered diff --git a/reference/gearman/gearmanworker/geterrno.xml b/reference/gearman/gearmanworker/geterrno.xml index 7896902b2..305978fbf 100644 --- a/reference/gearman/gearmanworker/geterrno.xml +++ b/reference/gearman/gearmanworker/geterrno.xml @@ -1,6 +1,6 @@ - + GearmanWorker::getErrno Get errno diff --git a/reference/gearman/gearmanworker/options.xml b/reference/gearman/gearmanworker/options.xml index 65aee103e..9ed32709a 100644 --- a/reference/gearman/gearmanworker/options.xml +++ b/reference/gearman/gearmanworker/options.xml @@ -1,6 +1,6 @@ - + GearmanWorker::options Get worker options diff --git a/reference/gearman/gearmanworker/register.xml b/reference/gearman/gearmanworker/register.xml index 216490add..7433e7904 100644 --- a/reference/gearman/gearmanworker/register.xml +++ b/reference/gearman/gearmanworker/register.xml @@ -1,6 +1,6 @@ - + GearmanWorker::register Register a function with the job server diff --git a/reference/gearman/gearmanworker/removeoptions.xml b/reference/gearman/gearmanworker/removeoptions.xml index 6eadbc8de..14293cd10 100644 --- a/reference/gearman/gearmanworker/removeoptions.xml +++ b/reference/gearman/gearmanworker/removeoptions.xml @@ -1,6 +1,6 @@ - + GearmanWorker::removeOptions Remove worker options diff --git a/reference/gearman/gearmanworker/returncode.xml b/reference/gearman/gearmanworker/returncode.xml index 98c66af87..9303691f6 100644 --- a/reference/gearman/gearmanworker/returncode.xml +++ b/reference/gearman/gearmanworker/returncode.xml @@ -1,6 +1,6 @@ - + GearmanWorker::returnCode Get last Gearman return code diff --git a/reference/gearman/gearmanworker/setid.xml b/reference/gearman/gearmanworker/setid.xml index efedbcbee..70365f64e 100644 --- a/reference/gearman/gearmanworker/setid.xml +++ b/reference/gearman/gearmanworker/setid.xml @@ -1,6 +1,6 @@ - + GearmanWorker::setId Give the worker an identifier so it can be tracked when asking gearmand for the list of available workers diff --git a/reference/gearman/gearmanworker/setoptions.xml b/reference/gearman/gearmanworker/setoptions.xml index cbe29fa94..e45ef06eb 100644 --- a/reference/gearman/gearmanworker/setoptions.xml +++ b/reference/gearman/gearmanworker/setoptions.xml @@ -1,6 +1,6 @@ - + GearmanWorker::setOptions Set worker options diff --git a/reference/gearman/gearmanworker/settimeout.xml b/reference/gearman/gearmanworker/settimeout.xml index a60c36491..f10e89b16 100644 --- a/reference/gearman/gearmanworker/settimeout.xml +++ b/reference/gearman/gearmanworker/settimeout.xml @@ -1,6 +1,6 @@ - + GearmanWorker::setTimeout Set socket I/O activity timeout diff --git a/reference/gearman/gearmanworker/timeout.xml b/reference/gearman/gearmanworker/timeout.xml index 139ff9b08..41ac38938 100644 --- a/reference/gearman/gearmanworker/timeout.xml +++ b/reference/gearman/gearmanworker/timeout.xml @@ -1,6 +1,6 @@ - + GearmanWorker::timeout Get socket I/O activity timeout diff --git a/reference/gearman/gearmanworker/unregister.xml b/reference/gearman/gearmanworker/unregister.xml index bcb3e9a69..87d474585 100644 --- a/reference/gearman/gearmanworker/unregister.xml +++ b/reference/gearman/gearmanworker/unregister.xml @@ -1,6 +1,6 @@ - + GearmanWorker::unregister Unregister a function name with the job servers diff --git a/reference/gearman/gearmanworker/unregisterall.xml b/reference/gearman/gearmanworker/unregisterall.xml index a7f279a8d..1adf174a5 100644 --- a/reference/gearman/gearmanworker/unregisterall.xml +++ b/reference/gearman/gearmanworker/unregisterall.xml @@ -1,6 +1,6 @@ - + GearmanWorker::unregisterAll Unregister all function names with the job servers diff --git a/reference/gearman/gearmanworker/wait.xml b/reference/gearman/gearmanworker/wait.xml index 5fa726287..82c44fdfd 100644 --- a/reference/gearman/gearmanworker/wait.xml +++ b/reference/gearman/gearmanworker/wait.xml @@ -1,6 +1,6 @@ - + GearmanWorker::wait Wait for activity from one of the job servers diff --git a/reference/gearman/gearmanworker/work.xml b/reference/gearman/gearmanworker/work.xml index 99b502e63..41328d390 100644 --- a/reference/gearman/gearmanworker/work.xml +++ b/reference/gearman/gearmanworker/work.xml @@ -1,6 +1,6 @@ - + GearmanWorker::work Wait for and perform jobs diff --git a/reference/gearman/setup.xml b/reference/gearman/setup.xml index 766e836bb..86ec9735d 100644 --- a/reference/gearman/setup.xml +++ b/reference/gearman/setup.xml @@ -1,6 +1,6 @@ - + &reftitle.setup;
diff --git a/reference/gender/book.xml b/reference/gender/book.xml index e2a3a6694..f075110e0 100644 --- a/reference/gender/book.xml +++ b/reference/gender/book.xml @@ -1,6 +1,6 @@ - + Determine gender of firstnames Gender diff --git a/reference/gender/configure.xml b/reference/gender/configure.xml index 4c6aef9b1..304be26fa 100644 --- a/reference/gender/configure.xml +++ b/reference/gender/configure.xml @@ -1,6 +1,6 @@ -
+
&reftitle.install; diff --git a/reference/gender/examples.xml b/reference/gender/examples.xml index 59af8803c..4d18e9629 100644 --- a/reference/gender/examples.xml +++ b/reference/gender/examples.xml @@ -1,6 +1,6 @@ - + &reftitle.examples;
Usage example. diff --git a/reference/gender/gender.xml b/reference/gender/gender.xml index 7754aaaac..ab817503d 100644 --- a/reference/gender/gender.xml +++ b/reference/gender/gender.xml @@ -1,6 +1,6 @@ - + The Gender\Gender class Gender\Gender diff --git a/reference/gender/gender/connect.xml b/reference/gender/gender/connect.xml index 5aac0da6c..7c9a380ca 100644 --- a/reference/gender/gender/connect.xml +++ b/reference/gender/gender/connect.xml @@ -1,6 +1,6 @@ - + Gender\Gender::connect Connect to an external name dictionary diff --git a/reference/gender/gender/construct.xml b/reference/gender/gender/construct.xml index bcb6b4d4d..61ce3a2ef 100644 --- a/reference/gender/gender/construct.xml +++ b/reference/gender/gender/construct.xml @@ -1,6 +1,6 @@ - + Gender\Gender::__construct Construct the Gender object diff --git a/reference/gender/gender/country.xml b/reference/gender/gender/country.xml index 9a5c9b2c2..c4ac0b8e4 100644 --- a/reference/gender/gender/country.xml +++ b/reference/gender/gender/country.xml @@ -1,6 +1,6 @@ - + Gender\Gender::country Get textual country representation diff --git a/reference/gender/gender/get.xml b/reference/gender/gender/get.xml index 226dbe85b..fa6bad3df 100644 --- a/reference/gender/gender/get.xml +++ b/reference/gender/gender/get.xml @@ -1,6 +1,6 @@ - + Gender\Gender::get Get gender of a name diff --git a/reference/gender/gender/isnick.xml b/reference/gender/gender/isnick.xml index c37bcf7bd..d3703c73d 100644 --- a/reference/gender/gender/isnick.xml +++ b/reference/gender/gender/isnick.xml @@ -1,6 +1,6 @@ - + Gender\Gender::isNick Check if the name0 is an alias of the name1 diff --git a/reference/gender/gender/similarnames.xml b/reference/gender/gender/similarnames.xml index 038345019..710899fa3 100644 --- a/reference/gender/gender/similarnames.xml +++ b/reference/gender/gender/similarnames.xml @@ -1,6 +1,6 @@ - + Gender\Gender::similarNames Get similar names diff --git a/reference/gender/setup.xml b/reference/gender/setup.xml index 497916644..418429cc3 100644 --- a/reference/gender/setup.xml +++ b/reference/gender/setup.xml @@ -1,6 +1,6 @@ - + &reftitle.setup; - + &reftitle.constants; &extension.constants; diff --git a/reference/geoip/functions/geoip-asnum-by-name.xml b/reference/geoip/functions/geoip-asnum-by-name.xml index 675773a23..a7dd86453 100644 --- a/reference/geoip/functions/geoip-asnum-by-name.xml +++ b/reference/geoip/functions/geoip-asnum-by-name.xml @@ -1,6 +1,6 @@ - + geoip_asnum_by_name Get the Autonomous System Numbers (ASN) diff --git a/reference/geoip/functions/geoip-continent-code-by-name.xml b/reference/geoip/functions/geoip-continent-code-by-name.xml index 613b3395e..ebb14a085 100644 --- a/reference/geoip/functions/geoip-continent-code-by-name.xml +++ b/reference/geoip/functions/geoip-continent-code-by-name.xml @@ -1,6 +1,6 @@ - + geoip_continent_code_by_name Get the two letter continent code diff --git a/reference/geoip/functions/geoip-country-code-by-name.xml b/reference/geoip/functions/geoip-country-code-by-name.xml index 1407a18fe..7b10c197b 100644 --- a/reference/geoip/functions/geoip-country-code-by-name.xml +++ b/reference/geoip/functions/geoip-country-code-by-name.xml @@ -1,6 +1,6 @@ - + geoip_country_code_by_name Get the two letter country code diff --git a/reference/geoip/functions/geoip-country-code3-by-name.xml b/reference/geoip/functions/geoip-country-code3-by-name.xml index 7fc043381..fea6f8c96 100644 --- a/reference/geoip/functions/geoip-country-code3-by-name.xml +++ b/reference/geoip/functions/geoip-country-code3-by-name.xml @@ -1,6 +1,6 @@ - + geoip_country_code3_by_name Get the three letter country code diff --git a/reference/geoip/functions/geoip-country-name-by-name.xml b/reference/geoip/functions/geoip-country-name-by-name.xml index e10ae385e..657e54d63 100644 --- a/reference/geoip/functions/geoip-country-name-by-name.xml +++ b/reference/geoip/functions/geoip-country-name-by-name.xml @@ -1,6 +1,6 @@ - + geoip_country_name_by_name Get the full country name diff --git a/reference/geoip/functions/geoip-database-info.xml b/reference/geoip/functions/geoip-database-info.xml index 120d0557a..7e9c996ac 100644 --- a/reference/geoip/functions/geoip-database-info.xml +++ b/reference/geoip/functions/geoip-database-info.xml @@ -1,6 +1,6 @@ - + geoip_database_info Get GeoIP Database information diff --git a/reference/geoip/functions/geoip-db-avail.xml b/reference/geoip/functions/geoip-db-avail.xml index 583b6d665..9e9e93370 100644 --- a/reference/geoip/functions/geoip-db-avail.xml +++ b/reference/geoip/functions/geoip-db-avail.xml @@ -1,6 +1,6 @@ - + geoip_db_avail Determine if GeoIP Database is available diff --git a/reference/geoip/functions/geoip-db-filename.xml b/reference/geoip/functions/geoip-db-filename.xml index 39eaae631..50c89c310 100644 --- a/reference/geoip/functions/geoip-db-filename.xml +++ b/reference/geoip/functions/geoip-db-filename.xml @@ -1,6 +1,6 @@ - + geoip_db_filename Returns the filename of the corresponding GeoIP Database diff --git a/reference/geoip/functions/geoip-db-get-all-info.xml b/reference/geoip/functions/geoip-db-get-all-info.xml index bbdab2b2c..615f107c4 100644 --- a/reference/geoip/functions/geoip-db-get-all-info.xml +++ b/reference/geoip/functions/geoip-db-get-all-info.xml @@ -1,6 +1,6 @@ - + geoip_db_get_all_info Returns detailed information about all GeoIP database types diff --git a/reference/geoip/functions/geoip-domain-by-name.xml b/reference/geoip/functions/geoip-domain-by-name.xml index 5884d9e05..e6de8cf9f 100644 --- a/reference/geoip/functions/geoip-domain-by-name.xml +++ b/reference/geoip/functions/geoip-domain-by-name.xml @@ -1,6 +1,6 @@ - + geoip_domain_by_name Get the second level domain name diff --git a/reference/geoip/functions/geoip-id-by-name.xml b/reference/geoip/functions/geoip-id-by-name.xml index 363601c71..f59a48a27 100644 --- a/reference/geoip/functions/geoip-id-by-name.xml +++ b/reference/geoip/functions/geoip-id-by-name.xml @@ -1,6 +1,6 @@ - + geoip_id_by_name Get the Internet connection type diff --git a/reference/geoip/functions/geoip-isp-by-name.xml b/reference/geoip/functions/geoip-isp-by-name.xml index 810635307..15834479b 100644 --- a/reference/geoip/functions/geoip-isp-by-name.xml +++ b/reference/geoip/functions/geoip-isp-by-name.xml @@ -1,6 +1,6 @@ - + geoip_isp_by_name Get the Internet Service Provider (ISP) name diff --git a/reference/geoip/functions/geoip-netspeedcell-by-name.xml b/reference/geoip/functions/geoip-netspeedcell-by-name.xml index f71ac261f..579ec1154 100644 --- a/reference/geoip/functions/geoip-netspeedcell-by-name.xml +++ b/reference/geoip/functions/geoip-netspeedcell-by-name.xml @@ -1,6 +1,6 @@ - + geoip_netspeedcell_by_name Get the Internet connection speed diff --git a/reference/geoip/functions/geoip-org-by-name.xml b/reference/geoip/functions/geoip-org-by-name.xml index db7be7ae3..de37c1e64 100644 --- a/reference/geoip/functions/geoip-org-by-name.xml +++ b/reference/geoip/functions/geoip-org-by-name.xml @@ -1,6 +1,6 @@ - + geoip_org_by_name Get the organization name diff --git a/reference/geoip/functions/geoip-record-by-name.xml b/reference/geoip/functions/geoip-record-by-name.xml index 73fbef3dd..b68a47ee3 100644 --- a/reference/geoip/functions/geoip-record-by-name.xml +++ b/reference/geoip/functions/geoip-record-by-name.xml @@ -1,6 +1,6 @@ - + geoip_record_by_name Returns the detailed City information found in the GeoIP Database diff --git a/reference/geoip/functions/geoip-region-by-name.xml b/reference/geoip/functions/geoip-region-by-name.xml index af298dae6..7800593f2 100644 --- a/reference/geoip/functions/geoip-region-by-name.xml +++ b/reference/geoip/functions/geoip-region-by-name.xml @@ -1,6 +1,6 @@ - + geoip_region_by_name Get the country code and region diff --git a/reference/geoip/functions/geoip-region-name-by-code.xml b/reference/geoip/functions/geoip-region-name-by-code.xml index 73b203bc6..91b0dffe8 100644 --- a/reference/geoip/functions/geoip-region-name-by-code.xml +++ b/reference/geoip/functions/geoip-region-name-by-code.xml @@ -1,6 +1,6 @@ - + geoip_region_name_by_code Returns the region name for some country and region code combo diff --git a/reference/geoip/functions/geoip-setup-custom-directory.xml b/reference/geoip/functions/geoip-setup-custom-directory.xml index 734c05adf..95092f266 100644 --- a/reference/geoip/functions/geoip-setup-custom-directory.xml +++ b/reference/geoip/functions/geoip-setup-custom-directory.xml @@ -1,6 +1,6 @@ - + geoip_setup_custom_directory Set a custom directory for the GeoIP database diff --git a/reference/geoip/functions/geoip-time-zone-by-country-and-region.xml b/reference/geoip/functions/geoip-time-zone-by-country-and-region.xml index 9aa2eedd4..63990aa9c 100644 --- a/reference/geoip/functions/geoip-time-zone-by-country-and-region.xml +++ b/reference/geoip/functions/geoip-time-zone-by-country-and-region.xml @@ -1,6 +1,6 @@ - + geoip_time_zone_by_country_and_region Returns the time zone for some country and region code combo diff --git a/reference/geoip/ini.xml b/reference/geoip/ini.xml index 55b05fb15..b50683098 100644 --- a/reference/geoip/ini.xml +++ b/reference/geoip/ini.xml @@ -1,6 +1,6 @@ -
+
&reftitle.runtime; &extension.runtime; diff --git a/reference/geoip/setup.xml b/reference/geoip/setup.xml index 9b3f8dc77..e5275b9d4 100644 --- a/reference/geoip/setup.xml +++ b/reference/geoip/setup.xml @@ -1,6 +1,6 @@ - + &reftitle.setup;
diff --git a/reference/gmagick/book.xml b/reference/gmagick/book.xml index 74578b226..d37e6d8d2 100644 --- a/reference/gmagick/book.xml +++ b/reference/gmagick/book.xml @@ -1,7 +1,7 @@ - + Gmagick Gmagick diff --git a/reference/gmagick/constants.xml b/reference/gmagick/constants.xml index 047d80486..677875db4 100644 --- a/reference/gmagick/constants.xml +++ b/reference/gmagick/constants.xml @@ -723,7 +723,7 @@ - + @@ -734,7 +734,7 @@ - + @@ -745,7 +745,7 @@ - + @@ -759,7 +759,7 @@ - + @@ -770,7 +770,7 @@ - + @@ -781,7 +781,7 @@ - + @@ -792,7 +792,7 @@ - + @@ -806,7 +806,7 @@ - + @@ -817,7 +817,7 @@ - + @@ -828,7 +828,7 @@ - + @@ -839,7 +839,7 @@ - + @@ -850,7 +850,7 @@ - + @@ -861,7 +861,7 @@ - + @@ -872,7 +872,7 @@ - + @@ -883,7 +883,7 @@ - + @@ -894,7 +894,7 @@ - + @@ -905,7 +905,7 @@ - + @@ -916,7 +916,7 @@ - + @@ -927,7 +927,7 @@ - + @@ -938,7 +938,7 @@ - + @@ -949,7 +949,7 @@ - + @@ -960,7 +960,7 @@ - + @@ -971,7 +971,7 @@ - + @@ -985,7 +985,7 @@ - + @@ -996,7 +996,7 @@ - + @@ -1007,7 +1007,7 @@ - + @@ -1018,7 +1018,7 @@ - + @@ -1029,7 +1029,7 @@ - + @@ -1040,7 +1040,7 @@ - + @@ -1051,7 +1051,7 @@ - + @@ -1062,7 +1062,7 @@ - + @@ -1073,7 +1073,7 @@ - + @@ -1084,7 +1084,7 @@ - + @@ -1095,7 +1095,7 @@ - + @@ -1109,7 +1109,7 @@ - + @@ -1120,7 +1120,7 @@ - + @@ -1131,7 +1131,7 @@ - + @@ -1145,7 +1145,7 @@ - + @@ -1156,7 +1156,7 @@ - + @@ -1167,7 +1167,7 @@ - + @@ -1178,7 +1178,7 @@ - + @@ -1189,7 +1189,7 @@ - + @@ -1200,7 +1200,7 @@ - + @@ -1211,7 +1211,7 @@ - + @@ -1222,7 +1222,7 @@ - + @@ -1233,7 +1233,7 @@ - + @@ -1244,7 +1244,7 @@ - + @@ -1255,7 +1255,7 @@ - + @@ -1269,7 +1269,7 @@ - + @@ -1280,7 +1280,7 @@ - + @@ -1291,7 +1291,7 @@ - + @@ -1302,7 +1302,7 @@ - + @@ -1313,7 +1313,7 @@ - + @@ -1327,7 +1327,7 @@ - + @@ -1338,7 +1338,7 @@ - + @@ -1349,7 +1349,7 @@ - + @@ -1360,7 +1360,7 @@ - + @@ -1371,7 +1371,7 @@ - + @@ -1382,7 +1382,7 @@ - + @@ -1393,7 +1393,7 @@ - + @@ -1404,7 +1404,7 @@ - + @@ -1415,7 +1415,7 @@ - + @@ -1429,7 +1429,7 @@ - + @@ -1440,7 +1440,7 @@ - + @@ -1451,7 +1451,7 @@ - + @@ -1462,7 +1462,7 @@ - + @@ -1473,7 +1473,7 @@ - + @@ -1484,7 +1484,7 @@ - + @@ -1495,7 +1495,7 @@ - + @@ -1506,7 +1506,7 @@ - + @@ -1517,7 +1517,7 @@ - + @@ -1531,7 +1531,7 @@ - + @@ -1542,7 +1542,7 @@ - + @@ -1553,7 +1553,7 @@ - + @@ -1564,7 +1564,7 @@ - + @@ -1578,7 +1578,7 @@ - + @@ -1589,7 +1589,7 @@ - + @@ -1600,7 +1600,7 @@ - + @@ -1611,7 +1611,7 @@ - + @@ -1625,7 +1625,7 @@ - + @@ -1636,7 +1636,7 @@ - + @@ -1647,7 +1647,7 @@ - + @@ -1658,7 +1658,7 @@ - + @@ -1669,7 +1669,7 @@ - + @@ -1680,7 +1680,7 @@ - + @@ -1694,7 +1694,7 @@ - + @@ -1705,7 +1705,7 @@ - + @@ -1716,7 +1716,7 @@ - + @@ -1727,7 +1727,7 @@ - + @@ -1738,7 +1738,7 @@ - + @@ -1749,7 +1749,7 @@ - + @@ -1760,7 +1760,7 @@ - + @@ -1771,7 +1771,7 @@ - + @@ -1782,7 +1782,7 @@ - + @@ -1793,7 +1793,7 @@ - + @@ -1804,7 +1804,7 @@ - + @@ -1815,7 +1815,7 @@ - + @@ -1826,7 +1826,7 @@ - + @@ -1837,7 +1837,7 @@ - + @@ -1851,7 +1851,7 @@ - + @@ -1862,7 +1862,7 @@ - + @@ -1873,7 +1873,7 @@ - + @@ -1884,7 +1884,7 @@ - + @@ -1895,7 +1895,7 @@ - + @@ -1906,7 +1906,7 @@ - + @@ -1920,7 +1920,7 @@ - + @@ -1931,7 +1931,7 @@ - + @@ -1942,7 +1942,7 @@ - + @@ -1953,7 +1953,7 @@ - + @@ -1964,7 +1964,7 @@ - + @@ -1975,7 +1975,7 @@ - + @@ -1986,7 +1986,7 @@ - + @@ -2000,7 +2000,7 @@ - + @@ -2011,7 +2011,7 @@ - + @@ -2022,7 +2022,7 @@ - + @@ -2033,7 +2033,7 @@ - + @@ -2044,7 +2044,7 @@ - + @@ -2055,7 +2055,7 @@ - + @@ -2066,7 +2066,7 @@ - + @@ -2077,7 +2077,7 @@ - + @@ -2088,7 +2088,7 @@ - + @@ -2099,7 +2099,7 @@ - + @@ -2110,7 +2110,7 @@ - + @@ -2121,7 +2121,7 @@ - + @@ -2132,7 +2132,7 @@ - + @@ -2143,7 +2143,7 @@ - + @@ -2154,7 +2154,7 @@ - + @@ -2165,7 +2165,7 @@ - + @@ -2176,7 +2176,7 @@ - + @@ -2187,7 +2187,7 @@ - + @@ -2198,7 +2198,7 @@ - + @@ -2209,7 +2209,7 @@ - + @@ -2223,7 +2223,7 @@ - + @@ -2234,7 +2234,7 @@ - + @@ -2245,7 +2245,7 @@ - + @@ -2256,7 +2256,7 @@ - + @@ -2267,7 +2267,7 @@ - + @@ -2278,7 +2278,7 @@ - + @@ -2289,7 +2289,7 @@ - + @@ -2303,7 +2303,7 @@ - + @@ -2314,7 +2314,7 @@ - + @@ -2325,7 +2325,7 @@ - + @@ -2336,7 +2336,7 @@ - + @@ -2347,7 +2347,7 @@ - + @@ -2358,7 +2358,7 @@ - + @@ -2369,7 +2369,7 @@ - + @@ -2380,7 +2380,7 @@ - + @@ -2391,7 +2391,7 @@ - + @@ -2402,7 +2402,7 @@ - + @@ -2413,7 +2413,7 @@ - + @@ -2424,7 +2424,7 @@ - + @@ -2435,7 +2435,7 @@ - + @@ -2446,7 +2446,7 @@ - + @@ -2457,7 +2457,7 @@ - + @@ -2468,7 +2468,7 @@ - + @@ -2479,7 +2479,7 @@ - + @@ -2490,7 +2490,7 @@ - + @@ -2501,7 +2501,7 @@ - + @@ -2512,7 +2512,7 @@ - + @@ -2523,7 +2523,7 @@ - + @@ -2534,7 +2534,7 @@ - + @@ -2545,7 +2545,7 @@ - + @@ -2556,7 +2556,7 @@ - + @@ -2567,7 +2567,7 @@ - + @@ -2578,7 +2578,7 @@ - + @@ -2589,7 +2589,7 @@ - + @@ -2600,7 +2600,7 @@ - + @@ -2611,7 +2611,7 @@ - + @@ -2622,7 +2622,7 @@ - + @@ -2636,7 +2636,7 @@ - + @@ -2647,7 +2647,7 @@ - + @@ -2658,7 +2658,7 @@ - + @@ -2669,7 +2669,7 @@ - + @@ -2680,7 +2680,7 @@ - + @@ -2694,7 +2694,7 @@ - + @@ -2705,7 +2705,7 @@ - + @@ -2716,7 +2716,7 @@ - + @@ -2730,7 +2730,7 @@ - + @@ -2741,7 +2741,7 @@ - + @@ -2752,7 +2752,7 @@ - + @@ -2763,7 +2763,7 @@ - + @@ -2777,7 +2777,7 @@ - + @@ -2788,7 +2788,7 @@ - + @@ -2799,7 +2799,7 @@ - + @@ -2810,7 +2810,7 @@ - + @@ -2824,7 +2824,7 @@ - + @@ -2835,7 +2835,7 @@ - + @@ -2846,7 +2846,7 @@ - + @@ -2857,7 +2857,7 @@ - + @@ -2871,7 +2871,7 @@ - + @@ -2882,7 +2882,7 @@ - + @@ -2893,7 +2893,7 @@ - + @@ -2904,7 +2904,7 @@ - + @@ -2915,7 +2915,7 @@ - + @@ -2926,7 +2926,7 @@ - + @@ -2940,7 +2940,7 @@ - + @@ -2951,7 +2951,7 @@ - + @@ -2962,7 +2962,7 @@ - + @@ -2973,7 +2973,7 @@ - + @@ -2984,7 +2984,7 @@ - + @@ -2995,7 +2995,7 @@ - + @@ -3006,7 +3006,7 @@ - + @@ -3017,7 +3017,7 @@ - + @@ -3028,7 +3028,7 @@ - + diff --git a/reference/gmagick/examples.xml b/reference/gmagick/examples.xml index 7c0b8097d..0314ae066 100644 --- a/reference/gmagick/examples.xml +++ b/reference/gmagick/examples.xml @@ -1,6 +1,6 @@ - + &reftitle.examples; The following shows some common Gmagick image operations. diff --git a/reference/gmagick/gmagick.xml b/reference/gmagick/gmagick.xml index 41a532f90..f6fd84b0d 100644 --- a/reference/gmagick/gmagick.xml +++ b/reference/gmagick/gmagick.xml @@ -1,6 +1,6 @@ - + The Gmagick class Gmagick diff --git a/reference/gmagick/gmagick/addimage.xml b/reference/gmagick/gmagick/addimage.xml index e6f2d842c..7e8ad1498 100644 --- a/reference/gmagick/gmagick/addimage.xml +++ b/reference/gmagick/gmagick/addimage.xml @@ -1,6 +1,6 @@ - + Gmagick::addimage Adds new image to Gmagick object image list diff --git a/reference/gmagick/gmagick/addnoiseimage.xml b/reference/gmagick/gmagick/addnoiseimage.xml index 615cb6f26..7f2544491 100644 --- a/reference/gmagick/gmagick/addnoiseimage.xml +++ b/reference/gmagick/gmagick/addnoiseimage.xml @@ -1,6 +1,6 @@ - + Gmagick::addnoiseimage Adds random noise to the image diff --git a/reference/gmagick/gmagick/annotateimage.xml b/reference/gmagick/gmagick/annotateimage.xml index 8abdd094e..b7136014e 100644 --- a/reference/gmagick/gmagick/annotateimage.xml +++ b/reference/gmagick/gmagick/annotateimage.xml @@ -1,6 +1,6 @@ - + Gmagick::annotateimage Annotates an image with text diff --git a/reference/gmagick/gmagick/blurimage.xml b/reference/gmagick/gmagick/blurimage.xml index 8ba2b1a46..1661c45ac 100644 --- a/reference/gmagick/gmagick/blurimage.xml +++ b/reference/gmagick/gmagick/blurimage.xml @@ -1,6 +1,6 @@ - + Gmagick::blurimage Adds blur filter to image diff --git a/reference/gmagick/gmagick/borderimage.xml b/reference/gmagick/gmagick/borderimage.xml index bee568a87..db3953414 100644 --- a/reference/gmagick/gmagick/borderimage.xml +++ b/reference/gmagick/gmagick/borderimage.xml @@ -1,6 +1,6 @@ - + Gmagick::borderimage Surrounds the image with a border diff --git a/reference/gmagick/gmagick/charcoalimage.xml b/reference/gmagick/gmagick/charcoalimage.xml index 0294377f4..499510254 100644 --- a/reference/gmagick/gmagick/charcoalimage.xml +++ b/reference/gmagick/gmagick/charcoalimage.xml @@ -1,6 +1,6 @@ - + Gmagick::charcoalimage Simulates a charcoal drawing diff --git a/reference/gmagick/gmagick/chopimage.xml b/reference/gmagick/gmagick/chopimage.xml index 7718cd01b..c349520d5 100644 --- a/reference/gmagick/gmagick/chopimage.xml +++ b/reference/gmagick/gmagick/chopimage.xml @@ -1,6 +1,6 @@ - + Gmagick::chopimage Removes a region of an image and trims diff --git a/reference/gmagick/gmagick/clear.xml b/reference/gmagick/gmagick/clear.xml index 2e10eadee..1fb24a4cd 100644 --- a/reference/gmagick/gmagick/clear.xml +++ b/reference/gmagick/gmagick/clear.xml @@ -1,6 +1,6 @@ - + Gmagick::clear Clears all resources associated to Gmagick object diff --git a/reference/gmagick/gmagick/commentimage.xml b/reference/gmagick/gmagick/commentimage.xml index 7dc1298be..1cb0d2247 100644 --- a/reference/gmagick/gmagick/commentimage.xml +++ b/reference/gmagick/gmagick/commentimage.xml @@ -1,6 +1,6 @@ - + Gmagick::commentimage Adds a comment to your image diff --git a/reference/gmagick/gmagick/compositeimage.xml b/reference/gmagick/gmagick/compositeimage.xml index 523dfea96..1f07fb9e4 100644 --- a/reference/gmagick/gmagick/compositeimage.xml +++ b/reference/gmagick/gmagick/compositeimage.xml @@ -1,6 +1,6 @@ - + Gmagick::compositeimage Composite one image onto another diff --git a/reference/gmagick/gmagick/construct.xml b/reference/gmagick/gmagick/construct.xml index 75b11ac25..29c7a3e4e 100644 --- a/reference/gmagick/gmagick/construct.xml +++ b/reference/gmagick/gmagick/construct.xml @@ -1,6 +1,6 @@ - + Gmagick::__construct The Gmagick constructor diff --git a/reference/gmagick/gmagick/cropimage.xml b/reference/gmagick/gmagick/cropimage.xml index cdf809fda..c594b70fe 100644 --- a/reference/gmagick/gmagick/cropimage.xml +++ b/reference/gmagick/gmagick/cropimage.xml @@ -1,6 +1,6 @@ - + Gmagick::cropimage Extracts a region of the image diff --git a/reference/gmagick/gmagick/cropthumbnailimage.xml b/reference/gmagick/gmagick/cropthumbnailimage.xml index 55b7dce87..1bbba02e5 100644 --- a/reference/gmagick/gmagick/cropthumbnailimage.xml +++ b/reference/gmagick/gmagick/cropthumbnailimage.xml @@ -1,6 +1,6 @@ - + Gmagick::cropthumbnailimage Creates a crop thumbnail diff --git a/reference/gmagick/gmagick/current.xml b/reference/gmagick/gmagick/current.xml index 83b285c65..ca5225ae2 100644 --- a/reference/gmagick/gmagick/current.xml +++ b/reference/gmagick/gmagick/current.xml @@ -1,6 +1,6 @@ - + Gmagick::current The current purpose diff --git a/reference/gmagick/gmagick/cyclecolormapimage.xml b/reference/gmagick/gmagick/cyclecolormapimage.xml index a14faa406..4b05b2bde 100644 --- a/reference/gmagick/gmagick/cyclecolormapimage.xml +++ b/reference/gmagick/gmagick/cyclecolormapimage.xml @@ -1,6 +1,6 @@ - + Gmagick::cyclecolormapimage Displaces an image's colormap diff --git a/reference/gmagick/gmagick/deconstructimages.xml b/reference/gmagick/gmagick/deconstructimages.xml index f7b949fb7..c2cee98d6 100644 --- a/reference/gmagick/gmagick/deconstructimages.xml +++ b/reference/gmagick/gmagick/deconstructimages.xml @@ -1,6 +1,6 @@ - + Gmagick::deconstructimages Returns certain pixel differences between images diff --git a/reference/gmagick/gmagick/despeckleimage.xml b/reference/gmagick/gmagick/despeckleimage.xml index c63456b66..0e6eb8f10 100644 --- a/reference/gmagick/gmagick/despeckleimage.xml +++ b/reference/gmagick/gmagick/despeckleimage.xml @@ -1,6 +1,6 @@ - + Gmagick::despeckleimage The despeckleimage purpose diff --git a/reference/gmagick/gmagick/destroy.xml b/reference/gmagick/gmagick/destroy.xml index dc55b2e66..4f3110abb 100644 --- a/reference/gmagick/gmagick/destroy.xml +++ b/reference/gmagick/gmagick/destroy.xml @@ -1,6 +1,6 @@ - + Gmagick::destroy The destroy purpose diff --git a/reference/gmagick/gmagick/drawimage.xml b/reference/gmagick/gmagick/drawimage.xml index 17a55d332..0ff9d9020 100644 --- a/reference/gmagick/gmagick/drawimage.xml +++ b/reference/gmagick/gmagick/drawimage.xml @@ -1,6 +1,6 @@ - + Gmagick::drawimage Renders the GmagickDraw object on the current image diff --git a/reference/gmagick/gmagick/edgeimage.xml b/reference/gmagick/gmagick/edgeimage.xml index e72657c8e..3ba870fd0 100644 --- a/reference/gmagick/gmagick/edgeimage.xml +++ b/reference/gmagick/gmagick/edgeimage.xml @@ -1,6 +1,6 @@ - + Gmagick::edgeimage Enhance edges within the image diff --git a/reference/gmagick/gmagick/embossimage.xml b/reference/gmagick/gmagick/embossimage.xml index 082bd55f2..4ff313632 100644 --- a/reference/gmagick/gmagick/embossimage.xml +++ b/reference/gmagick/gmagick/embossimage.xml @@ -1,6 +1,6 @@ - + Gmagick::embossimage Returns a grayscale image with a three-dimensional effect diff --git a/reference/gmagick/gmagick/enhanceimage.xml b/reference/gmagick/gmagick/enhanceimage.xml index 59cb23349..1c3a54489 100644 --- a/reference/gmagick/gmagick/enhanceimage.xml +++ b/reference/gmagick/gmagick/enhanceimage.xml @@ -1,6 +1,6 @@ - + Gmagick::enhanceimage Improves the quality of a noisy image diff --git a/reference/gmagick/gmagick/equalizeimage.xml b/reference/gmagick/gmagick/equalizeimage.xml index 6bdb46168..7297a1ff7 100644 --- a/reference/gmagick/gmagick/equalizeimage.xml +++ b/reference/gmagick/gmagick/equalizeimage.xml @@ -1,6 +1,6 @@ - + Gmagick::equalizeimage Equalizes the image histogram diff --git a/reference/gmagick/gmagick/flipimage.xml b/reference/gmagick/gmagick/flipimage.xml index c50b23ec4..ecb7a2457 100644 --- a/reference/gmagick/gmagick/flipimage.xml +++ b/reference/gmagick/gmagick/flipimage.xml @@ -1,6 +1,6 @@ - + Gmagick::flipimage Creates a vertical mirror image diff --git a/reference/gmagick/gmagick/flopimage.xml b/reference/gmagick/gmagick/flopimage.xml index 2e0137fc4..770e702d3 100644 --- a/reference/gmagick/gmagick/flopimage.xml +++ b/reference/gmagick/gmagick/flopimage.xml @@ -1,6 +1,6 @@ - + Gmagick::flopimage Creates a horizontal mirror image diff --git a/reference/gmagick/gmagick/frameimage.xml b/reference/gmagick/gmagick/frameimage.xml index 4ade4b77b..bb7f87b76 100644 --- a/reference/gmagick/gmagick/frameimage.xml +++ b/reference/gmagick/gmagick/frameimage.xml @@ -1,6 +1,6 @@ - + Gmagick::frameimage Adds a simulated three-dimensional border diff --git a/reference/gmagick/gmagick/gammaimage.xml b/reference/gmagick/gmagick/gammaimage.xml index 64ee77a6a..98268d2b8 100644 --- a/reference/gmagick/gmagick/gammaimage.xml +++ b/reference/gmagick/gmagick/gammaimage.xml @@ -1,6 +1,6 @@ - + Gmagick::gammaimage Gamma-corrects an image diff --git a/reference/gmagick/gmagick/getcopyright.xml b/reference/gmagick/gmagick/getcopyright.xml index 930bfa014..e40ac5e58 100644 --- a/reference/gmagick/gmagick/getcopyright.xml +++ b/reference/gmagick/gmagick/getcopyright.xml @@ -1,6 +1,6 @@ - + Gmagick::getcopyright Returns the GraphicsMagick API copyright as a string diff --git a/reference/gmagick/gmagick/getfilename.xml b/reference/gmagick/gmagick/getfilename.xml index 66156ba35..ae154f780 100644 --- a/reference/gmagick/gmagick/getfilename.xml +++ b/reference/gmagick/gmagick/getfilename.xml @@ -1,6 +1,6 @@ - + Gmagick::getfilename The filename associated with an image sequence diff --git a/reference/gmagick/gmagick/getimagebackgroundcolor.xml b/reference/gmagick/gmagick/getimagebackgroundcolor.xml index 4f15964fe..7548227d0 100644 --- a/reference/gmagick/gmagick/getimagebackgroundcolor.xml +++ b/reference/gmagick/gmagick/getimagebackgroundcolor.xml @@ -1,6 +1,6 @@ - + Gmagick::getimagebackgroundcolor Returns the image background color diff --git a/reference/gmagick/gmagick/getimageblueprimary.xml b/reference/gmagick/gmagick/getimageblueprimary.xml index b2df22ced..8fa19854d 100644 --- a/reference/gmagick/gmagick/getimageblueprimary.xml +++ b/reference/gmagick/gmagick/getimageblueprimary.xml @@ -1,6 +1,6 @@ - + Gmagick::getimageblueprimary Returns the chromaticy blue primary point diff --git a/reference/gmagick/gmagick/getimagebordercolor.xml b/reference/gmagick/gmagick/getimagebordercolor.xml index 9ebbb81e1..e620b619d 100644 --- a/reference/gmagick/gmagick/getimagebordercolor.xml +++ b/reference/gmagick/gmagick/getimagebordercolor.xml @@ -1,6 +1,6 @@ - + Gmagick::getimagebordercolor Returns the image border color diff --git a/reference/gmagick/gmagick/getimagechanneldepth.xml b/reference/gmagick/gmagick/getimagechanneldepth.xml index 56ee6693d..5f4173412 100644 --- a/reference/gmagick/gmagick/getimagechanneldepth.xml +++ b/reference/gmagick/gmagick/getimagechanneldepth.xml @@ -1,6 +1,6 @@ - + Gmagick::getimagechanneldepth Gets the depth for a particular image channel diff --git a/reference/gmagick/gmagick/getimagecolors.xml b/reference/gmagick/gmagick/getimagecolors.xml index b34963933..4b4d58fe2 100644 --- a/reference/gmagick/gmagick/getimagecolors.xml +++ b/reference/gmagick/gmagick/getimagecolors.xml @@ -1,6 +1,6 @@ - + Gmagick::getimagecolors Returns the color of the specified colormap index diff --git a/reference/gmagick/gmagick/getimagecolorspace.xml b/reference/gmagick/gmagick/getimagecolorspace.xml index e08f60579..9c4a3147a 100644 --- a/reference/gmagick/gmagick/getimagecolorspace.xml +++ b/reference/gmagick/gmagick/getimagecolorspace.xml @@ -1,6 +1,6 @@ - + Gmagick::getimagecolorspace Gets the image colorspace diff --git a/reference/gmagick/gmagick/getimagecompose.xml b/reference/gmagick/gmagick/getimagecompose.xml index e000f213b..89069651f 100644 --- a/reference/gmagick/gmagick/getimagecompose.xml +++ b/reference/gmagick/gmagick/getimagecompose.xml @@ -1,6 +1,6 @@ - + Gmagick::getimagecompose Returns the composite operator associated with the image diff --git a/reference/gmagick/gmagick/getimagedelay.xml b/reference/gmagick/gmagick/getimagedelay.xml index 208ee41ca..69e9fbdd4 100644 --- a/reference/gmagick/gmagick/getimagedelay.xml +++ b/reference/gmagick/gmagick/getimagedelay.xml @@ -1,6 +1,6 @@ - + Gmagick::getimagedelay Gets the image delay diff --git a/reference/gmagick/gmagick/getimagedepth.xml b/reference/gmagick/gmagick/getimagedepth.xml index 1ccff6b1d..b689d42d1 100644 --- a/reference/gmagick/gmagick/getimagedepth.xml +++ b/reference/gmagick/gmagick/getimagedepth.xml @@ -1,6 +1,6 @@ - + Gmagick::getimagedepth Gets the depth of the image diff --git a/reference/gmagick/gmagick/getimagedispose.xml b/reference/gmagick/gmagick/getimagedispose.xml index 7a8febf8d..c9f70ad3c 100644 --- a/reference/gmagick/gmagick/getimagedispose.xml +++ b/reference/gmagick/gmagick/getimagedispose.xml @@ -1,6 +1,6 @@ - + Gmagick::getimagedispose Gets the image disposal method diff --git a/reference/gmagick/gmagick/getimageextrema.xml b/reference/gmagick/gmagick/getimageextrema.xml index 0e9fedd05..bb15fd20c 100644 --- a/reference/gmagick/gmagick/getimageextrema.xml +++ b/reference/gmagick/gmagick/getimageextrema.xml @@ -1,6 +1,6 @@ - + Gmagick::getimageextrema Gets the extrema for the image diff --git a/reference/gmagick/gmagick/getimagefilename.xml b/reference/gmagick/gmagick/getimagefilename.xml index 9cd87a07f..ba269b719 100644 --- a/reference/gmagick/gmagick/getimagefilename.xml +++ b/reference/gmagick/gmagick/getimagefilename.xml @@ -1,6 +1,6 @@ - + Gmagick::getimagefilename Returns the filename of a particular image in a sequence diff --git a/reference/gmagick/gmagick/getimageformat.xml b/reference/gmagick/gmagick/getimageformat.xml index e42f51295..8bb478438 100644 --- a/reference/gmagick/gmagick/getimageformat.xml +++ b/reference/gmagick/gmagick/getimageformat.xml @@ -1,6 +1,6 @@ - + Gmagick::getimageformat Returns the format of a particular image in a sequence diff --git a/reference/gmagick/gmagick/getimagegamma.xml b/reference/gmagick/gmagick/getimagegamma.xml index 58e4f7e5f..a31faee4e 100644 --- a/reference/gmagick/gmagick/getimagegamma.xml +++ b/reference/gmagick/gmagick/getimagegamma.xml @@ -1,6 +1,6 @@ - + Gmagick::getimagegamma Gets the image gamma diff --git a/reference/gmagick/gmagick/getimagegreenprimary.xml b/reference/gmagick/gmagick/getimagegreenprimary.xml index 1f34afa96..1a0b3135c 100644 --- a/reference/gmagick/gmagick/getimagegreenprimary.xml +++ b/reference/gmagick/gmagick/getimagegreenprimary.xml @@ -1,6 +1,6 @@ - + Gmagick::getimagegreenprimary Returns the chromaticy green primary point diff --git a/reference/gmagick/gmagick/getimageheight.xml b/reference/gmagick/gmagick/getimageheight.xml index ba129e0a7..a0b331e25 100644 --- a/reference/gmagick/gmagick/getimageheight.xml +++ b/reference/gmagick/gmagick/getimageheight.xml @@ -1,6 +1,6 @@ - + Gmagick::getimageheight Returns the image height diff --git a/reference/gmagick/gmagick/getimagehistogram.xml b/reference/gmagick/gmagick/getimagehistogram.xml index 0aaa70905..0f70e8128 100644 --- a/reference/gmagick/gmagick/getimagehistogram.xml +++ b/reference/gmagick/gmagick/getimagehistogram.xml @@ -1,6 +1,6 @@ - + Gmagick::getimagehistogram Gets the image histogram @@ -14,7 +14,7 @@ Returns the image histogram as an array of GmagickPixel objects. - Throw an GmagickException on error. + Throw an GmagickException on error. diff --git a/reference/gmagick/gmagick/getimageindex.xml b/reference/gmagick/gmagick/getimageindex.xml index cc72bd332..c385062b2 100644 --- a/reference/gmagick/gmagick/getimageindex.xml +++ b/reference/gmagick/gmagick/getimageindex.xml @@ -1,6 +1,6 @@ - + Gmagick::getimageindex Gets the index of the current active image diff --git a/reference/gmagick/gmagick/getimageinterlacescheme.xml b/reference/gmagick/gmagick/getimageinterlacescheme.xml index 25424f801..02522ab6c 100644 --- a/reference/gmagick/gmagick/getimageinterlacescheme.xml +++ b/reference/gmagick/gmagick/getimageinterlacescheme.xml @@ -1,6 +1,6 @@ - + Gmagick::getimageinterlacescheme Gets the image interlace scheme diff --git a/reference/gmagick/gmagick/getimageiterations.xml b/reference/gmagick/gmagick/getimageiterations.xml index 46394a962..22266577c 100644 --- a/reference/gmagick/gmagick/getimageiterations.xml +++ b/reference/gmagick/gmagick/getimageiterations.xml @@ -1,6 +1,6 @@ - + Gmagick::getimageiterations Gets the image iterations diff --git a/reference/gmagick/gmagick/getimagematte.xml b/reference/gmagick/gmagick/getimagematte.xml index 335ec24a1..89093a787 100644 --- a/reference/gmagick/gmagick/getimagematte.xml +++ b/reference/gmagick/gmagick/getimagematte.xml @@ -1,6 +1,6 @@ - + Gmagick::getimagematte Check if the image has a matte channel diff --git a/reference/gmagick/gmagick/getimagemattecolor.xml b/reference/gmagick/gmagick/getimagemattecolor.xml index fce7d049a..4758f4dfa 100644 --- a/reference/gmagick/gmagick/getimagemattecolor.xml +++ b/reference/gmagick/gmagick/getimagemattecolor.xml @@ -1,6 +1,6 @@ - + Gmagick::getimagemattecolor Returns the image matte color diff --git a/reference/gmagick/gmagick/getimageprofile.xml b/reference/gmagick/gmagick/getimageprofile.xml index 63460a885..d664b6bf2 100644 --- a/reference/gmagick/gmagick/getimageprofile.xml +++ b/reference/gmagick/gmagick/getimageprofile.xml @@ -1,6 +1,6 @@ - + Gmagick::getimageprofile Returns the named image profile diff --git a/reference/gmagick/gmagick/getimageredprimary.xml b/reference/gmagick/gmagick/getimageredprimary.xml index c9c71bd75..8b12a1eca 100644 --- a/reference/gmagick/gmagick/getimageredprimary.xml +++ b/reference/gmagick/gmagick/getimageredprimary.xml @@ -1,6 +1,6 @@ - + Gmagick::getimageredprimary Returns the chromaticity red primary point diff --git a/reference/gmagick/gmagick/getimagerenderingintent.xml b/reference/gmagick/gmagick/getimagerenderingintent.xml index 7640f6a63..303cc0078 100644 --- a/reference/gmagick/gmagick/getimagerenderingintent.xml +++ b/reference/gmagick/gmagick/getimagerenderingintent.xml @@ -1,6 +1,6 @@ - + Gmagick::getimagerenderingintent Gets the image rendering intent diff --git a/reference/gmagick/gmagick/getimageresolution.xml b/reference/gmagick/gmagick/getimageresolution.xml index 55b9477d4..f59f8838d 100644 --- a/reference/gmagick/gmagick/getimageresolution.xml +++ b/reference/gmagick/gmagick/getimageresolution.xml @@ -1,6 +1,6 @@ - + Gmagick::getimageresolution Gets the image X and Y resolution diff --git a/reference/gmagick/gmagick/getimagescene.xml b/reference/gmagick/gmagick/getimagescene.xml index bbc5a7bd3..1c06a0e87 100644 --- a/reference/gmagick/gmagick/getimagescene.xml +++ b/reference/gmagick/gmagick/getimagescene.xml @@ -1,6 +1,6 @@ - + Gmagick::getimagescene Gets the image scene diff --git a/reference/gmagick/gmagick/getimagesignature.xml b/reference/gmagick/gmagick/getimagesignature.xml index 8a4f0b6f0..e400f4dd1 100644 --- a/reference/gmagick/gmagick/getimagesignature.xml +++ b/reference/gmagick/gmagick/getimagesignature.xml @@ -1,6 +1,6 @@ - + Gmagick::getimagesignature Generates an SHA-256 message digest diff --git a/reference/gmagick/gmagick/getimagetype.xml b/reference/gmagick/gmagick/getimagetype.xml index 42423a9a6..bc42e18d9 100644 --- a/reference/gmagick/gmagick/getimagetype.xml +++ b/reference/gmagick/gmagick/getimagetype.xml @@ -1,6 +1,6 @@ - + Gmagick::getimagetype Gets the potential image type diff --git a/reference/gmagick/gmagick/getimageunits.xml b/reference/gmagick/gmagick/getimageunits.xml index 5161a3ead..7338439a6 100644 --- a/reference/gmagick/gmagick/getimageunits.xml +++ b/reference/gmagick/gmagick/getimageunits.xml @@ -1,6 +1,6 @@ - + Gmagick::getimageunits Gets the image units of resolution diff --git a/reference/gmagick/gmagick/getimagewhitepoint.xml b/reference/gmagick/gmagick/getimagewhitepoint.xml index a8b4b15b3..82bd5eb00 100644 --- a/reference/gmagick/gmagick/getimagewhitepoint.xml +++ b/reference/gmagick/gmagick/getimagewhitepoint.xml @@ -1,6 +1,6 @@ - + Gmagick::getimagewhitepoint Returns the chromaticity white point diff --git a/reference/gmagick/gmagick/getimagewidth.xml b/reference/gmagick/gmagick/getimagewidth.xml index 56974c76f..faafbef87 100644 --- a/reference/gmagick/gmagick/getimagewidth.xml +++ b/reference/gmagick/gmagick/getimagewidth.xml @@ -1,6 +1,6 @@ - + Gmagick::getimagewidth Returns the width of the image diff --git a/reference/gmagick/gmagick/getpackagename.xml b/reference/gmagick/gmagick/getpackagename.xml index 926894cc2..44fca3015 100644 --- a/reference/gmagick/gmagick/getpackagename.xml +++ b/reference/gmagick/gmagick/getpackagename.xml @@ -1,6 +1,6 @@ - + Gmagick::getpackagename Returns the GraphicsMagick package name diff --git a/reference/gmagick/gmagick/getquantumdepth.xml b/reference/gmagick/gmagick/getquantumdepth.xml index 843a6f2dc..919494176 100644 --- a/reference/gmagick/gmagick/getquantumdepth.xml +++ b/reference/gmagick/gmagick/getquantumdepth.xml @@ -1,6 +1,6 @@ - + Gmagick::getquantumdepth Returns the Gmagick quantum depth as a string diff --git a/reference/gmagick/gmagick/getreleasedate.xml b/reference/gmagick/gmagick/getreleasedate.xml index f4c9771cb..44557ae21 100644 --- a/reference/gmagick/gmagick/getreleasedate.xml +++ b/reference/gmagick/gmagick/getreleasedate.xml @@ -1,6 +1,6 @@ - + Gmagick::getreleasedate Returns the GraphicsMagick release date as a string diff --git a/reference/gmagick/gmagick/getsamplingfactors.xml b/reference/gmagick/gmagick/getsamplingfactors.xml index 74f8decef..88f1c404e 100644 --- a/reference/gmagick/gmagick/getsamplingfactors.xml +++ b/reference/gmagick/gmagick/getsamplingfactors.xml @@ -1,6 +1,6 @@ - + Gmagick::getsamplingfactors Gets the horizontal and vertical sampling factor diff --git a/reference/gmagick/gmagick/getsize.xml b/reference/gmagick/gmagick/getsize.xml index 74d027816..44b22f12b 100644 --- a/reference/gmagick/gmagick/getsize.xml +++ b/reference/gmagick/gmagick/getsize.xml @@ -1,6 +1,6 @@ - + Gmagick::getsize Returns the size associated with the Gmagick object diff --git a/reference/gmagick/gmagick/getversion.xml b/reference/gmagick/gmagick/getversion.xml index 1ef8372b1..e9d32e69e 100644 --- a/reference/gmagick/gmagick/getversion.xml +++ b/reference/gmagick/gmagick/getversion.xml @@ -1,6 +1,6 @@ - + Gmagick::getversion Returns the GraphicsMagick API version diff --git a/reference/gmagick/gmagick/hasnextimage.xml b/reference/gmagick/gmagick/hasnextimage.xml index d3f2739ea..92f2169f2 100644 --- a/reference/gmagick/gmagick/hasnextimage.xml +++ b/reference/gmagick/gmagick/hasnextimage.xml @@ -1,6 +1,6 @@ - + Gmagick::hasnextimage Checks if the object has more images diff --git a/reference/gmagick/gmagick/haspreviousimage.xml b/reference/gmagick/gmagick/haspreviousimage.xml index e35277739..a9f52452b 100644 --- a/reference/gmagick/gmagick/haspreviousimage.xml +++ b/reference/gmagick/gmagick/haspreviousimage.xml @@ -1,6 +1,6 @@ - + Gmagick::haspreviousimage Checks if the object has a previous image diff --git a/reference/gmagick/gmagick/implodeimage.xml b/reference/gmagick/gmagick/implodeimage.xml index b11012c51..7806053a2 100644 --- a/reference/gmagick/gmagick/implodeimage.xml +++ b/reference/gmagick/gmagick/implodeimage.xml @@ -1,6 +1,6 @@ - + Gmagick::implodeimage Creates a new image as a copy diff --git a/reference/gmagick/gmagick/labelimage.xml b/reference/gmagick/gmagick/labelimage.xml index 5a9e918de..f017bbeac 100644 --- a/reference/gmagick/gmagick/labelimage.xml +++ b/reference/gmagick/gmagick/labelimage.xml @@ -1,6 +1,6 @@ - + Gmagick::labelimage Adds a label to an image diff --git a/reference/gmagick/gmagick/levelimage.xml b/reference/gmagick/gmagick/levelimage.xml index a4135f762..e0fd7b124 100644 --- a/reference/gmagick/gmagick/levelimage.xml +++ b/reference/gmagick/gmagick/levelimage.xml @@ -1,6 +1,6 @@ - + Gmagick::levelimage Adjusts the levels of an image diff --git a/reference/gmagick/gmagick/magnifyimage.xml b/reference/gmagick/gmagick/magnifyimage.xml index d69d2cfcc..fab78dbaf 100644 --- a/reference/gmagick/gmagick/magnifyimage.xml +++ b/reference/gmagick/gmagick/magnifyimage.xml @@ -1,6 +1,6 @@ - + Gmagick::magnifyimage Scales an image proportionally 2x diff --git a/reference/gmagick/gmagick/mapimage.xml b/reference/gmagick/gmagick/mapimage.xml index bc3b67676..b9681fca8 100644 --- a/reference/gmagick/gmagick/mapimage.xml +++ b/reference/gmagick/gmagick/mapimage.xml @@ -1,6 +1,6 @@ - + Gmagick::mapimage Replaces the colors of an image with the closest color from a reference image diff --git a/reference/gmagick/gmagick/medianfilterimage.xml b/reference/gmagick/gmagick/medianfilterimage.xml index 26489ed07..801756f90 100644 --- a/reference/gmagick/gmagick/medianfilterimage.xml +++ b/reference/gmagick/gmagick/medianfilterimage.xml @@ -1,6 +1,6 @@ - + Gmagick::medianfilterimage Applies a digital filter diff --git a/reference/gmagick/gmagick/minifyimage.xml b/reference/gmagick/gmagick/minifyimage.xml index d23381eac..bf25d8956 100644 --- a/reference/gmagick/gmagick/minifyimage.xml +++ b/reference/gmagick/gmagick/minifyimage.xml @@ -1,6 +1,6 @@ - + Gmagick::minifyimage Scales an image proportionally to half its size diff --git a/reference/gmagick/gmagick/modulateimage.xml b/reference/gmagick/gmagick/modulateimage.xml index daf7d28db..6a97777d7 100644 --- a/reference/gmagick/gmagick/modulateimage.xml +++ b/reference/gmagick/gmagick/modulateimage.xml @@ -1,6 +1,6 @@ - + Gmagick::modulateimage Control the brightness, saturation, and hue diff --git a/reference/gmagick/gmagick/motionblurimage.xml b/reference/gmagick/gmagick/motionblurimage.xml index 19d0e5e99..e6d27897f 100644 --- a/reference/gmagick/gmagick/motionblurimage.xml +++ b/reference/gmagick/gmagick/motionblurimage.xml @@ -1,6 +1,6 @@ - + Gmagick::motionblurimage Simulates motion blur diff --git a/reference/gmagick/gmagick/newimage.xml b/reference/gmagick/gmagick/newimage.xml index 393c0490c..4e6f4e75e 100644 --- a/reference/gmagick/gmagick/newimage.xml +++ b/reference/gmagick/gmagick/newimage.xml @@ -1,6 +1,6 @@ - + Gmagick::newimage Creates a new image diff --git a/reference/gmagick/gmagick/nextimage.xml b/reference/gmagick/gmagick/nextimage.xml index d01a476d1..cfd8302a6 100644 --- a/reference/gmagick/gmagick/nextimage.xml +++ b/reference/gmagick/gmagick/nextimage.xml @@ -1,6 +1,6 @@ - + Gmagick::nextimage Moves to the next image diff --git a/reference/gmagick/gmagick/normalizeimage.xml b/reference/gmagick/gmagick/normalizeimage.xml index cf583c57c..dd5442437 100644 --- a/reference/gmagick/gmagick/normalizeimage.xml +++ b/reference/gmagick/gmagick/normalizeimage.xml @@ -1,6 +1,6 @@ - + Gmagick::normalizeimage Enhances the contrast of a color image diff --git a/reference/gmagick/gmagick/oilpaintimage.xml b/reference/gmagick/gmagick/oilpaintimage.xml index 632e15c3e..fbc328fa5 100644 --- a/reference/gmagick/gmagick/oilpaintimage.xml +++ b/reference/gmagick/gmagick/oilpaintimage.xml @@ -1,6 +1,6 @@ - + Gmagick::oilpaintimage Simulates an oil painting diff --git a/reference/gmagick/gmagick/previousimage.xml b/reference/gmagick/gmagick/previousimage.xml index 161f43fcb..d96c3d7c5 100644 --- a/reference/gmagick/gmagick/previousimage.xml +++ b/reference/gmagick/gmagick/previousimage.xml @@ -1,6 +1,6 @@ - + Gmagick::previousimage Move to the previous image in the object diff --git a/reference/gmagick/gmagick/profileimage.xml b/reference/gmagick/gmagick/profileimage.xml index 095106839..5afb7e472 100644 --- a/reference/gmagick/gmagick/profileimage.xml +++ b/reference/gmagick/gmagick/profileimage.xml @@ -1,6 +1,6 @@ - + Gmagick::profileimage Adds or removes a profile from an image diff --git a/reference/gmagick/gmagick/quantizeimage.xml b/reference/gmagick/gmagick/quantizeimage.xml index aa7e867ac..e0b92855b 100644 --- a/reference/gmagick/gmagick/quantizeimage.xml +++ b/reference/gmagick/gmagick/quantizeimage.xml @@ -1,6 +1,6 @@ - + Gmagick::quantizeimage Analyzes the colors within a reference image diff --git a/reference/gmagick/gmagick/quantizeimages.xml b/reference/gmagick/gmagick/quantizeimages.xml index 3f5acff04..e742c1cca 100644 --- a/reference/gmagick/gmagick/quantizeimages.xml +++ b/reference/gmagick/gmagick/quantizeimages.xml @@ -1,6 +1,6 @@ - + Gmagick::quantizeimages The quantizeimages purpose diff --git a/reference/gmagick/gmagick/queryfontmetrics.xml b/reference/gmagick/gmagick/queryfontmetrics.xml index ad2a8cdfa..35015c976 100644 --- a/reference/gmagick/gmagick/queryfontmetrics.xml +++ b/reference/gmagick/gmagick/queryfontmetrics.xml @@ -1,6 +1,6 @@ - + Gmagick::queryfontmetrics Returns an array representing the font metrics diff --git a/reference/gmagick/gmagick/queryfonts.xml b/reference/gmagick/gmagick/queryfonts.xml index 4a6b2ddd3..2c5c62338 100644 --- a/reference/gmagick/gmagick/queryfonts.xml +++ b/reference/gmagick/gmagick/queryfonts.xml @@ -1,6 +1,6 @@ - + Gmagick::queryfonts Returns the configured fonts diff --git a/reference/gmagick/gmagick/queryformats.xml b/reference/gmagick/gmagick/queryformats.xml index 033ca6d40..75532ce65 100644 --- a/reference/gmagick/gmagick/queryformats.xml +++ b/reference/gmagick/gmagick/queryformats.xml @@ -1,6 +1,6 @@ - + Gmagick::queryformats Returns formats supported by Gmagick diff --git a/reference/gmagick/gmagick/radialblurimage.xml b/reference/gmagick/gmagick/radialblurimage.xml index 705a597df..59312dedc 100644 --- a/reference/gmagick/gmagick/radialblurimage.xml +++ b/reference/gmagick/gmagick/radialblurimage.xml @@ -1,6 +1,6 @@ - + Gmagick::radialblurimage Radial blurs an image diff --git a/reference/gmagick/gmagick/raiseimage.xml b/reference/gmagick/gmagick/raiseimage.xml index 3b38d7ed4..a0cfc7927 100644 --- a/reference/gmagick/gmagick/raiseimage.xml +++ b/reference/gmagick/gmagick/raiseimage.xml @@ -1,6 +1,6 @@ - + Gmagick::raiseimage Creates a simulated 3d button-like effect diff --git a/reference/gmagick/gmagick/read.xml b/reference/gmagick/gmagick/read.xml index 9d51ed472..e5e223b18 100644 --- a/reference/gmagick/gmagick/read.xml +++ b/reference/gmagick/gmagick/read.xml @@ -1,6 +1,6 @@ - + Gmagick::read Reads image from filename diff --git a/reference/gmagick/gmagick/readimage.xml b/reference/gmagick/gmagick/readimage.xml index 0d260de40..b9ed3deed 100644 --- a/reference/gmagick/gmagick/readimage.xml +++ b/reference/gmagick/gmagick/readimage.xml @@ -1,6 +1,6 @@ - + Gmagick::readimage Reads image from filename diff --git a/reference/gmagick/gmagick/readimageblob.xml b/reference/gmagick/gmagick/readimageblob.xml index dc36d0aa4..a06ba3a08 100644 --- a/reference/gmagick/gmagick/readimageblob.xml +++ b/reference/gmagick/gmagick/readimageblob.xml @@ -1,6 +1,6 @@ - + Gmagick::readimageblob Reads image from a binary string diff --git a/reference/gmagick/gmagick/readimagefile.xml b/reference/gmagick/gmagick/readimagefile.xml index 27e8d5c10..701ef32f6 100644 --- a/reference/gmagick/gmagick/readimagefile.xml +++ b/reference/gmagick/gmagick/readimagefile.xml @@ -1,6 +1,6 @@ - + Gmagick::readimagefile The readimagefile purpose diff --git a/reference/gmagick/gmagick/reducenoiseimage.xml b/reference/gmagick/gmagick/reducenoiseimage.xml index 50a5c7322..a9a25c784 100644 --- a/reference/gmagick/gmagick/reducenoiseimage.xml +++ b/reference/gmagick/gmagick/reducenoiseimage.xml @@ -1,6 +1,6 @@ - + Gmagick::reducenoiseimage Smooths the contours of an image diff --git a/reference/gmagick/gmagick/removeimage.xml b/reference/gmagick/gmagick/removeimage.xml index e78b256a2..7ddcb22a3 100644 --- a/reference/gmagick/gmagick/removeimage.xml +++ b/reference/gmagick/gmagick/removeimage.xml @@ -1,6 +1,6 @@ - + Gmagick::removeimage Removes an image from the image list diff --git a/reference/gmagick/gmagick/removeimageprofile.xml b/reference/gmagick/gmagick/removeimageprofile.xml index 7b2fd97ff..c915f1ed3 100644 --- a/reference/gmagick/gmagick/removeimageprofile.xml +++ b/reference/gmagick/gmagick/removeimageprofile.xml @@ -1,6 +1,6 @@ - + Gmagick::removeimageprofile Removes the named image profile and returns it diff --git a/reference/gmagick/gmagick/resampleimage.xml b/reference/gmagick/gmagick/resampleimage.xml index 0535b0f9a..89cf99329 100644 --- a/reference/gmagick/gmagick/resampleimage.xml +++ b/reference/gmagick/gmagick/resampleimage.xml @@ -1,6 +1,6 @@ - + Gmagick::resampleimage Resample image to desired resolution diff --git a/reference/gmagick/gmagick/resizeimage.xml b/reference/gmagick/gmagick/resizeimage.xml index 4b784252a..94407380d 100644 --- a/reference/gmagick/gmagick/resizeimage.xml +++ b/reference/gmagick/gmagick/resizeimage.xml @@ -1,6 +1,6 @@ - + Gmagick::resizeimage Scales an image diff --git a/reference/gmagick/gmagick/rollimage.xml b/reference/gmagick/gmagick/rollimage.xml index c51173461..78e989607 100644 --- a/reference/gmagick/gmagick/rollimage.xml +++ b/reference/gmagick/gmagick/rollimage.xml @@ -1,6 +1,6 @@ - + Gmagick::rollimage Offsets an image diff --git a/reference/gmagick/gmagick/rotateimage.xml b/reference/gmagick/gmagick/rotateimage.xml index 110e79183..00d9a976c 100644 --- a/reference/gmagick/gmagick/rotateimage.xml +++ b/reference/gmagick/gmagick/rotateimage.xml @@ -1,6 +1,6 @@ - + Gmagick::rotateimage Rotates an image diff --git a/reference/gmagick/gmagick/scaleimage.xml b/reference/gmagick/gmagick/scaleimage.xml index 67a5b31db..8a13016f5 100644 --- a/reference/gmagick/gmagick/scaleimage.xml +++ b/reference/gmagick/gmagick/scaleimage.xml @@ -1,6 +1,6 @@ - + Gmagick::scaleimage Scales the size of an image diff --git a/reference/gmagick/gmagick/separateimagechannel.xml b/reference/gmagick/gmagick/separateimagechannel.xml index ae88ee460..db677512b 100644 --- a/reference/gmagick/gmagick/separateimagechannel.xml +++ b/reference/gmagick/gmagick/separateimagechannel.xml @@ -1,6 +1,6 @@ - + Gmagick::separateimagechannel Separates a channel from the image diff --git a/reference/gmagick/gmagick/setcompressionquality.xml b/reference/gmagick/gmagick/setcompressionquality.xml index 17ef1cf5f..6e4519364 100644 --- a/reference/gmagick/gmagick/setcompressionquality.xml +++ b/reference/gmagick/gmagick/setcompressionquality.xml @@ -1,6 +1,6 @@ - + Gmagick::setCompressionQuality Sets the object's default compression quality diff --git a/reference/gmagick/gmagick/setfilename.xml b/reference/gmagick/gmagick/setfilename.xml index 96104e32d..883d27a98 100644 --- a/reference/gmagick/gmagick/setfilename.xml +++ b/reference/gmagick/gmagick/setfilename.xml @@ -1,6 +1,6 @@ - + Gmagick::setfilename Sets the filename before you read or write the image diff --git a/reference/gmagick/gmagick/setimagebackgroundcolor.xml b/reference/gmagick/gmagick/setimagebackgroundcolor.xml index 59acce13a..4dfabc156 100644 --- a/reference/gmagick/gmagick/setimagebackgroundcolor.xml +++ b/reference/gmagick/gmagick/setimagebackgroundcolor.xml @@ -1,6 +1,6 @@ - + Gmagick::setimagebackgroundcolor Sets the image background color diff --git a/reference/gmagick/gmagick/setimageblueprimary.xml b/reference/gmagick/gmagick/setimageblueprimary.xml index 0c18590ed..317e25bd6 100644 --- a/reference/gmagick/gmagick/setimageblueprimary.xml +++ b/reference/gmagick/gmagick/setimageblueprimary.xml @@ -1,6 +1,6 @@ - + Gmagick::setimageblueprimary Sets the image chromaticity blue primary point diff --git a/reference/gmagick/gmagick/setimagebordercolor.xml b/reference/gmagick/gmagick/setimagebordercolor.xml index 1d20f4c0c..84ead673a 100644 --- a/reference/gmagick/gmagick/setimagebordercolor.xml +++ b/reference/gmagick/gmagick/setimagebordercolor.xml @@ -1,6 +1,6 @@ - + Gmagick::setimagebordercolor Sets the image border color diff --git a/reference/gmagick/gmagick/setimagechanneldepth.xml b/reference/gmagick/gmagick/setimagechanneldepth.xml index fa772c90e..da0cb4c95 100644 --- a/reference/gmagick/gmagick/setimagechanneldepth.xml +++ b/reference/gmagick/gmagick/setimagechanneldepth.xml @@ -1,6 +1,6 @@ - + Gmagick::setimagechanneldepth Sets the depth of a particular image channel diff --git a/reference/gmagick/gmagick/setimagecolorspace.xml b/reference/gmagick/gmagick/setimagecolorspace.xml index b6ce9dc46..8fe89a62d 100644 --- a/reference/gmagick/gmagick/setimagecolorspace.xml +++ b/reference/gmagick/gmagick/setimagecolorspace.xml @@ -1,6 +1,6 @@ - + Gmagick::setimagecolorspace Sets the image colorspace diff --git a/reference/gmagick/gmagick/setimagecompose.xml b/reference/gmagick/gmagick/setimagecompose.xml index edfb42c73..718582e17 100644 --- a/reference/gmagick/gmagick/setimagecompose.xml +++ b/reference/gmagick/gmagick/setimagecompose.xml @@ -1,6 +1,6 @@ - + Gmagick::setimagecompose Sets the image composite operator diff --git a/reference/gmagick/gmagick/setimagedelay.xml b/reference/gmagick/gmagick/setimagedelay.xml index 21fb68e95..148ee4409 100644 --- a/reference/gmagick/gmagick/setimagedelay.xml +++ b/reference/gmagick/gmagick/setimagedelay.xml @@ -1,6 +1,6 @@ - + Gmagick::setimagedelay Sets the image delay diff --git a/reference/gmagick/gmagick/setimagedepth.xml b/reference/gmagick/gmagick/setimagedepth.xml index 6def56d64..7055bf6c0 100644 --- a/reference/gmagick/gmagick/setimagedepth.xml +++ b/reference/gmagick/gmagick/setimagedepth.xml @@ -1,6 +1,6 @@ - + Gmagick::setimagedepth Sets the image depth diff --git a/reference/gmagick/gmagick/setimagedispose.xml b/reference/gmagick/gmagick/setimagedispose.xml index d9027d148..e1dbe6c42 100644 --- a/reference/gmagick/gmagick/setimagedispose.xml +++ b/reference/gmagick/gmagick/setimagedispose.xml @@ -1,6 +1,6 @@ - + Gmagick::setimagedispose Sets the image disposal method diff --git a/reference/gmagick/gmagick/setimagefilename.xml b/reference/gmagick/gmagick/setimagefilename.xml index 20d7147b3..c4d3e5398 100644 --- a/reference/gmagick/gmagick/setimagefilename.xml +++ b/reference/gmagick/gmagick/setimagefilename.xml @@ -1,6 +1,6 @@ - + Gmagick::setimagefilename Sets the filename of a particular image in a sequence diff --git a/reference/gmagick/gmagick/setimageformat.xml b/reference/gmagick/gmagick/setimageformat.xml index 095897c44..8d8783a23 100644 --- a/reference/gmagick/gmagick/setimageformat.xml +++ b/reference/gmagick/gmagick/setimageformat.xml @@ -1,6 +1,6 @@ - + Gmagick::setimageformat Sets the format of a particular image diff --git a/reference/gmagick/gmagick/setimagegamma.xml b/reference/gmagick/gmagick/setimagegamma.xml index a4ec5254e..4a7fa0dd6 100644 --- a/reference/gmagick/gmagick/setimagegamma.xml +++ b/reference/gmagick/gmagick/setimagegamma.xml @@ -1,6 +1,6 @@ - + Gmagick::setimagegamma Sets the image gamma diff --git a/reference/gmagick/gmagick/setimagegreenprimary.xml b/reference/gmagick/gmagick/setimagegreenprimary.xml index 8198eb5c0..46cff8789 100644 --- a/reference/gmagick/gmagick/setimagegreenprimary.xml +++ b/reference/gmagick/gmagick/setimagegreenprimary.xml @@ -1,6 +1,6 @@ - + Gmagick::setimagegreenprimary Sets the image chromaticity green primary point diff --git a/reference/gmagick/gmagick/setimageindex.xml b/reference/gmagick/gmagick/setimageindex.xml index ed52ee85d..1ab70d35d 100644 --- a/reference/gmagick/gmagick/setimageindex.xml +++ b/reference/gmagick/gmagick/setimageindex.xml @@ -1,6 +1,6 @@ - + Gmagick::setimageindex Set the iterator to the position in the image list specified with the index parameter diff --git a/reference/gmagick/gmagick/setimageinterlacescheme.xml b/reference/gmagick/gmagick/setimageinterlacescheme.xml index 42eb1eb5c..8e35c57d6 100644 --- a/reference/gmagick/gmagick/setimageinterlacescheme.xml +++ b/reference/gmagick/gmagick/setimageinterlacescheme.xml @@ -1,6 +1,6 @@ - + Gmagick::setimageinterlacescheme Sets the interlace scheme of the image diff --git a/reference/gmagick/gmagick/setimageiterations.xml b/reference/gmagick/gmagick/setimageiterations.xml index b2fec74da..4e168302d 100644 --- a/reference/gmagick/gmagick/setimageiterations.xml +++ b/reference/gmagick/gmagick/setimageiterations.xml @@ -1,6 +1,6 @@ - + Gmagick::setimageiterations Sets the image iterations diff --git a/reference/gmagick/gmagick/setimageprofile.xml b/reference/gmagick/gmagick/setimageprofile.xml index 417d09ffe..d7dd45fb8 100644 --- a/reference/gmagick/gmagick/setimageprofile.xml +++ b/reference/gmagick/gmagick/setimageprofile.xml @@ -1,6 +1,6 @@ - + Gmagick::setimageprofile Adds a named profile to the Gmagick object diff --git a/reference/gmagick/gmagick/setimageredprimary.xml b/reference/gmagick/gmagick/setimageredprimary.xml index e48210123..08f062681 100644 --- a/reference/gmagick/gmagick/setimageredprimary.xml +++ b/reference/gmagick/gmagick/setimageredprimary.xml @@ -1,6 +1,6 @@ - + Gmagick::setimageredprimary Sets the image chromaticity red primary point diff --git a/reference/gmagick/gmagick/setimagerenderingintent.xml b/reference/gmagick/gmagick/setimagerenderingintent.xml index e5ed8fdf5..6fa9c85a2 100644 --- a/reference/gmagick/gmagick/setimagerenderingintent.xml +++ b/reference/gmagick/gmagick/setimagerenderingintent.xml @@ -1,6 +1,6 @@ - + Gmagick::setimagerenderingintent Sets the image rendering intent diff --git a/reference/gmagick/gmagick/setimageresolution.xml b/reference/gmagick/gmagick/setimageresolution.xml index e55cd95cc..90408eb08 100644 --- a/reference/gmagick/gmagick/setimageresolution.xml +++ b/reference/gmagick/gmagick/setimageresolution.xml @@ -1,6 +1,6 @@ - + Gmagick::setimageresolution Sets the image resolution diff --git a/reference/gmagick/gmagick/setimagescene.xml b/reference/gmagick/gmagick/setimagescene.xml index 3a09b16d1..28bd4c031 100644 --- a/reference/gmagick/gmagick/setimagescene.xml +++ b/reference/gmagick/gmagick/setimagescene.xml @@ -1,6 +1,6 @@ - + Gmagick::setimagescene Sets the image scene diff --git a/reference/gmagick/gmagick/setimagetype.xml b/reference/gmagick/gmagick/setimagetype.xml index 011080abf..42239115b 100644 --- a/reference/gmagick/gmagick/setimagetype.xml +++ b/reference/gmagick/gmagick/setimagetype.xml @@ -1,6 +1,6 @@ - + Gmagick::setimagetype Sets the image type diff --git a/reference/gmagick/gmagick/setimageunits.xml b/reference/gmagick/gmagick/setimageunits.xml index 18c0abb4a..461376e0c 100644 --- a/reference/gmagick/gmagick/setimageunits.xml +++ b/reference/gmagick/gmagick/setimageunits.xml @@ -1,6 +1,6 @@ - + Gmagick::setimageunits Sets the image units of resolution diff --git a/reference/gmagick/gmagick/setimagewhitepoint.xml b/reference/gmagick/gmagick/setimagewhitepoint.xml index 3c22c070a..357e95bd3 100644 --- a/reference/gmagick/gmagick/setimagewhitepoint.xml +++ b/reference/gmagick/gmagick/setimagewhitepoint.xml @@ -1,6 +1,6 @@ - + Gmagick::setimagewhitepoint Sets the image chromaticity white point diff --git a/reference/gmagick/gmagick/setsamplingfactors.xml b/reference/gmagick/gmagick/setsamplingfactors.xml index fb5b2fe0d..b748c6f59 100644 --- a/reference/gmagick/gmagick/setsamplingfactors.xml +++ b/reference/gmagick/gmagick/setsamplingfactors.xml @@ -1,6 +1,6 @@ - + Gmagick::setsamplingfactors Sets the image sampling factors diff --git a/reference/gmagick/gmagick/setsize.xml b/reference/gmagick/gmagick/setsize.xml index 2ecab6564..ceb224c18 100644 --- a/reference/gmagick/gmagick/setsize.xml +++ b/reference/gmagick/gmagick/setsize.xml @@ -1,6 +1,6 @@ - + Gmagick::setsize Sets the size of the Gmagick object diff --git a/reference/gmagick/gmagick/shearimage.xml b/reference/gmagick/gmagick/shearimage.xml index e823bd5be..71362a17a 100644 --- a/reference/gmagick/gmagick/shearimage.xml +++ b/reference/gmagick/gmagick/shearimage.xml @@ -1,6 +1,6 @@ - + Gmagick::shearimage Creating a parallelogram diff --git a/reference/gmagick/gmagick/solarizeimage.xml b/reference/gmagick/gmagick/solarizeimage.xml index 162c866ea..13422f8df 100644 --- a/reference/gmagick/gmagick/solarizeimage.xml +++ b/reference/gmagick/gmagick/solarizeimage.xml @@ -1,6 +1,6 @@ - + Gmagick::solarizeimage Applies a solarizing effect to the image diff --git a/reference/gmagick/gmagick/spreadimage.xml b/reference/gmagick/gmagick/spreadimage.xml index f4b12fe26..445aaa621 100644 --- a/reference/gmagick/gmagick/spreadimage.xml +++ b/reference/gmagick/gmagick/spreadimage.xml @@ -1,6 +1,6 @@ - + Gmagick::spreadimage Randomly displaces each pixel in a block diff --git a/reference/gmagick/gmagick/stripimage.xml b/reference/gmagick/gmagick/stripimage.xml index 970627530..3252857ae 100644 --- a/reference/gmagick/gmagick/stripimage.xml +++ b/reference/gmagick/gmagick/stripimage.xml @@ -1,6 +1,6 @@ - + Gmagick::stripimage Strips an image of all profiles and comments diff --git a/reference/gmagick/gmagick/swirlimage.xml b/reference/gmagick/gmagick/swirlimage.xml index c68ccd0f0..199603c15 100644 --- a/reference/gmagick/gmagick/swirlimage.xml +++ b/reference/gmagick/gmagick/swirlimage.xml @@ -1,6 +1,6 @@ - + Gmagick::swirlimage Swirls the pixels about the center of the image diff --git a/reference/gmagick/gmagick/thumbnailimage.xml b/reference/gmagick/gmagick/thumbnailimage.xml index 5d14c12a5..3d39463d8 100644 --- a/reference/gmagick/gmagick/thumbnailimage.xml +++ b/reference/gmagick/gmagick/thumbnailimage.xml @@ -1,6 +1,6 @@ - + Gmagick::thumbnailimage Changes the size of an image diff --git a/reference/gmagick/gmagick/trimimage.xml b/reference/gmagick/gmagick/trimimage.xml index b741d5312..1b81e16f6 100644 --- a/reference/gmagick/gmagick/trimimage.xml +++ b/reference/gmagick/gmagick/trimimage.xml @@ -1,6 +1,6 @@ - + Gmagick::trimimage Remove edges from the image diff --git a/reference/gmagick/gmagick/write.xml b/reference/gmagick/gmagick/write.xml index 668dc1204..e8465941d 100644 --- a/reference/gmagick/gmagick/write.xml +++ b/reference/gmagick/gmagick/write.xml @@ -2,7 +2,7 @@ - + Gmagick::write &Alias; Gmagick::writeimage diff --git a/reference/gmagick/gmagick/writeimage.xml b/reference/gmagick/gmagick/writeimage.xml index 460a3dace..a7602da01 100644 --- a/reference/gmagick/gmagick/writeimage.xml +++ b/reference/gmagick/gmagick/writeimage.xml @@ -1,6 +1,6 @@ - + Gmagick::writeimage Writes an image to the specified filename diff --git a/reference/gmagick/gmagickdraw.xml b/reference/gmagick/gmagickdraw.xml index 94d3ca46e..950e02cd2 100644 --- a/reference/gmagick/gmagickdraw.xml +++ b/reference/gmagick/gmagickdraw.xml @@ -1,6 +1,6 @@ - + The GmagickDraw class GmagickDraw diff --git a/reference/gmagick/gmagickdraw/annotate.xml b/reference/gmagick/gmagickdraw/annotate.xml index 784d95b2c..d6e252cb3 100644 --- a/reference/gmagick/gmagickdraw/annotate.xml +++ b/reference/gmagick/gmagickdraw/annotate.xml @@ -1,6 +1,6 @@ - + GmagickDraw::annotate Draws text on the image diff --git a/reference/gmagick/gmagickdraw/arc.xml b/reference/gmagick/gmagickdraw/arc.xml index 35a86a8c8..967230d73 100644 --- a/reference/gmagick/gmagickdraw/arc.xml +++ b/reference/gmagick/gmagickdraw/arc.xml @@ -1,6 +1,6 @@ - + GmagickDraw::arc Draws an arc diff --git a/reference/gmagick/gmagickdraw/bezier.xml b/reference/gmagick/gmagickdraw/bezier.xml index 6244d2079..e27c06ac3 100644 --- a/reference/gmagick/gmagickdraw/bezier.xml +++ b/reference/gmagick/gmagickdraw/bezier.xml @@ -1,6 +1,6 @@ - + GmagickDraw::bezier Draws a bezier curve diff --git a/reference/gmagick/gmagickdraw/ellipse.xml b/reference/gmagick/gmagickdraw/ellipse.xml index 7244280b7..040a87861 100644 --- a/reference/gmagick/gmagickdraw/ellipse.xml +++ b/reference/gmagick/gmagickdraw/ellipse.xml @@ -1,6 +1,6 @@ - + GmagickDraw::ellipse Draws an ellipse on the image diff --git a/reference/gmagick/gmagickdraw/getfillcolor.xml b/reference/gmagick/gmagickdraw/getfillcolor.xml index 46e7b58b9..711f0e713 100644 --- a/reference/gmagick/gmagickdraw/getfillcolor.xml +++ b/reference/gmagick/gmagickdraw/getfillcolor.xml @@ -1,6 +1,6 @@ - + GmagickDraw::getfillcolor Returns the fill color diff --git a/reference/gmagick/gmagickdraw/getfillopacity.xml b/reference/gmagick/gmagickdraw/getfillopacity.xml index 9cc182f19..e2eb232c3 100644 --- a/reference/gmagick/gmagickdraw/getfillopacity.xml +++ b/reference/gmagick/gmagickdraw/getfillopacity.xml @@ -1,6 +1,6 @@ - + GmagickDraw::getfillopacity Returns the opacity used when drawing diff --git a/reference/gmagick/gmagickdraw/getfont.xml b/reference/gmagick/gmagickdraw/getfont.xml index 345c9c5b4..f165351a1 100644 --- a/reference/gmagick/gmagickdraw/getfont.xml +++ b/reference/gmagick/gmagickdraw/getfont.xml @@ -1,6 +1,6 @@ - + GmagickDraw::getfont Returns the font diff --git a/reference/gmagick/gmagickdraw/getfontsize.xml b/reference/gmagick/gmagickdraw/getfontsize.xml index 2481e8a89..8734723fa 100644 --- a/reference/gmagick/gmagickdraw/getfontsize.xml +++ b/reference/gmagick/gmagickdraw/getfontsize.xml @@ -1,6 +1,6 @@ - + GmagickDraw::getfontsize Returns the font pointsize diff --git a/reference/gmagick/gmagickdraw/getfontstyle.xml b/reference/gmagick/gmagickdraw/getfontstyle.xml index 7418430b7..28c05c1a7 100644 --- a/reference/gmagick/gmagickdraw/getfontstyle.xml +++ b/reference/gmagick/gmagickdraw/getfontstyle.xml @@ -1,6 +1,6 @@ - + GmagickDraw::getfontstyle Returns the font style diff --git a/reference/gmagick/gmagickdraw/getfontweight.xml b/reference/gmagick/gmagickdraw/getfontweight.xml index ff0095ac9..6d27b035a 100644 --- a/reference/gmagick/gmagickdraw/getfontweight.xml +++ b/reference/gmagick/gmagickdraw/getfontweight.xml @@ -1,6 +1,6 @@ - + GmagickDraw::getfontweight Returns the font weight diff --git a/reference/gmagick/gmagickdraw/getstrokecolor.xml b/reference/gmagick/gmagickdraw/getstrokecolor.xml index 490d85c2c..9e53f823d 100644 --- a/reference/gmagick/gmagickdraw/getstrokecolor.xml +++ b/reference/gmagick/gmagickdraw/getstrokecolor.xml @@ -1,6 +1,6 @@ - + GmagickDraw::getstrokecolor Returns the color used for stroking object outlines diff --git a/reference/gmagick/gmagickdraw/getstrokeopacity.xml b/reference/gmagick/gmagickdraw/getstrokeopacity.xml index ffc414637..f53bff77e 100644 --- a/reference/gmagick/gmagickdraw/getstrokeopacity.xml +++ b/reference/gmagick/gmagickdraw/getstrokeopacity.xml @@ -1,6 +1,6 @@ - + GmagickDraw::getstrokeopacity Returns the opacity of stroked object outlines diff --git a/reference/gmagick/gmagickdraw/getstrokewidth.xml b/reference/gmagick/gmagickdraw/getstrokewidth.xml index 931108e58..dde8b0907 100644 --- a/reference/gmagick/gmagickdraw/getstrokewidth.xml +++ b/reference/gmagick/gmagickdraw/getstrokewidth.xml @@ -1,6 +1,6 @@ - + GmagickDraw::getstrokewidth Returns the width of the stroke used to draw object outlines diff --git a/reference/gmagick/gmagickdraw/gettextdecoration.xml b/reference/gmagick/gmagickdraw/gettextdecoration.xml index f53643ee6..925374332 100644 --- a/reference/gmagick/gmagickdraw/gettextdecoration.xml +++ b/reference/gmagick/gmagickdraw/gettextdecoration.xml @@ -1,6 +1,6 @@ - + GmagickDraw::gettextdecoration Returns the text decoration diff --git a/reference/gmagick/gmagickdraw/gettextencoding.xml b/reference/gmagick/gmagickdraw/gettextencoding.xml index ce6ae0933..cc46eab71 100644 --- a/reference/gmagick/gmagickdraw/gettextencoding.xml +++ b/reference/gmagick/gmagickdraw/gettextencoding.xml @@ -1,6 +1,6 @@ - + GmagickDraw::gettextencoding Returns the code set used for text annotations diff --git a/reference/gmagick/gmagickdraw/line.xml b/reference/gmagick/gmagickdraw/line.xml index 1edbafdd0..0bff46a8d 100644 --- a/reference/gmagick/gmagickdraw/line.xml +++ b/reference/gmagick/gmagickdraw/line.xml @@ -1,6 +1,6 @@ - + GmagickDraw::line Draws a line diff --git a/reference/gmagick/gmagickdraw/point.xml b/reference/gmagick/gmagickdraw/point.xml index b3c237ee2..16bc582fb 100644 --- a/reference/gmagick/gmagickdraw/point.xml +++ b/reference/gmagick/gmagickdraw/point.xml @@ -1,6 +1,6 @@ - + GmagickDraw::point Draws a point diff --git a/reference/gmagick/gmagickdraw/polygon.xml b/reference/gmagick/gmagickdraw/polygon.xml index 0360d59b4..97a39f657 100644 --- a/reference/gmagick/gmagickdraw/polygon.xml +++ b/reference/gmagick/gmagickdraw/polygon.xml @@ -1,6 +1,6 @@ - + GmagickDraw::polygon Draws a polygon diff --git a/reference/gmagick/gmagickdraw/polyline.xml b/reference/gmagick/gmagickdraw/polyline.xml index 9f50826b8..624afe0dd 100644 --- a/reference/gmagick/gmagickdraw/polyline.xml +++ b/reference/gmagick/gmagickdraw/polyline.xml @@ -1,6 +1,6 @@ - + GmagickDraw::polyline Draws a polyline diff --git a/reference/gmagick/gmagickdraw/rectangle.xml b/reference/gmagick/gmagickdraw/rectangle.xml index a18c8d179..908535fb1 100644 --- a/reference/gmagick/gmagickdraw/rectangle.xml +++ b/reference/gmagick/gmagickdraw/rectangle.xml @@ -1,6 +1,6 @@ - + GmagickDraw::rectangle Draws a rectangle diff --git a/reference/gmagick/gmagickdraw/rotate.xml b/reference/gmagick/gmagickdraw/rotate.xml index 5ccbfb4b9..79cdae25d 100644 --- a/reference/gmagick/gmagickdraw/rotate.xml +++ b/reference/gmagick/gmagickdraw/rotate.xml @@ -1,6 +1,6 @@ - + GmagickDraw::rotate Applies the specified rotation to the current coordinate space diff --git a/reference/gmagick/gmagickdraw/roundrectangle.xml b/reference/gmagick/gmagickdraw/roundrectangle.xml index cc3da39b9..349c9d5bb 100644 --- a/reference/gmagick/gmagickdraw/roundrectangle.xml +++ b/reference/gmagick/gmagickdraw/roundrectangle.xml @@ -1,6 +1,6 @@ - + GmagickDraw::roundrectangle Draws a rounded rectangle diff --git a/reference/gmagick/gmagickdraw/scale.xml b/reference/gmagick/gmagickdraw/scale.xml index 15a05e6bb..778b12417 100644 --- a/reference/gmagick/gmagickdraw/scale.xml +++ b/reference/gmagick/gmagickdraw/scale.xml @@ -1,6 +1,6 @@ - + GmagickDraw::scale Adjusts the scaling factor diff --git a/reference/gmagick/gmagickdraw/setfillcolor.xml b/reference/gmagick/gmagickdraw/setfillcolor.xml index b393ff5a6..4fbb46839 100644 --- a/reference/gmagick/gmagickdraw/setfillcolor.xml +++ b/reference/gmagick/gmagickdraw/setfillcolor.xml @@ -1,6 +1,6 @@ - + GmagickDraw::setfillcolor Sets the fill color to be used for drawing filled objects diff --git a/reference/gmagick/gmagickdraw/setfillopacity.xml b/reference/gmagick/gmagickdraw/setfillopacity.xml index 29dfd3c55..7f45ae950 100644 --- a/reference/gmagick/gmagickdraw/setfillopacity.xml +++ b/reference/gmagick/gmagickdraw/setfillopacity.xml @@ -1,6 +1,6 @@ - + GmagickDraw::setfillopacity The setfillopacity purpose diff --git a/reference/gmagick/gmagickdraw/setfont.xml b/reference/gmagick/gmagickdraw/setfont.xml index 46518e15e..7ed698f09 100644 --- a/reference/gmagick/gmagickdraw/setfont.xml +++ b/reference/gmagick/gmagickdraw/setfont.xml @@ -1,6 +1,6 @@ - + GmagickDraw::setfont Sets the fully-specified font to use when annotating with text diff --git a/reference/gmagick/gmagickdraw/setfontsize.xml b/reference/gmagick/gmagickdraw/setfontsize.xml index e9b5c3936..7f4099785 100644 --- a/reference/gmagick/gmagickdraw/setfontsize.xml +++ b/reference/gmagick/gmagickdraw/setfontsize.xml @@ -1,6 +1,6 @@ - + GmagickDraw::setfontsize Sets the font pointsize to use when annotating with text diff --git a/reference/gmagick/gmagickdraw/setfontstyle.xml b/reference/gmagick/gmagickdraw/setfontstyle.xml index fd6ecddf9..7a4a8f7a0 100644 --- a/reference/gmagick/gmagickdraw/setfontstyle.xml +++ b/reference/gmagick/gmagickdraw/setfontstyle.xml @@ -1,6 +1,6 @@ - + GmagickDraw::setfontstyle Sets the font style to use when annotating with text diff --git a/reference/gmagick/gmagickdraw/setfontweight.xml b/reference/gmagick/gmagickdraw/setfontweight.xml index 5dac2cb8d..554013f7f 100644 --- a/reference/gmagick/gmagickdraw/setfontweight.xml +++ b/reference/gmagick/gmagickdraw/setfontweight.xml @@ -1,6 +1,6 @@ - + GmagickDraw::setfontweight Sets the font weight diff --git a/reference/gmagick/gmagickdraw/setstrokecolor.xml b/reference/gmagick/gmagickdraw/setstrokecolor.xml index 1dab04663..620df5e7f 100644 --- a/reference/gmagick/gmagickdraw/setstrokecolor.xml +++ b/reference/gmagick/gmagickdraw/setstrokecolor.xml @@ -1,6 +1,6 @@ - + GmagickDraw::setstrokecolor Sets the color used for stroking object outlines diff --git a/reference/gmagick/gmagickdraw/setstrokeopacity.xml b/reference/gmagick/gmagickdraw/setstrokeopacity.xml index ee96b9e57..7fd955f32 100644 --- a/reference/gmagick/gmagickdraw/setstrokeopacity.xml +++ b/reference/gmagick/gmagickdraw/setstrokeopacity.xml @@ -1,6 +1,6 @@ - + GmagickDraw::setstrokeopacity Specifies the opacity of stroked object outlines diff --git a/reference/gmagick/gmagickdraw/setstrokewidth.xml b/reference/gmagick/gmagickdraw/setstrokewidth.xml index cd1a8f9c7..56910c4b8 100644 --- a/reference/gmagick/gmagickdraw/setstrokewidth.xml +++ b/reference/gmagick/gmagickdraw/setstrokewidth.xml @@ -1,6 +1,6 @@ - + GmagickDraw::setstrokewidth Sets the width of the stroke used to draw object outlines diff --git a/reference/gmagick/gmagickdraw/settextdecoration.xml b/reference/gmagick/gmagickdraw/settextdecoration.xml index 86407e908..36d6d4c04 100644 --- a/reference/gmagick/gmagickdraw/settextdecoration.xml +++ b/reference/gmagick/gmagickdraw/settextdecoration.xml @@ -1,6 +1,6 @@ - + GmagickDraw::settextdecoration Specifies a decoration diff --git a/reference/gmagick/gmagickdraw/settextencoding.xml b/reference/gmagick/gmagickdraw/settextencoding.xml index 082b662db..7e29e748f 100644 --- a/reference/gmagick/gmagickdraw/settextencoding.xml +++ b/reference/gmagick/gmagickdraw/settextencoding.xml @@ -1,6 +1,6 @@ - + GmagickDraw::settextencoding Specifies the text code set diff --git a/reference/gmagick/gmagickexception.xml b/reference/gmagick/gmagickexception.xml index d8c92f502..cd176ebde 100644 --- a/reference/gmagick/gmagickexception.xml +++ b/reference/gmagick/gmagickexception.xml @@ -1,6 +1,6 @@ - + The GmagickException class GmagickException diff --git a/reference/gmagick/gmagickpixel.xml b/reference/gmagick/gmagickpixel.xml index d9dc28a1b..2b77082ae 100644 --- a/reference/gmagick/gmagickpixel.xml +++ b/reference/gmagick/gmagickpixel.xml @@ -1,6 +1,6 @@ - + The GmagickPixel class GmagickPixel diff --git a/reference/gmagick/gmagickpixel/construct.xml b/reference/gmagick/gmagickpixel/construct.xml index 2a83a6490..c5f7aeee9 100644 --- a/reference/gmagick/gmagickpixel/construct.xml +++ b/reference/gmagick/gmagickpixel/construct.xml @@ -1,6 +1,6 @@ - + GmagickPixel::__construct The GmagickPixel constructor diff --git a/reference/gmagick/gmagickpixel/getcolor.xml b/reference/gmagick/gmagickpixel/getcolor.xml index f8dd10dd9..9c24216bb 100644 --- a/reference/gmagick/gmagickpixel/getcolor.xml +++ b/reference/gmagick/gmagickpixel/getcolor.xml @@ -1,6 +1,6 @@ - + GmagickPixel::getcolor Returns the color @@ -43,7 +43,7 @@ &reftitle.returnvalues; - A string or an array of channel values, each normalized if &true; is given as normalize_array. Throws GmagickPixelException on error. + A string or an array of channel values, each normalized if &true; is given as normalize_array. Throws GmagickPixelException on error. diff --git a/reference/gmagick/gmagickpixel/getcolorcount.xml b/reference/gmagick/gmagickpixel/getcolorcount.xml index 8b9121807..4d0be804d 100644 --- a/reference/gmagick/gmagickpixel/getcolorcount.xml +++ b/reference/gmagick/gmagickpixel/getcolorcount.xml @@ -1,6 +1,6 @@ - + GmagickPixel::getcolorcount Returns the color count associated with this color @@ -25,7 +25,7 @@ &reftitle.returnvalues; - Returns the color count as an integer on success, throws GmagickPixelException on failure. + Returns the color count as an integer on success, throws GmagickPixelException on failure. diff --git a/reference/gmagick/gmagickpixel/getcolorvalue.xml b/reference/gmagick/gmagickpixel/getcolorvalue.xml index 152398985..a96df168e 100644 --- a/reference/gmagick/gmagickpixel/getcolorvalue.xml +++ b/reference/gmagick/gmagickpixel/getcolorvalue.xml @@ -1,6 +1,6 @@ - + GmagickPixel::getcolorvalue Gets the normalized value of the provided color channel @@ -35,7 +35,7 @@ &reftitle.returnvalues; - The value of the channel, as a normalized floating-point number, throwing GmagickPixelException on error. + The value of the channel, as a normalized floating-point number, throwing GmagickPixelException on error. diff --git a/reference/gmagick/gmagickpixel/setcolor.xml b/reference/gmagick/gmagickpixel/setcolor.xml index ca9430aa2..a48b1b504 100644 --- a/reference/gmagick/gmagickpixel/setcolor.xml +++ b/reference/gmagick/gmagickpixel/setcolor.xml @@ -1,6 +1,6 @@ - + GmagickPixel::setcolor Sets the color diff --git a/reference/gmagick/gmagickpixel/setcolorvalue.xml b/reference/gmagick/gmagickpixel/setcolorvalue.xml index 0b7d3c499..a2812d725 100644 --- a/reference/gmagick/gmagickpixel/setcolorvalue.xml +++ b/reference/gmagick/gmagickpixel/setcolorvalue.xml @@ -1,6 +1,6 @@ - + GmagickPixel::setcolorvalue Sets the normalized value of one of the channels diff --git a/reference/gmagick/gmagickpixelexception.xml b/reference/gmagick/gmagickpixelexception.xml index ef6d9e019..98f605b63 100644 --- a/reference/gmagick/gmagickpixelexception.xml +++ b/reference/gmagick/gmagickpixelexception.xml @@ -1,6 +1,6 @@ - + The GmagickPixelException class GmagickPixelException diff --git a/reference/gmagick/setup.xml b/reference/gmagick/setup.xml index 8ac88075f..d5b3d9616 100644 --- a/reference/gmagick/setup.xml +++ b/reference/gmagick/setup.xml @@ -1,6 +1,6 @@ - + &reftitle.setup;
diff --git a/reference/gnupg/book.xml b/reference/gnupg/book.xml index 86530def2..b558dd60c 100644 --- a/reference/gnupg/book.xml +++ b/reference/gnupg/book.xml @@ -1,6 +1,6 @@ - + GNU Privacy Guard GnuPG diff --git a/reference/gnupg/configure.xml b/reference/gnupg/configure.xml index da5a8727e..5e87f6f85 100644 --- a/reference/gnupg/configure.xml +++ b/reference/gnupg/configure.xml @@ -1,6 +1,6 @@ -
+
&reftitle.install; &pecl.info; diff --git a/reference/gnupg/examples.xml b/reference/gnupg/examples.xml index f4bb8009b..4614702af 100644 --- a/reference/gnupg/examples.xml +++ b/reference/gnupg/examples.xml @@ -1,6 +1,6 @@ - + &reftitle.examples;
Clearsign text diff --git a/reference/gnupg/functions/gnupg-adddecryptkey.xml b/reference/gnupg/functions/gnupg-adddecryptkey.xml index b2d47e115..f494b557e 100644 --- a/reference/gnupg/functions/gnupg-adddecryptkey.xml +++ b/reference/gnupg/functions/gnupg-adddecryptkey.xml @@ -1,6 +1,6 @@ - + gnupg_adddecryptkey Add a key for decryption diff --git a/reference/gnupg/functions/gnupg-addencryptkey.xml b/reference/gnupg/functions/gnupg-addencryptkey.xml index 1ac416a7b..e284d822d 100644 --- a/reference/gnupg/functions/gnupg-addencryptkey.xml +++ b/reference/gnupg/functions/gnupg-addencryptkey.xml @@ -1,6 +1,6 @@ - + gnupg_addencryptkey Add a key for encryption diff --git a/reference/gnupg/functions/gnupg-addsignkey.xml b/reference/gnupg/functions/gnupg-addsignkey.xml index 4f0c88bb3..adc4cf4b4 100644 --- a/reference/gnupg/functions/gnupg-addsignkey.xml +++ b/reference/gnupg/functions/gnupg-addsignkey.xml @@ -1,6 +1,6 @@ - + gnupg_addsignkey Add a key for signing diff --git a/reference/gnupg/functions/gnupg-cleardecryptkeys.xml b/reference/gnupg/functions/gnupg-cleardecryptkeys.xml index 8f2ef52c5..8752d2274 100644 --- a/reference/gnupg/functions/gnupg-cleardecryptkeys.xml +++ b/reference/gnupg/functions/gnupg-cleardecryptkeys.xml @@ -1,6 +1,6 @@ - + gnupg_cleardecryptkeys Removes all keys which were set for decryption before diff --git a/reference/gnupg/functions/gnupg-clearencryptkeys.xml b/reference/gnupg/functions/gnupg-clearencryptkeys.xml index 75535be80..5c9d458ea 100644 --- a/reference/gnupg/functions/gnupg-clearencryptkeys.xml +++ b/reference/gnupg/functions/gnupg-clearencryptkeys.xml @@ -1,6 +1,6 @@ - + gnupg_clearencryptkeys Removes all keys which were set for encryption before diff --git a/reference/gnupg/functions/gnupg-clearsignkeys.xml b/reference/gnupg/functions/gnupg-clearsignkeys.xml index 74bfbd272..caf649200 100644 --- a/reference/gnupg/functions/gnupg-clearsignkeys.xml +++ b/reference/gnupg/functions/gnupg-clearsignkeys.xml @@ -1,6 +1,6 @@ - + gnupg_clearsignkeys Removes all keys which were set for signing before diff --git a/reference/gnupg/functions/gnupg-decrypt.xml b/reference/gnupg/functions/gnupg-decrypt.xml index 9bb803c9d..96d68a806 100644 --- a/reference/gnupg/functions/gnupg-decrypt.xml +++ b/reference/gnupg/functions/gnupg-decrypt.xml @@ -1,6 +1,6 @@ - + gnupg_decrypt Decrypts a given text diff --git a/reference/gnupg/functions/gnupg-decryptverify.xml b/reference/gnupg/functions/gnupg-decryptverify.xml index 70f7bfe9f..ee7527dee 100644 --- a/reference/gnupg/functions/gnupg-decryptverify.xml +++ b/reference/gnupg/functions/gnupg-decryptverify.xml @@ -1,6 +1,6 @@ - + gnupg_decryptverify Decrypts and verifies a given text diff --git a/reference/gnupg/functions/gnupg-deletekey.xml b/reference/gnupg/functions/gnupg-deletekey.xml index 646a565cd..235aaff75 100644 --- a/reference/gnupg/functions/gnupg-deletekey.xml +++ b/reference/gnupg/functions/gnupg-deletekey.xml @@ -1,6 +1,6 @@ - + gnupg_deletekey Delete a key from the keyring diff --git a/reference/gnupg/functions/gnupg-encrypt.xml b/reference/gnupg/functions/gnupg-encrypt.xml index 9f58145b5..05c2bdee5 100644 --- a/reference/gnupg/functions/gnupg-encrypt.xml +++ b/reference/gnupg/functions/gnupg-encrypt.xml @@ -1,6 +1,6 @@ - + gnupg_encrypt Encrypts a given text diff --git a/reference/gnupg/functions/gnupg-encryptsign.xml b/reference/gnupg/functions/gnupg-encryptsign.xml index 5b5c5a3e1..ba3f9b6a8 100644 --- a/reference/gnupg/functions/gnupg-encryptsign.xml +++ b/reference/gnupg/functions/gnupg-encryptsign.xml @@ -1,6 +1,6 @@ - + gnupg_encryptsign Encrypts and signs a given text diff --git a/reference/gnupg/functions/gnupg-export.xml b/reference/gnupg/functions/gnupg-export.xml index eafa00809..3fb5a0944 100644 --- a/reference/gnupg/functions/gnupg-export.xml +++ b/reference/gnupg/functions/gnupg-export.xml @@ -1,6 +1,6 @@ - + gnupg_export Exports a key diff --git a/reference/gnupg/functions/gnupg-getengineinfo.xml b/reference/gnupg/functions/gnupg-getengineinfo.xml index c7803bd63..99e02b6a3 100644 --- a/reference/gnupg/functions/gnupg-getengineinfo.xml +++ b/reference/gnupg/functions/gnupg-getengineinfo.xml @@ -1,6 +1,6 @@ - + gnupg_getengineinfo Returns the engine info diff --git a/reference/gnupg/functions/gnupg-geterror.xml b/reference/gnupg/functions/gnupg-geterror.xml index e0601eca2..4d6e9325d 100644 --- a/reference/gnupg/functions/gnupg-geterror.xml +++ b/reference/gnupg/functions/gnupg-geterror.xml @@ -1,6 +1,6 @@ - + gnupg_geterror Returns the errortext, if a function fails diff --git a/reference/gnupg/functions/gnupg-geterrorinfo.xml b/reference/gnupg/functions/gnupg-geterrorinfo.xml index 2c81250b1..82d72ac37 100644 --- a/reference/gnupg/functions/gnupg-geterrorinfo.xml +++ b/reference/gnupg/functions/gnupg-geterrorinfo.xml @@ -1,6 +1,6 @@ - + gnupg_geterrorinfo Returns the error info diff --git a/reference/gnupg/functions/gnupg-getprotocol.xml b/reference/gnupg/functions/gnupg-getprotocol.xml index 3c2bbaa3e..ed09d5272 100644 --- a/reference/gnupg/functions/gnupg-getprotocol.xml +++ b/reference/gnupg/functions/gnupg-getprotocol.xml @@ -1,6 +1,6 @@ - + gnupg_getprotocol Returns the currently active protocol for all operations diff --git a/reference/gnupg/functions/gnupg-gettrustlist.xml b/reference/gnupg/functions/gnupg-gettrustlist.xml index d1b6d4c0a..6fa85678b 100644 --- a/reference/gnupg/functions/gnupg-gettrustlist.xml +++ b/reference/gnupg/functions/gnupg-gettrustlist.xml @@ -1,6 +1,6 @@ - + gnupg_gettrustlist Search the trust items diff --git a/reference/gnupg/functions/gnupg-import.xml b/reference/gnupg/functions/gnupg-import.xml index 89b8eadea..cf7187e58 100644 --- a/reference/gnupg/functions/gnupg-import.xml +++ b/reference/gnupg/functions/gnupg-import.xml @@ -1,6 +1,6 @@ - + gnupg_import Imports a key diff --git a/reference/gnupg/functions/gnupg-init.xml b/reference/gnupg/functions/gnupg-init.xml index 89f1b4743..3769f99f2 100644 --- a/reference/gnupg/functions/gnupg-init.xml +++ b/reference/gnupg/functions/gnupg-init.xml @@ -1,6 +1,6 @@ - + gnupg_init Initialize a connection diff --git a/reference/gnupg/functions/gnupg-keyinfo.xml b/reference/gnupg/functions/gnupg-keyinfo.xml index c88ad0985..eb9587592 100644 --- a/reference/gnupg/functions/gnupg-keyinfo.xml +++ b/reference/gnupg/functions/gnupg-keyinfo.xml @@ -1,6 +1,6 @@ - + gnupg_keyinfo Returns an array with information about all keys that matches the given pattern diff --git a/reference/gnupg/functions/gnupg-listsignatures.xml b/reference/gnupg/functions/gnupg-listsignatures.xml index 841a091d8..2a6857466 100644 --- a/reference/gnupg/functions/gnupg-listsignatures.xml +++ b/reference/gnupg/functions/gnupg-listsignatures.xml @@ -1,6 +1,6 @@ - + gnupg_listsignatures List key signatures diff --git a/reference/gnupg/functions/gnupg-setarmor.xml b/reference/gnupg/functions/gnupg-setarmor.xml index 9a40675d5..b0e642c06 100644 --- a/reference/gnupg/functions/gnupg-setarmor.xml +++ b/reference/gnupg/functions/gnupg-setarmor.xml @@ -1,6 +1,6 @@ - + gnupg_setarmor Toggle armored output diff --git a/reference/gnupg/functions/gnupg-seterrormode.xml b/reference/gnupg/functions/gnupg-seterrormode.xml index 96f9dbce8..087a9f108 100644 --- a/reference/gnupg/functions/gnupg-seterrormode.xml +++ b/reference/gnupg/functions/gnupg-seterrormode.xml @@ -1,6 +1,6 @@ - + gnupg_seterrormode Sets the mode for error_reporting diff --git a/reference/gnupg/functions/gnupg-setsignmode.xml b/reference/gnupg/functions/gnupg-setsignmode.xml index 4adb594e6..d3247d378 100644 --- a/reference/gnupg/functions/gnupg-setsignmode.xml +++ b/reference/gnupg/functions/gnupg-setsignmode.xml @@ -1,6 +1,6 @@ - + gnupg_setsignmode Sets the mode for signing diff --git a/reference/gnupg/functions/gnupg-sign.xml b/reference/gnupg/functions/gnupg-sign.xml index d0e637ce1..7d666632c 100644 --- a/reference/gnupg/functions/gnupg-sign.xml +++ b/reference/gnupg/functions/gnupg-sign.xml @@ -1,6 +1,6 @@ - + gnupg_sign Signs a given text diff --git a/reference/gnupg/functions/gnupg-verify.xml b/reference/gnupg/functions/gnupg-verify.xml index 649bae3f9..7ac3922d3 100644 --- a/reference/gnupg/functions/gnupg-verify.xml +++ b/reference/gnupg/functions/gnupg-verify.xml @@ -1,6 +1,6 @@ - + gnupg_verify Verifies a signed text diff --git a/reference/gnupg/reference.xml b/reference/gnupg/reference.xml index c27860b18..e826248f7 100644 --- a/reference/gnupg/reference.xml +++ b/reference/gnupg/reference.xml @@ -1,6 +1,6 @@ - + GnuPG &Functions; diff --git a/reference/gnupg/setup.xml b/reference/gnupg/setup.xml index 9fd7bbbe4..ac94da186 100644 --- a/reference/gnupg/setup.xml +++ b/reference/gnupg/setup.xml @@ -1,6 +1,6 @@ - + &reftitle.setup; diff --git a/reference/hrtime/book.xml b/reference/hrtime/book.xml index 3c319c609..be7594419 100644 --- a/reference/hrtime/book.xml +++ b/reference/hrtime/book.xml @@ -1,6 +1,6 @@ - + High resolution timing HRTime diff --git a/reference/hrtime/configure.xml b/reference/hrtime/configure.xml index 19498e05c..7cc7f8a7b 100644 --- a/reference/hrtime/configure.xml +++ b/reference/hrtime/configure.xml @@ -1,6 +1,6 @@ -
+
&reftitle.install; diff --git a/reference/hrtime/examples.xml b/reference/hrtime/examples.xml index a2e5e49a3..dbeaa0e20 100644 --- a/reference/hrtime/examples.xml +++ b/reference/hrtime/examples.xml @@ -1,6 +1,6 @@ - + &reftitle.examples;
Basic usage diff --git a/reference/hrtime/hrtime-performancecounter/getfrequency.xml b/reference/hrtime/hrtime-performancecounter/getfrequency.xml index 4af08af21..7a63bcd40 100644 --- a/reference/hrtime/hrtime-performancecounter/getfrequency.xml +++ b/reference/hrtime/hrtime-performancecounter/getfrequency.xml @@ -1,6 +1,6 @@ - + HRTime\PerformanceCounter::getFrequency Timer frequency in ticks per second diff --git a/reference/hrtime/hrtime-performancecounter/getticks.xml b/reference/hrtime/hrtime-performancecounter/getticks.xml index 97cc4167b..6892111c7 100644 --- a/reference/hrtime/hrtime-performancecounter/getticks.xml +++ b/reference/hrtime/hrtime-performancecounter/getticks.xml @@ -1,6 +1,6 @@ - + HRTime\PerformanceCounter::getTicks Current ticks from the system diff --git a/reference/hrtime/hrtime-performancecounter/gettickssince.xml b/reference/hrtime/hrtime-performancecounter/gettickssince.xml index 98bf7b04e..14fad48ab 100644 --- a/reference/hrtime/hrtime-performancecounter/gettickssince.xml +++ b/reference/hrtime/hrtime-performancecounter/gettickssince.xml @@ -1,6 +1,6 @@ - + HRTime\PerformanceCounter::getTicksSince Ticks elapsed since the given value diff --git a/reference/hrtime/hrtime-stopwatch/getelapsedticks.xml b/reference/hrtime/hrtime-stopwatch/getelapsedticks.xml index 44b2fb23c..1934d0bd8 100644 --- a/reference/hrtime/hrtime-stopwatch/getelapsedticks.xml +++ b/reference/hrtime/hrtime-stopwatch/getelapsedticks.xml @@ -1,6 +1,6 @@ - + HRTime\StopWatch::getElapsedTicks Get elapsed ticks for all intervals diff --git a/reference/hrtime/hrtime-stopwatch/getelapsedtime.xml b/reference/hrtime/hrtime-stopwatch/getelapsedtime.xml index 4677d55b3..81a5bd2d2 100644 --- a/reference/hrtime/hrtime-stopwatch/getelapsedtime.xml +++ b/reference/hrtime/hrtime-stopwatch/getelapsedtime.xml @@ -1,6 +1,6 @@ - + HRTime\StopWatch::getElapsedTime Get elapsed time for all intervals diff --git a/reference/hrtime/hrtime-stopwatch/getlastelapsedticks.xml b/reference/hrtime/hrtime-stopwatch/getlastelapsedticks.xml index f3e22f192..f5b24ef88 100644 --- a/reference/hrtime/hrtime-stopwatch/getlastelapsedticks.xml +++ b/reference/hrtime/hrtime-stopwatch/getlastelapsedticks.xml @@ -1,6 +1,6 @@ - + HRTime\StopWatch::getLastElapsedTicks Get elapsed ticks for the last interval diff --git a/reference/hrtime/hrtime-stopwatch/getlastelapsedtime.xml b/reference/hrtime/hrtime-stopwatch/getlastelapsedtime.xml index 18ea62044..77bd5719e 100644 --- a/reference/hrtime/hrtime-stopwatch/getlastelapsedtime.xml +++ b/reference/hrtime/hrtime-stopwatch/getlastelapsedtime.xml @@ -1,6 +1,6 @@ - + HRTime\StopWatch::getLastElapsedTime Get elapsed time for the last interval diff --git a/reference/hrtime/hrtime-stopwatch/isrunning.xml b/reference/hrtime/hrtime-stopwatch/isrunning.xml index 1e3a3f751..df4e53c7e 100644 --- a/reference/hrtime/hrtime-stopwatch/isrunning.xml +++ b/reference/hrtime/hrtime-stopwatch/isrunning.xml @@ -1,6 +1,6 @@ - + HRTime\StopWatch::isRunning Whether the measurement is running diff --git a/reference/hrtime/hrtime-stopwatch/start.xml b/reference/hrtime/hrtime-stopwatch/start.xml index dfaec926b..9bfde90cd 100644 --- a/reference/hrtime/hrtime-stopwatch/start.xml +++ b/reference/hrtime/hrtime-stopwatch/start.xml @@ -1,6 +1,6 @@ - + HRTime\StopWatch::start Start time measurement diff --git a/reference/hrtime/hrtime-stopwatch/stop.xml b/reference/hrtime/hrtime-stopwatch/stop.xml index a22266433..255473b10 100644 --- a/reference/hrtime/hrtime-stopwatch/stop.xml +++ b/reference/hrtime/hrtime-stopwatch/stop.xml @@ -1,6 +1,6 @@ - + HRTime\StopWatch::stop Stop time measurement diff --git a/reference/hrtime/hrtime.performancecounter.xml b/reference/hrtime/hrtime.performancecounter.xml index 6dd349d79..c66955470 100644 --- a/reference/hrtime/hrtime.performancecounter.xml +++ b/reference/hrtime/hrtime.performancecounter.xml @@ -1,6 +1,6 @@ - + The HRTime\PerformanceCounter class HRTime\PerformanceCounter diff --git a/reference/hrtime/hrtime.stopwatch.xml b/reference/hrtime/hrtime.stopwatch.xml index fa7cd3019..711a04abb 100644 --- a/reference/hrtime/hrtime.stopwatch.xml +++ b/reference/hrtime/hrtime.stopwatch.xml @@ -1,6 +1,6 @@ - + The HRTime\StopWatch class HRTime\StopWatch diff --git a/reference/hrtime/hrtime.unit.xml b/reference/hrtime/hrtime.unit.xml index 76126e5d0..fc17ada7b 100644 --- a/reference/hrtime/hrtime.unit.xml +++ b/reference/hrtime/hrtime.unit.xml @@ -1,6 +1,6 @@ - + The HRTime\Unit class HRTime\Unit diff --git a/reference/hrtime/setup.xml b/reference/hrtime/setup.xml index 96fa74d04..f3b29620c 100644 --- a/reference/hrtime/setup.xml +++ b/reference/hrtime/setup.xml @@ -1,6 +1,6 @@ - + &reftitle.setup; - + Firebird/InterBase diff --git a/reference/ibase/configure.xml b/reference/ibase/configure.xml index 19fcd7813..5f8c8056a 100644 --- a/reference/ibase/configure.xml +++ b/reference/ibase/configure.xml @@ -1,6 +1,6 @@ -
+
&reftitle.install; &pecl.moved-ver;7.4.0 @@ -21,12 +21,12 @@ &ext.windows.path.dll; fbclient.dll,gds32.dll - + If you installed the Firebird/InterBase database server on the same machine PHP is running on, you will have this DLL already and fbclient.dll,gds32.dll (gds32.dll is generated from the installer for legacy applications) will already be in the PATH. - +
- + fbird_add_user &Alias; ibase_add_user diff --git a/reference/ibase/functions/fbird-affected-rows.xml b/reference/ibase/functions/fbird-affected-rows.xml index 2a1c12b41..3f9ec7e7e 100644 --- a/reference/ibase/functions/fbird-affected-rows.xml +++ b/reference/ibase/functions/fbird-affected-rows.xml @@ -1,6 +1,6 @@ - + fbird_affected_rows &Alias; ibase_affected_rows diff --git a/reference/ibase/functions/fbird-backup.xml b/reference/ibase/functions/fbird-backup.xml index 2f19b6abf..5ce287e6e 100644 --- a/reference/ibase/functions/fbird-backup.xml +++ b/reference/ibase/functions/fbird-backup.xml @@ -1,11 +1,11 @@ - + fbird_backup &Alias; ibase_backup - + &reftitle.description; diff --git a/reference/ibase/functions/fbird-blob-add.xml b/reference/ibase/functions/fbird-blob-add.xml index cd1bd624e..94010c4a5 100644 --- a/reference/ibase/functions/fbird-blob-add.xml +++ b/reference/ibase/functions/fbird-blob-add.xml @@ -1,6 +1,6 @@ - + fbird_blob_add &Alias; ibase_blob_add diff --git a/reference/ibase/functions/fbird-blob-cancel.xml b/reference/ibase/functions/fbird-blob-cancel.xml index 0fec00886..b31e04f8e 100644 --- a/reference/ibase/functions/fbird-blob-cancel.xml +++ b/reference/ibase/functions/fbird-blob-cancel.xml @@ -1,6 +1,6 @@ - + fbird_blob_cancel Cancel creating blob diff --git a/reference/ibase/functions/fbird-blob-close.xml b/reference/ibase/functions/fbird-blob-close.xml index b7be15a06..c50047aec 100644 --- a/reference/ibase/functions/fbird-blob-close.xml +++ b/reference/ibase/functions/fbird-blob-close.xml @@ -1,6 +1,6 @@ - + fbird_blob_close &Alias; ibase_blob_close diff --git a/reference/ibase/functions/fbird-blob-create.xml b/reference/ibase/functions/fbird-blob-create.xml index ad4d6eeb4..41f599ef5 100644 --- a/reference/ibase/functions/fbird-blob-create.xml +++ b/reference/ibase/functions/fbird-blob-create.xml @@ -1,6 +1,6 @@ - + fbird_blob_create &Alias; ibase_blob_create diff --git a/reference/ibase/functions/fbird-blob-echo.xml b/reference/ibase/functions/fbird-blob-echo.xml index 2d5f28a9d..5c907cd7c 100644 --- a/reference/ibase/functions/fbird-blob-echo.xml +++ b/reference/ibase/functions/fbird-blob-echo.xml @@ -1,6 +1,6 @@ - + fbird_blob_echo &Alias; ibase_blob_echo diff --git a/reference/ibase/functions/fbird-blob-get.xml b/reference/ibase/functions/fbird-blob-get.xml index bd266e539..bec643a12 100644 --- a/reference/ibase/functions/fbird-blob-get.xml +++ b/reference/ibase/functions/fbird-blob-get.xml @@ -1,6 +1,6 @@ - + fbird_blob_get &Alias; ibase_blob_get diff --git a/reference/ibase/functions/fbird-blob-import.xml b/reference/ibase/functions/fbird-blob-import.xml index 0bd8feedc..74c4eeb7f 100644 --- a/reference/ibase/functions/fbird-blob-import.xml +++ b/reference/ibase/functions/fbird-blob-import.xml @@ -1,6 +1,6 @@ - + fbird_blob_import &Alias; ibase_blob_import diff --git a/reference/ibase/functions/fbird-blob-info.xml b/reference/ibase/functions/fbird-blob-info.xml index b97b635e4..cff6c3872 100644 --- a/reference/ibase/functions/fbird-blob-info.xml +++ b/reference/ibase/functions/fbird-blob-info.xml @@ -1,11 +1,11 @@ - + fbird_blob_info &Alias; ibase_blob_info - + &reftitle.description; diff --git a/reference/ibase/functions/fbird-blob-open.xml b/reference/ibase/functions/fbird-blob-open.xml index 088abe3a2..1cd544c55 100644 --- a/reference/ibase/functions/fbird-blob-open.xml +++ b/reference/ibase/functions/fbird-blob-open.xml @@ -1,6 +1,6 @@ - + fbird_blob_open &Alias; ibase_blob_open diff --git a/reference/ibase/functions/fbird-close.xml b/reference/ibase/functions/fbird-close.xml index 40d77f6fe..63b7318bc 100644 --- a/reference/ibase/functions/fbird-close.xml +++ b/reference/ibase/functions/fbird-close.xml @@ -1,6 +1,6 @@ - + fbird_close &Alias; ibase_close diff --git a/reference/ibase/functions/fbird-commit-ret.xml b/reference/ibase/functions/fbird-commit-ret.xml index fc1582e0e..7c19ad83e 100644 --- a/reference/ibase/functions/fbird-commit-ret.xml +++ b/reference/ibase/functions/fbird-commit-ret.xml @@ -1,11 +1,11 @@ - + fbird_commit_ret &Alias; ibase_commit_ret - + &reftitle.description; diff --git a/reference/ibase/functions/fbird-commit.xml b/reference/ibase/functions/fbird-commit.xml index 538fe6f74..f95cd09f9 100644 --- a/reference/ibase/functions/fbird-commit.xml +++ b/reference/ibase/functions/fbird-commit.xml @@ -1,11 +1,11 @@ - + fbird_commit &Alias; ibase_commit - + &reftitle.description; diff --git a/reference/ibase/functions/fbird-connect.xml b/reference/ibase/functions/fbird-connect.xml index 2c9322a52..f2d400c0e 100644 --- a/reference/ibase/functions/fbird-connect.xml +++ b/reference/ibase/functions/fbird-connect.xml @@ -1,6 +1,6 @@ - + fbird_connect &Alias; ibase_connect diff --git a/reference/ibase/functions/fbird-db-info.xml b/reference/ibase/functions/fbird-db-info.xml index 7182d9890..532a1a603 100644 --- a/reference/ibase/functions/fbird-db-info.xml +++ b/reference/ibase/functions/fbird-db-info.xml @@ -1,11 +1,11 @@ - + fbird_db_info &Alias; ibase_db_info - + &reftitle.description; diff --git a/reference/ibase/functions/fbird-delete-user.xml b/reference/ibase/functions/fbird-delete-user.xml index 5581627a0..a7c0d012f 100644 --- a/reference/ibase/functions/fbird-delete-user.xml +++ b/reference/ibase/functions/fbird-delete-user.xml @@ -1,6 +1,6 @@ - + fbird_delete_user &Alias; ibase_delete_user diff --git a/reference/ibase/functions/fbird-drop-db.xml b/reference/ibase/functions/fbird-drop-db.xml index 203ac7306..96be119f3 100644 --- a/reference/ibase/functions/fbird-drop-db.xml +++ b/reference/ibase/functions/fbird-drop-db.xml @@ -1,6 +1,6 @@ - + fbird_drop_db &Alias; ibase_drop_db diff --git a/reference/ibase/functions/fbird-errcode.xml b/reference/ibase/functions/fbird-errcode.xml index 3f75922a9..cb5a2c6c5 100644 --- a/reference/ibase/functions/fbird-errcode.xml +++ b/reference/ibase/functions/fbird-errcode.xml @@ -1,6 +1,6 @@ - + fbird_errcode &Alias; ibase_errcode diff --git a/reference/ibase/functions/fbird-errmsg.xml b/reference/ibase/functions/fbird-errmsg.xml index ef7b1837e..ae0c0fbc8 100644 --- a/reference/ibase/functions/fbird-errmsg.xml +++ b/reference/ibase/functions/fbird-errmsg.xml @@ -1,6 +1,6 @@ - + fbird_errmsg &Alias; ibase_errmsg diff --git a/reference/ibase/functions/fbird-execute.xml b/reference/ibase/functions/fbird-execute.xml index a8bc7da9e..60fd20c92 100644 --- a/reference/ibase/functions/fbird-execute.xml +++ b/reference/ibase/functions/fbird-execute.xml @@ -1,6 +1,6 @@ - + fbird_execute &Alias; ibase_execute diff --git a/reference/ibase/functions/fbird-fetch-assoc.xml b/reference/ibase/functions/fbird-fetch-assoc.xml index 3b5fa2c85..fcb311e4d 100644 --- a/reference/ibase/functions/fbird-fetch-assoc.xml +++ b/reference/ibase/functions/fbird-fetch-assoc.xml @@ -1,6 +1,6 @@ - + fbird_fetch_assoc &Alias; ibase_fetch_assoc diff --git a/reference/ibase/functions/fbird-fetch-object.xml b/reference/ibase/functions/fbird-fetch-object.xml index 853db7167..58e196b6e 100644 --- a/reference/ibase/functions/fbird-fetch-object.xml +++ b/reference/ibase/functions/fbird-fetch-object.xml @@ -1,6 +1,6 @@ - + fbird_fetch_object &Alias; ibase_fetch_object diff --git a/reference/ibase/functions/fbird-fetch-row.xml b/reference/ibase/functions/fbird-fetch-row.xml index e07fee1cb..44c6fd1d1 100644 --- a/reference/ibase/functions/fbird-fetch-row.xml +++ b/reference/ibase/functions/fbird-fetch-row.xml @@ -1,6 +1,6 @@ - + fbird_fetch_row &Alias; ibase_fetch_row diff --git a/reference/ibase/functions/fbird-field-info.xml b/reference/ibase/functions/fbird-field-info.xml index 4eacec7af..c5ac10bc1 100644 --- a/reference/ibase/functions/fbird-field-info.xml +++ b/reference/ibase/functions/fbird-field-info.xml @@ -1,6 +1,6 @@ - + fbird_field_info &Alias; ibase_field_info diff --git a/reference/ibase/functions/fbird-free-event-handler.xml b/reference/ibase/functions/fbird-free-event-handler.xml index 52d3448f2..b4593a26b 100644 --- a/reference/ibase/functions/fbird-free-event-handler.xml +++ b/reference/ibase/functions/fbird-free-event-handler.xml @@ -1,6 +1,6 @@ - + fbird_free_event_handler &Alias; ibase_free_event_handler diff --git a/reference/ibase/functions/fbird-free-query.xml b/reference/ibase/functions/fbird-free-query.xml index ec8795da2..d7d3acdba 100644 --- a/reference/ibase/functions/fbird-free-query.xml +++ b/reference/ibase/functions/fbird-free-query.xml @@ -1,11 +1,11 @@ - + fbird_free_query &Alias; ibase_free_query - + &reftitle.description; diff --git a/reference/ibase/functions/fbird-free-result.xml b/reference/ibase/functions/fbird-free-result.xml index 12000886d..8f81f95d5 100644 --- a/reference/ibase/functions/fbird-free-result.xml +++ b/reference/ibase/functions/fbird-free-result.xml @@ -1,11 +1,11 @@ - + fbird_free_result &Alias; ibase_free_result - + &reftitle.description; diff --git a/reference/ibase/functions/fbird-gen-id.xml b/reference/ibase/functions/fbird-gen-id.xml index 618a9f1bc..f72644557 100644 --- a/reference/ibase/functions/fbird-gen-id.xml +++ b/reference/ibase/functions/fbird-gen-id.xml @@ -1,12 +1,12 @@ - + fbird_gen_id &Alias; ibase_gen_id - + &reftitle.description; diff --git a/reference/ibase/functions/fbird-maintain-db.xml b/reference/ibase/functions/fbird-maintain-db.xml index c8c95c995..9b3b32d27 100644 --- a/reference/ibase/functions/fbird-maintain-db.xml +++ b/reference/ibase/functions/fbird-maintain-db.xml @@ -1,11 +1,11 @@ - + fbird_maintain_db &Alias; ibase_maintain_db - + &reftitle.description; diff --git a/reference/ibase/functions/fbird-modify-user.xml b/reference/ibase/functions/fbird-modify-user.xml index 9581be249..6d48a7a14 100644 --- a/reference/ibase/functions/fbird-modify-user.xml +++ b/reference/ibase/functions/fbird-modify-user.xml @@ -1,6 +1,6 @@ - + fbird_modify_user &Alias; ibase_modify_user diff --git a/reference/ibase/functions/fbird-name-result.xml b/reference/ibase/functions/fbird-name-result.xml index fe3d25122..dc50df5a8 100644 --- a/reference/ibase/functions/fbird-name-result.xml +++ b/reference/ibase/functions/fbird-name-result.xml @@ -1,6 +1,6 @@ - + fbird_name_result &Alias; ibase_name_result diff --git a/reference/ibase/functions/fbird-num-fields.xml b/reference/ibase/functions/fbird-num-fields.xml index 097b503fe..3e648daf9 100644 --- a/reference/ibase/functions/fbird-num-fields.xml +++ b/reference/ibase/functions/fbird-num-fields.xml @@ -1,6 +1,6 @@ - + fbird_num_fields &Alias; ibase_num_fields diff --git a/reference/ibase/functions/fbird-num-params.xml b/reference/ibase/functions/fbird-num-params.xml index 2cff671ab..c9509938a 100644 --- a/reference/ibase/functions/fbird-num-params.xml +++ b/reference/ibase/functions/fbird-num-params.xml @@ -1,6 +1,6 @@ - + fbird_num_params &Alias; ibase_num_params diff --git a/reference/ibase/functions/fbird-param-info.xml b/reference/ibase/functions/fbird-param-info.xml index 98d9a47b9..7d15cda29 100644 --- a/reference/ibase/functions/fbird-param-info.xml +++ b/reference/ibase/functions/fbird-param-info.xml @@ -1,6 +1,6 @@ - + fbird_param_info &Alias; ibase_param_info diff --git a/reference/ibase/functions/fbird-pconnect.xml b/reference/ibase/functions/fbird-pconnect.xml index ef1313627..4deb0775c 100644 --- a/reference/ibase/functions/fbird-pconnect.xml +++ b/reference/ibase/functions/fbird-pconnect.xml @@ -1,6 +1,6 @@ - + fbird_pconnect &Alias; ibase_pconnect diff --git a/reference/ibase/functions/fbird-prepare.xml b/reference/ibase/functions/fbird-prepare.xml index a112b24ab..793e75422 100644 --- a/reference/ibase/functions/fbird-prepare.xml +++ b/reference/ibase/functions/fbird-prepare.xml @@ -1,11 +1,11 @@ - + fbird_prepare &Alias; ibase_prepare - + &reftitle.description; diff --git a/reference/ibase/functions/fbird-query.xml b/reference/ibase/functions/fbird-query.xml index 0d1becea5..bec5b0300 100644 --- a/reference/ibase/functions/fbird-query.xml +++ b/reference/ibase/functions/fbird-query.xml @@ -1,6 +1,6 @@ - + fbird_query &Alias; ibase_query diff --git a/reference/ibase/functions/fbird-restore.xml b/reference/ibase/functions/fbird-restore.xml index 52c7d71ae..ac33e1de7 100644 --- a/reference/ibase/functions/fbird-restore.xml +++ b/reference/ibase/functions/fbird-restore.xml @@ -1,11 +1,11 @@ - + fbird_restore &Alias; ibase_restore - + &reftitle.description; diff --git a/reference/ibase/functions/fbird-rollback-ret.xml b/reference/ibase/functions/fbird-rollback-ret.xml index a135dbc66..c13114966 100644 --- a/reference/ibase/functions/fbird-rollback-ret.xml +++ b/reference/ibase/functions/fbird-rollback-ret.xml @@ -1,11 +1,11 @@ - + fbird_rollback_ret &Alias; ibase_rollback_ret - + &reftitle.description; diff --git a/reference/ibase/functions/fbird-rollback.xml b/reference/ibase/functions/fbird-rollback.xml index 539091703..3ba6bf763 100644 --- a/reference/ibase/functions/fbird-rollback.xml +++ b/reference/ibase/functions/fbird-rollback.xml @@ -1,11 +1,11 @@ - + fbird_rollback &Alias; ibase_rollback - + &reftitle.description; diff --git a/reference/ibase/functions/fbird-server-info.xml b/reference/ibase/functions/fbird-server-info.xml index 8580bc372..37dd4f52f 100644 --- a/reference/ibase/functions/fbird-server-info.xml +++ b/reference/ibase/functions/fbird-server-info.xml @@ -1,11 +1,11 @@ - + fbird_server_info &Alias; ibase_server_info - + &reftitle.description; diff --git a/reference/ibase/functions/fbird-service-attach.xml b/reference/ibase/functions/fbird-service-attach.xml index 49a9f8f57..bd2438f90 100644 --- a/reference/ibase/functions/fbird-service-attach.xml +++ b/reference/ibase/functions/fbird-service-attach.xml @@ -1,11 +1,11 @@ - + fbird_service_attach &Alias; ibase_service_attach - + &reftitle.description; diff --git a/reference/ibase/functions/fbird-service-detach.xml b/reference/ibase/functions/fbird-service-detach.xml index 8996f1351..bf94d24f3 100644 --- a/reference/ibase/functions/fbird-service-detach.xml +++ b/reference/ibase/functions/fbird-service-detach.xml @@ -1,11 +1,11 @@ - + fbird_service_detach &Alias; ibase_service_detach - + &reftitle.description; diff --git a/reference/ibase/functions/fbird-set-event-handler.xml b/reference/ibase/functions/fbird-set-event-handler.xml index 4c3cb000d..d31c17de6 100644 --- a/reference/ibase/functions/fbird-set-event-handler.xml +++ b/reference/ibase/functions/fbird-set-event-handler.xml @@ -1,6 +1,6 @@ - + fbird_set_event_handler &Alias; ibase_set_event_handler diff --git a/reference/ibase/functions/fbird-trans.xml b/reference/ibase/functions/fbird-trans.xml index 699340833..b3693ca9f 100644 --- a/reference/ibase/functions/fbird-trans.xml +++ b/reference/ibase/functions/fbird-trans.xml @@ -1,11 +1,11 @@ - + fbird_trans &Alias; ibase_trans - + &reftitle.description; diff --git a/reference/ibase/functions/fbird-wait-event.xml b/reference/ibase/functions/fbird-wait-event.xml index c79246743..f71ec901e 100644 --- a/reference/ibase/functions/fbird-wait-event.xml +++ b/reference/ibase/functions/fbird-wait-event.xml @@ -1,6 +1,6 @@ - + fbird_wait_event &Alias; ibase_wait_event diff --git a/reference/ibase/functions/ibase-add-user.xml b/reference/ibase/functions/ibase-add-user.xml index 324dee01b..4f46943e9 100644 --- a/reference/ibase/functions/ibase-add-user.xml +++ b/reference/ibase/functions/ibase-add-user.xml @@ -1,6 +1,6 @@ - + ibase_add_user Add a user to a security database diff --git a/reference/ibase/functions/ibase-affected-rows.xml b/reference/ibase/functions/ibase-affected-rows.xml index f2ee2b3ce..8826ad90e 100644 --- a/reference/ibase/functions/ibase-affected-rows.xml +++ b/reference/ibase/functions/ibase-affected-rows.xml @@ -1,6 +1,6 @@ - + ibase_affected_rows Return the number of rows that were affected by the previous query diff --git a/reference/ibase/functions/ibase-backup.xml b/reference/ibase/functions/ibase-backup.xml index a12ccbe1c..52c17cc92 100644 --- a/reference/ibase/functions/ibase-backup.xml +++ b/reference/ibase/functions/ibase-backup.xml @@ -1,6 +1,6 @@ - + ibase_backup Initiates a backup task in the service manager and returns immediately @@ -52,7 +52,7 @@ options - + Additional options to pass to the database server for backup. The options parameter can be a combination of the following constants: @@ -64,7 +64,7 @@ IBASE_BKP_NON_TRANSPORTABLE or IBASE_BKP_CONVERT. Read the section about for further information. - + diff --git a/reference/ibase/functions/ibase-blob-add.xml b/reference/ibase/functions/ibase-blob-add.xml index 135e22ffd..055392506 100644 --- a/reference/ibase/functions/ibase-blob-add.xml +++ b/reference/ibase/functions/ibase-blob-add.xml @@ -1,6 +1,6 @@ - + ibase_blob_add Add data into a newly created blob diff --git a/reference/ibase/functions/ibase-blob-cancel.xml b/reference/ibase/functions/ibase-blob-cancel.xml index 258a69be4..9c77cc7db 100644 --- a/reference/ibase/functions/ibase-blob-cancel.xml +++ b/reference/ibase/functions/ibase-blob-cancel.xml @@ -1,6 +1,6 @@ - + ibase_blob_cancel Cancel creating blob diff --git a/reference/ibase/functions/ibase-blob-close.xml b/reference/ibase/functions/ibase-blob-close.xml index 352d4ebc3..2e18652eb 100644 --- a/reference/ibase/functions/ibase-blob-close.xml +++ b/reference/ibase/functions/ibase-blob-close.xml @@ -1,6 +1,6 @@ - + ibase_blob_close Close blob diff --git a/reference/ibase/functions/ibase-blob-create.xml b/reference/ibase/functions/ibase-blob-create.xml index 83cf34a7d..bfb40e215 100644 --- a/reference/ibase/functions/ibase-blob-create.xml +++ b/reference/ibase/functions/ibase-blob-create.xml @@ -1,6 +1,6 @@ - + ibase_blob_create Create a new blob for adding data diff --git a/reference/ibase/functions/ibase-blob-echo.xml b/reference/ibase/functions/ibase-blob-echo.xml index 6d9debcdd..58e450484 100644 --- a/reference/ibase/functions/ibase-blob-echo.xml +++ b/reference/ibase/functions/ibase-blob-echo.xml @@ -1,6 +1,6 @@ - + ibase_blob_echo Output blob contents to browser diff --git a/reference/ibase/functions/ibase-blob-get.xml b/reference/ibase/functions/ibase-blob-get.xml index f1c892859..62b9e8a87 100644 --- a/reference/ibase/functions/ibase-blob-get.xml +++ b/reference/ibase/functions/ibase-blob-get.xml @@ -1,6 +1,6 @@ - + ibase_blob_get Get len bytes data from open blob diff --git a/reference/ibase/functions/ibase-blob-import.xml b/reference/ibase/functions/ibase-blob-import.xml index 03bbfc85a..1afff527c 100644 --- a/reference/ibase/functions/ibase-blob-import.xml +++ b/reference/ibase/functions/ibase-blob-import.xml @@ -1,6 +1,6 @@ - + ibase_blob_import Create blob, copy file in it, and close it diff --git a/reference/ibase/functions/ibase-blob-info.xml b/reference/ibase/functions/ibase-blob-info.xml index 84ce2fd3f..94506cb38 100644 --- a/reference/ibase/functions/ibase-blob-info.xml +++ b/reference/ibase/functions/ibase-blob-info.xml @@ -1,6 +1,6 @@ - + ibase_blob_info Return blob length and other useful info diff --git a/reference/ibase/functions/ibase-blob-open.xml b/reference/ibase/functions/ibase-blob-open.xml index 222856b15..0733bf9c5 100644 --- a/reference/ibase/functions/ibase-blob-open.xml +++ b/reference/ibase/functions/ibase-blob-open.xml @@ -1,6 +1,6 @@ - + ibase_blob_open Open blob for retrieving data parts diff --git a/reference/ibase/functions/ibase-close.xml b/reference/ibase/functions/ibase-close.xml index 05e90918a..50b41f853 100644 --- a/reference/ibase/functions/ibase-close.xml +++ b/reference/ibase/functions/ibase-close.xml @@ -1,6 +1,6 @@ - + ibase_close Close a connection to an InterBase database diff --git a/reference/ibase/functions/ibase-commit-ret.xml b/reference/ibase/functions/ibase-commit-ret.xml index b50f1b0bc..900398ca5 100644 --- a/reference/ibase/functions/ibase-commit-ret.xml +++ b/reference/ibase/functions/ibase-commit-ret.xml @@ -1,6 +1,6 @@ - + ibase_commit_ret Commit a transaction without closing it diff --git a/reference/ibase/functions/ibase-commit.xml b/reference/ibase/functions/ibase-commit.xml index ea44c0c6f..4c81944aa 100644 --- a/reference/ibase/functions/ibase-commit.xml +++ b/reference/ibase/functions/ibase-commit.xml @@ -1,6 +1,6 @@ - + ibase_commit Commit a transaction diff --git a/reference/ibase/functions/ibase-connect.xml b/reference/ibase/functions/ibase-connect.xml index ffe791fcb..3c0760dad 100644 --- a/reference/ibase/functions/ibase-connect.xml +++ b/reference/ibase/functions/ibase-connect.xml @@ -1,6 +1,6 @@ - + ibase_connect Open a connection to a database diff --git a/reference/ibase/functions/ibase-db-info.xml b/reference/ibase/functions/ibase-db-info.xml index b829a580d..6b96fa0d3 100644 --- a/reference/ibase/functions/ibase-db-info.xml +++ b/reference/ibase/functions/ibase-db-info.xml @@ -1,11 +1,11 @@ - + ibase_db_info Request statistics about a database - + &reftitle.description; diff --git a/reference/ibase/functions/ibase-delete-user.xml b/reference/ibase/functions/ibase-delete-user.xml index e730903c3..c158e4243 100644 --- a/reference/ibase/functions/ibase-delete-user.xml +++ b/reference/ibase/functions/ibase-delete-user.xml @@ -1,6 +1,6 @@ - + ibase_delete_user Delete a user from a security database diff --git a/reference/ibase/functions/ibase-drop-db.xml b/reference/ibase/functions/ibase-drop-db.xml index 5e57fe9c2..d4096c671 100644 --- a/reference/ibase/functions/ibase-drop-db.xml +++ b/reference/ibase/functions/ibase-drop-db.xml @@ -1,6 +1,6 @@ - + ibase_drop_db Drops a database diff --git a/reference/ibase/functions/ibase-errcode.xml b/reference/ibase/functions/ibase-errcode.xml index d37dc70db..6cef52fa1 100644 --- a/reference/ibase/functions/ibase-errcode.xml +++ b/reference/ibase/functions/ibase-errcode.xml @@ -1,6 +1,6 @@ - + ibase_errcode Return an error code diff --git a/reference/ibase/functions/ibase-errmsg.xml b/reference/ibase/functions/ibase-errmsg.xml index 7403b7b9b..6c3308c3f 100644 --- a/reference/ibase/functions/ibase-errmsg.xml +++ b/reference/ibase/functions/ibase-errmsg.xml @@ -1,6 +1,6 @@ - + ibase_errmsg Return error messages diff --git a/reference/ibase/functions/ibase-execute.xml b/reference/ibase/functions/ibase-execute.xml index 673b7a3cd..1ba91a039 100644 --- a/reference/ibase/functions/ibase-execute.xml +++ b/reference/ibase/functions/ibase-execute.xml @@ -1,6 +1,6 @@ - + ibase_execute Execute a previously prepared query diff --git a/reference/ibase/functions/ibase-fetch-assoc.xml b/reference/ibase/functions/ibase-fetch-assoc.xml index c872ff604..e11870fb6 100644 --- a/reference/ibase/functions/ibase-fetch-assoc.xml +++ b/reference/ibase/functions/ibase-fetch-assoc.xml @@ -1,6 +1,6 @@ - + ibase_fetch_assoc Fetch a result row from a query as an associative array diff --git a/reference/ibase/functions/ibase-fetch-object.xml b/reference/ibase/functions/ibase-fetch-object.xml index 0e0265f78..df4360f82 100644 --- a/reference/ibase/functions/ibase-fetch-object.xml +++ b/reference/ibase/functions/ibase-fetch-object.xml @@ -1,6 +1,6 @@ - + ibase_fetch_object Get an object from a InterBase database diff --git a/reference/ibase/functions/ibase-fetch-row.xml b/reference/ibase/functions/ibase-fetch-row.xml index 67cc83999..f3b7dbfc6 100644 --- a/reference/ibase/functions/ibase-fetch-row.xml +++ b/reference/ibase/functions/ibase-fetch-row.xml @@ -1,6 +1,6 @@ - + ibase_fetch_row Fetch a row from an InterBase database diff --git a/reference/ibase/functions/ibase-field-info.xml b/reference/ibase/functions/ibase-field-info.xml index 05e3ce094..6ecb514b0 100644 --- a/reference/ibase/functions/ibase-field-info.xml +++ b/reference/ibase/functions/ibase-field-info.xml @@ -1,6 +1,6 @@ - + ibase_field_info Get information about a field diff --git a/reference/ibase/functions/ibase-free-event-handler.xml b/reference/ibase/functions/ibase-free-event-handler.xml index 3ce3bdd5c..ecd8818c9 100644 --- a/reference/ibase/functions/ibase-free-event-handler.xml +++ b/reference/ibase/functions/ibase-free-event-handler.xml @@ -1,6 +1,6 @@ - + ibase_free_event_handler Cancels a registered event handler diff --git a/reference/ibase/functions/ibase-free-query.xml b/reference/ibase/functions/ibase-free-query.xml index fa36734c5..4287edb59 100644 --- a/reference/ibase/functions/ibase-free-query.xml +++ b/reference/ibase/functions/ibase-free-query.xml @@ -1,6 +1,6 @@ - + ibase_free_query Free memory allocated by a prepared query diff --git a/reference/ibase/functions/ibase-free-result.xml b/reference/ibase/functions/ibase-free-result.xml index 356a79bcc..5dcca8adb 100644 --- a/reference/ibase/functions/ibase-free-result.xml +++ b/reference/ibase/functions/ibase-free-result.xml @@ -1,6 +1,6 @@ - + ibase_free_result Free a result set diff --git a/reference/ibase/functions/ibase-gen-id.xml b/reference/ibase/functions/ibase-gen-id.xml index aba1b59bd..19320258a 100644 --- a/reference/ibase/functions/ibase-gen-id.xml +++ b/reference/ibase/functions/ibase-gen-id.xml @@ -1,7 +1,7 @@ - + ibase_gen_id Increments the named generator and returns its new value diff --git a/reference/ibase/functions/ibase-maintain-db.xml b/reference/ibase/functions/ibase-maintain-db.xml index 3a062cce0..3925bc633 100644 --- a/reference/ibase/functions/ibase-maintain-db.xml +++ b/reference/ibase/functions/ibase-maintain-db.xml @@ -1,6 +1,6 @@ - + ibase_maintain_db Execute a maintenance command on the database server diff --git a/reference/ibase/functions/ibase-modify-user.xml b/reference/ibase/functions/ibase-modify-user.xml index 5c465803c..1dfd0a681 100644 --- a/reference/ibase/functions/ibase-modify-user.xml +++ b/reference/ibase/functions/ibase-modify-user.xml @@ -1,6 +1,6 @@ - + ibase_modify_user Modify a user to a security database diff --git a/reference/ibase/functions/ibase-name-result.xml b/reference/ibase/functions/ibase-name-result.xml index adfb8f78a..a2fed5480 100644 --- a/reference/ibase/functions/ibase-name-result.xml +++ b/reference/ibase/functions/ibase-name-result.xml @@ -1,6 +1,6 @@ - + ibase_name_result Assigns a name to a result set diff --git a/reference/ibase/functions/ibase-num-fields.xml b/reference/ibase/functions/ibase-num-fields.xml index d464ff886..b01b83e20 100644 --- a/reference/ibase/functions/ibase-num-fields.xml +++ b/reference/ibase/functions/ibase-num-fields.xml @@ -1,6 +1,6 @@ - + ibase_num_fields Get the number of fields in a result set diff --git a/reference/ibase/functions/ibase-num-params.xml b/reference/ibase/functions/ibase-num-params.xml index 0f8b8cd91..c2f894886 100644 --- a/reference/ibase/functions/ibase-num-params.xml +++ b/reference/ibase/functions/ibase-num-params.xml @@ -1,6 +1,6 @@ - + ibase_num_params Return the number of parameters in a prepared query diff --git a/reference/ibase/functions/ibase-param-info.xml b/reference/ibase/functions/ibase-param-info.xml index 9a2faa414..f68b143ba 100644 --- a/reference/ibase/functions/ibase-param-info.xml +++ b/reference/ibase/functions/ibase-param-info.xml @@ -1,6 +1,6 @@ - + ibase_param_info Return information about a parameter in a prepared query diff --git a/reference/ibase/functions/ibase-pconnect.xml b/reference/ibase/functions/ibase-pconnect.xml index 6a5e266d1..290ec620e 100644 --- a/reference/ibase/functions/ibase-pconnect.xml +++ b/reference/ibase/functions/ibase-pconnect.xml @@ -1,6 +1,6 @@ - + ibase_pconnect Open a persistent connection to an InterBase database diff --git a/reference/ibase/functions/ibase-prepare.xml b/reference/ibase/functions/ibase-prepare.xml index dce12f887..d25760643 100644 --- a/reference/ibase/functions/ibase-prepare.xml +++ b/reference/ibase/functions/ibase-prepare.xml @@ -1,6 +1,6 @@ - + ibase_prepare Prepare a query for later binding of parameter placeholders and execution diff --git a/reference/ibase/functions/ibase-query.xml b/reference/ibase/functions/ibase-query.xml index b9874a7db..bf4c0a3d0 100644 --- a/reference/ibase/functions/ibase-query.xml +++ b/reference/ibase/functions/ibase-query.xml @@ -1,6 +1,6 @@ - + ibase_query Execute a query on an InterBase database diff --git a/reference/ibase/functions/ibase-restore.xml b/reference/ibase/functions/ibase-restore.xml index 3f62a87b4..643227291 100644 --- a/reference/ibase/functions/ibase-restore.xml +++ b/reference/ibase/functions/ibase-restore.xml @@ -1,6 +1,6 @@ - + ibase_restore Initiates a restore task in the service manager and returns immediately @@ -53,7 +53,7 @@ options - + Additional options to pass to the database server for restore. The options parameter can be a combination of the following constants: @@ -68,7 +68,7 @@ IBASE_PRP_SWEEP_INTERVAL, IBASE_RES_CREATE. Read the section about for further information. - + diff --git a/reference/ibase/functions/ibase-rollback-ret.xml b/reference/ibase/functions/ibase-rollback-ret.xml index b9597ea22..bb8ec2574 100644 --- a/reference/ibase/functions/ibase-rollback-ret.xml +++ b/reference/ibase/functions/ibase-rollback-ret.xml @@ -1,6 +1,6 @@ - + ibase_rollback_ret Roll back a transaction without closing it diff --git a/reference/ibase/functions/ibase-rollback.xml b/reference/ibase/functions/ibase-rollback.xml index 221917c9f..bc0bac925 100644 --- a/reference/ibase/functions/ibase-rollback.xml +++ b/reference/ibase/functions/ibase-rollback.xml @@ -1,6 +1,6 @@ - + ibase_rollback Roll back a transaction diff --git a/reference/ibase/functions/ibase-server-info.xml b/reference/ibase/functions/ibase-server-info.xml index 2dca49767..09541bc7f 100644 --- a/reference/ibase/functions/ibase-server-info.xml +++ b/reference/ibase/functions/ibase-server-info.xml @@ -1,6 +1,6 @@ - + ibase_server_info Request information about a database server diff --git a/reference/ibase/functions/ibase-service-attach.xml b/reference/ibase/functions/ibase-service-attach.xml index 2716af6a4..14b9b3aae 100644 --- a/reference/ibase/functions/ibase-service-attach.xml +++ b/reference/ibase/functions/ibase-service-attach.xml @@ -1,6 +1,6 @@ - + ibase_service_attach Connect to the service manager diff --git a/reference/ibase/functions/ibase-service-detach.xml b/reference/ibase/functions/ibase-service-detach.xml index 0a1488126..3cd350b60 100644 --- a/reference/ibase/functions/ibase-service-detach.xml +++ b/reference/ibase/functions/ibase-service-detach.xml @@ -1,6 +1,6 @@ - + ibase_service_detach Disconnect from the service manager diff --git a/reference/ibase/functions/ibase-set-event-handler.xml b/reference/ibase/functions/ibase-set-event-handler.xml index dddb55557..7d25ef57c 100644 --- a/reference/ibase/functions/ibase-set-event-handler.xml +++ b/reference/ibase/functions/ibase-set-event-handler.xml @@ -1,6 +1,6 @@ - + ibase_set_event_handler Register a callback function to be called when events are posted diff --git a/reference/ibase/functions/ibase-trans.xml b/reference/ibase/functions/ibase-trans.xml index 74d676afb..afe4a8761 100644 --- a/reference/ibase/functions/ibase-trans.xml +++ b/reference/ibase/functions/ibase-trans.xml @@ -1,6 +1,6 @@ - + ibase_trans Begin a transaction diff --git a/reference/ibase/functions/ibase-wait-event.xml b/reference/ibase/functions/ibase-wait-event.xml index a39d82b8d..79d355eda 100644 --- a/reference/ibase/functions/ibase-wait-event.xml +++ b/reference/ibase/functions/ibase-wait-event.xml @@ -1,6 +1,6 @@ - + ibase_wait_event Wait for an event to be posted by the database diff --git a/reference/ibase/ini.xml b/reference/ibase/ini.xml index 622477099..ffc337981 100644 --- a/reference/ibase/ini.xml +++ b/reference/ibase/ini.xml @@ -1,6 +1,6 @@ -
+
&reftitle.runtime; &extension.runtime; diff --git a/reference/ibase/reference.xml b/reference/ibase/reference.xml index 6df96bb60..4e0b334cd 100644 --- a/reference/ibase/reference.xml +++ b/reference/ibase/reference.xml @@ -7,7 +7,7 @@ &reference.ibase.entities.functions; - + - + IBM DB2, Cloudscape and Apache Derby IBM DB2 diff --git a/reference/ibm_db2/configure.xml b/reference/ibm_db2/configure.xml index cc17ed38f..37caa31e3 100644 --- a/reference/ibm_db2/configure.xml +++ b/reference/ibm_db2/configure.xml @@ -1,6 +1,6 @@ -
+
&reftitle.install; To build the ibm_db2 extension, the DB2 application development header files diff --git a/reference/ibm_db2/constants.xml b/reference/ibm_db2/constants.xml index 0b07fec93..652855c27 100644 --- a/reference/ibm_db2/constants.xml +++ b/reference/ibm_db2/constants.xml @@ -11,7 +11,7 @@ (int) - + Specifies that binary data shall be returned as is. This is the default mode. @@ -46,7 +46,7 @@ (int) - + Specifies a scrollable cursor for a statement resource. This mode enables random access to rows in a result set, but currently is supported only by IBM DB2 Universal Database. @@ -209,7 +209,7 @@ - Specifies that deferred prepare should be turned on for the specified statement resource. + Specifies that deferred prepare should be turned on for the specified statement resource. @@ -220,7 +220,7 @@ - Specifies that deferred prepare should be turned off for the specified statement resource. + Specifies that deferred prepare should be turned off for the specified statement resource. diff --git a/reference/ibm_db2/functions/db2-autocommit.xml b/reference/ibm_db2/functions/db2-autocommit.xml index 526f3fe1f..107af6c42 100644 --- a/reference/ibm_db2/functions/db2-autocommit.xml +++ b/reference/ibm_db2/functions/db2-autocommit.xml @@ -1,6 +1,6 @@ - + db2_autocommit diff --git a/reference/ibm_db2/functions/db2-bind-param.xml b/reference/ibm_db2/functions/db2-bind-param.xml index 58c2906f8..2e64bb473 100644 --- a/reference/ibm_db2/functions/db2-bind-param.xml +++ b/reference/ibm_db2/functions/db2-bind-param.xml @@ -1,6 +1,6 @@ - + db2_bind_param diff --git a/reference/ibm_db2/functions/db2-close.xml b/reference/ibm_db2/functions/db2-close.xml index b8a3d7925..db5a7ba84 100644 --- a/reference/ibm_db2/functions/db2-close.xml +++ b/reference/ibm_db2/functions/db2-close.xml @@ -1,7 +1,7 @@ - + db2_close diff --git a/reference/ibm_db2/functions/db2-conn-error.xml b/reference/ibm_db2/functions/db2-conn-error.xml index 467a06a13..8e7b0bbf7 100644 --- a/reference/ibm_db2/functions/db2-conn-error.xml +++ b/reference/ibm_db2/functions/db2-conn-error.xml @@ -1,7 +1,7 @@ - + db2_conn_error @@ -28,13 +28,13 @@ you can pass the connection parameter to retrieve the SQLSTATE value for a specific connection. - + To learn what the SQLSTATE value means, you can issue the following command at a DB2 Command Line Processor prompt: db2 '? sqlstate-value'. You can also call db2_conn_errormsg to retrieve an explicit error message and the associated SQLCODE value. - + &reftitle.parameters; diff --git a/reference/ibm_db2/functions/db2-conn-errormsg.xml b/reference/ibm_db2/functions/db2-conn-errormsg.xml index 898e98534..092dba739 100644 --- a/reference/ibm_db2/functions/db2-conn-errormsg.xml +++ b/reference/ibm_db2/functions/db2-conn-errormsg.xml @@ -1,7 +1,7 @@ - + db2_conn_errormsg diff --git a/reference/ibm_db2/functions/db2-connect.xml b/reference/ibm_db2/functions/db2-connect.xml index 45b2878e8..fdd5c5c53 100644 --- a/reference/ibm_db2/functions/db2-connect.xml +++ b/reference/ibm_db2/functions/db2-connect.xml @@ -1,7 +1,7 @@ - + db2_connect diff --git a/reference/ibm_db2/functions/db2-exec.xml b/reference/ibm_db2/functions/db2-exec.xml index c0c95ed6c..ce6d5530a 100644 --- a/reference/ibm_db2/functions/db2-exec.xml +++ b/reference/ibm_db2/functions/db2-exec.xml @@ -1,7 +1,7 @@ - + db2_exec diff --git a/reference/ibm_db2/functions/db2-execute.xml b/reference/ibm_db2/functions/db2-execute.xml index d145dd6cd..76a774359 100644 --- a/reference/ibm_db2/functions/db2-execute.xml +++ b/reference/ibm_db2/functions/db2-execute.xml @@ -1,7 +1,7 @@ - + db2_execute diff --git a/reference/ibm_db2/functions/db2-fetch-array.xml b/reference/ibm_db2/functions/db2-fetch-array.xml index b720cf733..b07655ccf 100644 --- a/reference/ibm_db2/functions/db2-fetch-array.xml +++ b/reference/ibm_db2/functions/db2-fetch-array.xml @@ -1,7 +1,7 @@ - + db2_fetch_array diff --git a/reference/ibm_db2/functions/db2-fetch-assoc.xml b/reference/ibm_db2/functions/db2-fetch-assoc.xml index d7e5ccc45..34613134b 100644 --- a/reference/ibm_db2/functions/db2-fetch-assoc.xml +++ b/reference/ibm_db2/functions/db2-fetch-assoc.xml @@ -1,7 +1,7 @@ - + db2_fetch_assoc diff --git a/reference/ibm_db2/functions/db2-fetch-both.xml b/reference/ibm_db2/functions/db2-fetch-both.xml index cbc76b787..b74474678 100644 --- a/reference/ibm_db2/functions/db2-fetch-both.xml +++ b/reference/ibm_db2/functions/db2-fetch-both.xml @@ -1,7 +1,7 @@ - + db2_fetch_both diff --git a/reference/ibm_db2/functions/db2-fetch-object.xml b/reference/ibm_db2/functions/db2-fetch-object.xml index 783e35ee7..f5c37c212 100644 --- a/reference/ibm_db2/functions/db2-fetch-object.xml +++ b/reference/ibm_db2/functions/db2-fetch-object.xml @@ -1,7 +1,7 @@ - + db2_fetch_object diff --git a/reference/ibm_db2/functions/db2-fetch-row.xml b/reference/ibm_db2/functions/db2-fetch-row.xml index a29e69f8c..38e357444 100644 --- a/reference/ibm_db2/functions/db2-fetch-row.xml +++ b/reference/ibm_db2/functions/db2-fetch-row.xml @@ -1,7 +1,7 @@ - + db2_fetch_row diff --git a/reference/ibm_db2/functions/db2-get-option.xml b/reference/ibm_db2/functions/db2-get-option.xml index 842859767..cf4718636 100644 --- a/reference/ibm_db2/functions/db2-get-option.xml +++ b/reference/ibm_db2/functions/db2-get-option.xml @@ -1,6 +1,6 @@ - + db2_get_option Retrieves an option value for a statement resource or a connection resource diff --git a/reference/ibm_db2/functions/db2-last-insert-id.xml b/reference/ibm_db2/functions/db2-last-insert-id.xml index 011248f01..7d77486b4 100644 --- a/reference/ibm_db2/functions/db2-last-insert-id.xml +++ b/reference/ibm_db2/functions/db2-last-insert-id.xml @@ -1,6 +1,6 @@ - + db2_last_insert_id Returns the auto generated ID of the last insert query that successfully diff --git a/reference/ibm_db2/functions/db2-lob-read.xml b/reference/ibm_db2/functions/db2-lob-read.xml index d5a6c173b..32aff29f0 100644 --- a/reference/ibm_db2/functions/db2-lob-read.xml +++ b/reference/ibm_db2/functions/db2-lob-read.xml @@ -1,7 +1,7 @@ - + db2_lob_read diff --git a/reference/ibm_db2/functions/db2-num-fields.xml b/reference/ibm_db2/functions/db2-num-fields.xml index 57f8d4633..cd913919a 100644 --- a/reference/ibm_db2/functions/db2-num-fields.xml +++ b/reference/ibm_db2/functions/db2-num-fields.xml @@ -1,7 +1,7 @@ - + db2_num_fields diff --git a/reference/ibm_db2/functions/db2-pclose.xml b/reference/ibm_db2/functions/db2-pclose.xml index ddfe051ce..2e4a7aa56 100644 --- a/reference/ibm_db2/functions/db2-pclose.xml +++ b/reference/ibm_db2/functions/db2-pclose.xml @@ -1,6 +1,6 @@ - + db2_pclose Closes a persistent database connection diff --git a/reference/ibm_db2/functions/db2-pconnect.xml b/reference/ibm_db2/functions/db2-pconnect.xml index 1f2375eaf..98d0926f4 100644 --- a/reference/ibm_db2/functions/db2-pconnect.xml +++ b/reference/ibm_db2/functions/db2-pconnect.xml @@ -1,7 +1,7 @@ - + db2_pconnect diff --git a/reference/ibm_db2/functions/db2-prepare.xml b/reference/ibm_db2/functions/db2-prepare.xml index edc653ad0..93df63d96 100644 --- a/reference/ibm_db2/functions/db2-prepare.xml +++ b/reference/ibm_db2/functions/db2-prepare.xml @@ -1,7 +1,7 @@ - + db2_prepare diff --git a/reference/ibm_db2/functions/db2-result.xml b/reference/ibm_db2/functions/db2-result.xml index a0910111c..7676dfde7 100644 --- a/reference/ibm_db2/functions/db2-result.xml +++ b/reference/ibm_db2/functions/db2-result.xml @@ -1,7 +1,7 @@ - + db2_result diff --git a/reference/ibm_db2/functions/db2-rollback.xml b/reference/ibm_db2/functions/db2-rollback.xml index 0e43e25a6..1252cb248 100644 --- a/reference/ibm_db2/functions/db2-rollback.xml +++ b/reference/ibm_db2/functions/db2-rollback.xml @@ -1,7 +1,7 @@ - + db2_rollback diff --git a/reference/ibm_db2/functions/db2-set-option.xml b/reference/ibm_db2/functions/db2-set-option.xml index 0124d8066..3724079f9 100644 --- a/reference/ibm_db2/functions/db2-set-option.xml +++ b/reference/ibm_db2/functions/db2-set-option.xml @@ -1,6 +1,6 @@ - + db2_set_option Set options for connection or statement resources diff --git a/reference/ibm_db2/functions/db2-stmt-error.xml b/reference/ibm_db2/functions/db2-stmt-error.xml index c4a2859f8..41de934dc 100644 --- a/reference/ibm_db2/functions/db2-stmt-error.xml +++ b/reference/ibm_db2/functions/db2-stmt-error.xml @@ -25,13 +25,13 @@ example, from db2_prepare or db2_exec. - + To learn what the SQLSTATE value means, you can issue the following command at a DB2 Command Line Processor prompt: db2 '? sqlstate-value'. You can also call db2_stmt_errormsg to retrieve an explicit error message and the associated SQLCODE value. - + diff --git a/reference/ibm_db2/ini.xml b/reference/ibm_db2/ini.xml index ece4d2b24..7b6104416 100644 --- a/reference/ibm_db2/ini.xml +++ b/reference/ibm_db2/ini.xml @@ -1,6 +1,6 @@ -
+
&reftitle.runtime; &extension.runtime;
@@ -507,13 +507,13 @@ string - + On Linux and UNIX operating systems, this option defines the name of the instance to use for cataloged database connections. By default, this option is &null;. If this option is set, its value overrides the DB2INSTANCE environment variable setting. - + This option is ignored on Windows operating systems. diff --git a/reference/ibm_db2/setup.xml b/reference/ibm_db2/setup.xml index bfd289a8d..867712956 100644 --- a/reference/ibm_db2/setup.xml +++ b/reference/ibm_db2/setup.xml @@ -1,6 +1,6 @@ - + &reftitle.setup; diff --git a/reference/igbinary/functions/igbinary-serialize.xml b/reference/igbinary/functions/igbinary-serialize.xml index 5e3b0f5c8..3e4de1495 100644 --- a/reference/igbinary/functions/igbinary-serialize.xml +++ b/reference/igbinary/functions/igbinary-serialize.xml @@ -1,5 +1,5 @@ - + igbinary_serialize Generates a compact, storable binary representation of a value diff --git a/reference/igbinary/functions/igbinary-unserialize.xml b/reference/igbinary/functions/igbinary-unserialize.xml index c5e6317d6..1f1832996 100644 --- a/reference/igbinary/functions/igbinary-unserialize.xml +++ b/reference/igbinary/functions/igbinary-unserialize.xml @@ -1,5 +1,5 @@ - + igbinary_unserialize @@ -91,7 +91,7 @@ &reftitle.errors; - Objects may throw Throwables in their unserialization handlers. + Objects may throw Throwables in their unserialization handlers. diff --git a/reference/igbinary/ini.xml b/reference/igbinary/ini.xml index 21b8e28e8..42516c99c 100644 --- a/reference/igbinary/ini.xml +++ b/reference/igbinary/ini.xml @@ -1,5 +1,5 @@ -
+
&reftitle.runtime; &extension.runtime; diff --git a/reference/igbinary/setup.xml b/reference/igbinary/setup.xml index 9f4cd1a6c..02911a385 100644 --- a/reference/igbinary/setup.xml +++ b/reference/igbinary/setup.xml @@ -1,5 +1,5 @@ - + &reftitle.setup;
diff --git a/reference/imagick/book.xml b/reference/imagick/book.xml index 8d60f9c36..82974beb6 100644 --- a/reference/imagick/book.xml +++ b/reference/imagick/book.xml @@ -1,12 +1,12 @@ - + Image Processing (ImageMagick) ImageMagick - + &reftitle.intro; @@ -18,20 +18,20 @@
About ImageMagick - + ImageMagick is a software suite to create, edit, and compose bitmap images. It can read, convert and write images in a variety of formats (over 100) including DPX, EXR, GIF, JPEG, JPEG-2000, PDF, PhotoCD, PNG, Postscript, SVG, and TIFF. - - + + ImageMagick Studio LLC is a non-profit organization dedicated to making software imaging solutions freely available. - +
- + &reference.imagick.setup; &reference.imagick.constants; &reference.imagick.examples; diff --git a/reference/imagick/constants.xml b/reference/imagick/constants.xml index 11d2b432f..376cb1b3f 100644 --- a/reference/imagick/constants.xml +++ b/reference/imagick/constants.xml @@ -1,13 +1,13 @@ - + &reftitle.constants; &extension.constants; <constant>COLOR_<replaceable>*</replaceable></constant> constants - Colortype constants. These constants are mainly used with + Colortype constants. These constants are mainly used with ImagickPixel. - + imagick::COLOR_BLACK @@ -122,7 +122,7 @@ <constant>DISPOSE_<replaceable>*</replaceable></constant> constants - Dispose type constants + Dispose type constants imagick::DISPOSE_UNRECOGNIZED @@ -780,7 +780,7 @@ <constant>MONTAGEMODE_<replaceable>*</replaceable></constant> constants - + imagick::MONTAGEMODE_FRAME @@ -815,7 +815,7 @@ <constant>STYLE_<replaceable>*</replaceable></constant> constants - + imagick::STYLE_NORMAL @@ -860,7 +860,7 @@ <constant>FILTER_<replaceable>*</replaceable></constant> constants - + imagick::FILTER_UNDEFINED @@ -1025,7 +1025,7 @@ <constant>IMGTYPE_<replaceable>*</replaceable></constant> constants - + imagick::IMGTYPE_UNDEFINED @@ -1140,7 +1140,7 @@ <constant>RESOLUTION_<replaceable>*</replaceable></constant> constants - + imagick::RESOLUTION_UNDEFINED @@ -1175,7 +1175,7 @@ <constant>COMPRESSION_<replaceable>*</replaceable></constant> constants - + imagick::COMPRESSION_UNDEFINED @@ -1323,7 +1323,7 @@ <constant>PAINT_<replaceable>*</replaceable></constant> constants - + imagick::PAINT_POINT @@ -1378,7 +1378,7 @@ <constant>GRAVITY_<replaceable>*</replaceable></constant> constants - + imagick::GRAVITY_NORTHWEST @@ -1473,7 +1473,7 @@ <constant>STRETCH_<replaceable>*</replaceable></constant> constants - + imagick::STRETCH_NORMAL @@ -1568,7 +1568,7 @@ <constant>ALIGN_<replaceable>*</replaceable></constant> constants - + imagick::ALIGN_UNDEFINED @@ -1613,7 +1613,7 @@ <constant>DECORATION_<replaceable>*</replaceable></constant> constants - + imagick::DECORATION_NO @@ -1658,7 +1658,7 @@ <constant>NOISE_<replaceable>*</replaceable></constant> constants - + imagick::NOISE_UNIFORM @@ -1734,7 +1734,7 @@ <constant>CHANNEL_<replaceable>*</replaceable></constant> constants - + imagick::CHANNEL_UNDEFINED @@ -1889,7 +1889,7 @@ <constant>METRIC_<replaceable>*</replaceable></constant> constants - + imagick::METRIC_UNDEFINED @@ -1954,7 +1954,7 @@ <constant>PIXEL_<replaceable>*</replaceable></constant> constants - + imagick::PIXEL_CHAR @@ -2030,7 +2030,7 @@ <constant>EVALUATE_<replaceable>*</replaceable></constant> constants - + imagick::EVALUATE_UNDEFINED @@ -2319,7 +2319,7 @@ <constant>COLORSPACE_<replaceable>*</replaceable></constant> constants - + imagick::COLORSPACE_UNDEFINED @@ -2535,7 +2535,7 @@ <constant>VIRTUALPIXELMETHOD_<replaceable>*</replaceable></constant> constants - + imagick::VIRTUALPIXELMETHOD_UNDEFINED @@ -2676,7 +2676,7 @@ <constant>PREVIEW_<replaceable>*</replaceable></constant> constants - + imagick::PREVIEW_UNDEFINED @@ -2981,7 +2981,7 @@ <constant>RENDERINGINTENT_<replaceable>*</replaceable></constant> constants - + imagick::RENDERINGINTENT_UNDEFINED @@ -3036,7 +3036,7 @@ <constant>INTERLACE_<replaceable>*</replaceable></constant> constants - + imagick::INTERLACE_UNDEFINED @@ -3122,7 +3122,7 @@ <constant>FILLRULE_<replaceable>*</replaceable></constant> constants - + imagick::FILLRULE_UNDEFINED @@ -3157,7 +3157,7 @@ <constant>PATHUNITS_<replaceable>*</replaceable></constant> constants - + imagick::PATHUNITS_UNDEFINED @@ -3202,7 +3202,7 @@ <constant>LINECAP_<replaceable>*</replaceable></constant> constants - + imagick::LINECAP_UNDEFINED @@ -3247,7 +3247,7 @@ <constant>LINEJOIN_<replaceable>*</replaceable></constant> constants - + imagick::LINEJOIN_UNDEFINED @@ -3292,7 +3292,7 @@ <constant>RESOURCETYPE_<replaceable>*</replaceable></constant> constants - + imagick::RESOURCETYPE_UNDEFINED @@ -3374,7 +3374,7 @@ <constant>LAYERMETHOD_<replaceable>*</replaceable></constant> constants - + imagick::LAYERMETHOD_UNDEFINED @@ -3555,7 +3555,7 @@ <constant>ORIENTATION_<replaceable>*</replaceable></constant> constants - + imagick::ORIENTATION_UNDEFINED @@ -3659,7 +3659,7 @@ <constant>DISTORTION_<replaceable>*</replaceable></constant> constants - + imagick::DISTORTION_UNDEFINED @@ -3829,7 +3829,7 @@ <constant>ALPHACHANNEL_<replaceable>*</replaceable></constant> constants - + imagick::ALPHACHANNEL_ACTIVATE @@ -4021,7 +4021,7 @@ <constant>SPARSECOLORMETHOD_<replaceable>*</replaceable></constant> constants - + imagick::SPARSECOLORMETHOD_UNDEFINED @@ -4092,7 +4092,7 @@ <constant>FUNCTION_<replaceable>*</replaceable></constant> constants - + imagick::FUNCTION_UNDEFINED @@ -4130,7 +4130,7 @@ <constant>INTERPOLATE_<replaceable>*</replaceable></constant> constants - + imagick::INTERPOLATE_UNDEFINED @@ -4234,7 +4234,7 @@ <constant>DITHERMETHOD_<replaceable>*</replaceable></constant> constants - + imagick::DITHERMETHOD_UNDEFINED diff --git a/reference/imagick/imagick.xml b/reference/imagick/imagick.xml index 2f24c5dd4..31ed3b9f2 100644 --- a/reference/imagick/imagick.xml +++ b/reference/imagick/imagick.xml @@ -21,7 +21,7 @@
Image methods and global methods - + The Imagick class has the ability to hold and operate on multiple images simultaneously. This is achieved through an internal stack. There is always an internal pointer that points at the current image. Some @@ -29,15 +29,15 @@ only on the current image in the internal stack. As a convention, method names can contain the word Image to denote they affect only the current image in the stack. - +
Class Methods - + Because there are so many methods, here is a handy list of methods, somewhat reduced to their general purpose: - +
Class methods by purpose @@ -84,7 +84,7 @@ Imagick::addNoiseImage Imagick::getImageBlob - Imagick::getImagesBlob + Imagick::getImagesBlob Imagick::setFormat Imagick::getFormat diff --git a/reference/imagick/imagick/adaptiveblurimage.xml b/reference/imagick/imagick/adaptiveblurimage.xml index 5b92f7f40..993be4871 100644 --- a/reference/imagick/imagick/adaptiveblurimage.xml +++ b/reference/imagick/imagick/adaptiveblurimage.xml @@ -1,6 +1,6 @@ - + Imagick::adaptiveBlurImage Adds adaptive blur filter to image @@ -14,11 +14,11 @@ floatsigma intchannelImagick::CHANNEL_DEFAULT - + Adds an adaptive blur filter to image. The intensity of an adaptive blur depends is dramatically decreased at edge of the image, whereas a standard blur is uniform across the image. &imagick.method.available.0x629; - + @@ -28,26 +28,26 @@ radius - + The radius of the Gaussian, in pixels, not counting the center pixel. Provide a value of 0 and the radius will be chosen automagically. - + sigma - + The standard deviation of the Gaussian, in pixels. - + channel - + &imagick.parameter.channel; - + @@ -56,16 +56,16 @@ &reftitle.returnvalues; - + &imagick.return.success; - + &reftitle.errors; - + &imagick.imagick.throws; - + @@ -73,9 +73,9 @@ Using <function>Imagick::adaptiveBlurImage</function>: - + Adaptively blur an image, then display to the browser. - + boolbestfit&false; boollegacy&false; - + Adaptively resize image with data-dependent triangulation. Avoids blurring across sharp color changes. Most useful when used to shrink images slightly to a slightly smaller "web size"; may not look good when a full-sized image is adaptively resized to a thumbnail. &imagick.method.available.0x629; - + &imagick.bestfit.note; @@ -32,17 +32,17 @@ columns - + The number of columns in the scaled image. - + rows - + The number of rows in the scaled image. - + @@ -71,16 +71,16 @@ &reftitle.returnvalues; - + &imagick.return.success; - + &reftitle.errors; - + &imagick.imagick.throws; - + @@ -121,11 +121,11 @@ Using <function>Imagick::adaptiveResizeImage</function> - + Resize an image to a standard size for the web. This method works best when resizing to a size only slightly smaller than the previous image size. - + - + Imagick::adaptiveSharpenImage Adaptively sharpen the image @@ -15,10 +15,10 @@ intchannelImagick::CHANNEL_DEFAULT - + Adaptively sharpen the image by sharpening more intensely near image edges and less intensely far from edges. &imagick.method.available.0x629; - + @@ -28,25 +28,25 @@ radius - + The radius of the Gaussian, in pixels, not counting the center pixel. Use 0 for auto-select. - + sigma - + The standard deviation of the Gaussian, in pixels. - + channel - + &imagick.parameter.channel; - + @@ -55,9 +55,9 @@ &reftitle.returnvalues; - + &imagick.return.success; - + @@ -65,9 +65,9 @@ A <function>Imagick::adaptiveSharpenImage</function> example - + Adaptively sharpen the image with radius 2 and sigma 1. - + - + Imagick::adaptiveThresholdImage Selects a threshold for each pixel based on a range of intensity @@ -14,12 +14,12 @@ intheight intoffset - + Selects an individual threshold for each pixel based on the range of intensity values in its local neighborhood. This allows for thresholding of an image whose global intensity histogram doesn't contain distinctive peaks. - + @@ -29,25 +29,25 @@ width - + Width of the local neighborhood. - + height - + Height of the local neighborhood. - + offset - + The mean offset - + @@ -56,9 +56,9 @@ &reftitle.returnvalues; - + &imagick.return.success; - + diff --git a/reference/imagick/imagick/addimage.xml b/reference/imagick/imagick/addimage.xml index b77c26ae2..28265fa02 100644 --- a/reference/imagick/imagick/addimage.xml +++ b/reference/imagick/imagick/addimage.xml @@ -1,6 +1,6 @@ - + Imagick::addImage Adds new image to Imagick object image list @@ -12,10 +12,10 @@ public boolImagick::addImage Imagicksource - + Adds new image to Imagick object from the current position of the source object. After the operation iterator position is moved at the end of the list. - + @@ -25,9 +25,9 @@ source - + The source Imagick object - + @@ -36,16 +36,16 @@ &reftitle.returnvalues; - + &imagick.return.success; - + &reftitle.errors; - + &imagick.imagick.throws; - + diff --git a/reference/imagick/imagick/addnoiseimage.xml b/reference/imagick/imagick/addnoiseimage.xml index 407aaf65e..d3ed61831 100644 --- a/reference/imagick/imagick/addnoiseimage.xml +++ b/reference/imagick/imagick/addnoiseimage.xml @@ -1,6 +1,6 @@ - + Imagick::addNoiseImage Adds random noise to the image @@ -13,9 +13,9 @@ intnoise_type intchannelImagick::CHANNEL_DEFAULT - + Adds random noise to the image. - + @@ -25,18 +25,18 @@ noise_type - + The type of the noise. Refer to this list of noise constants. - + channel - + &imagick.parameter.channel; - + @@ -45,9 +45,9 @@ &reftitle.returnvalues; - + &imagick.return.success; - + diff --git a/reference/imagick/imagick/affinetransformimage.xml b/reference/imagick/imagick/affinetransformimage.xml index e81007a54..b263ec970 100644 --- a/reference/imagick/imagick/affinetransformimage.xml +++ b/reference/imagick/imagick/affinetransformimage.xml @@ -1,6 +1,6 @@ - + Imagick::affineTransformImage Transforms an image @@ -12,9 +12,9 @@ public boolImagick::affineTransformImage ImagickDrawmatrix - + Transforms an image as dictated by the affine matrix. - + @@ -24,9 +24,9 @@ matrix - + The affine matrix - + @@ -35,9 +35,9 @@ &reftitle.returnvalues; - + &imagick.return.success; - + @@ -57,8 +57,8 @@ function affineTransformImage($imagePath) { $angle = deg2rad(40); $affineRotate = array( - "sx" => cos($angle), "sy" => cos($angle), - "rx" => sin($angle), "ry" => -sin($angle), + "sx" => cos($angle), "sy" => cos($angle), + "rx" => sin($angle), "ry" => -sin($angle), "tx" => 0, "ty" => 0, ); diff --git a/reference/imagick/imagick/animateimages.xml b/reference/imagick/imagick/animateimages.xml index 24d2848aa..2d0274c18 100644 --- a/reference/imagick/imagick/animateimages.xml +++ b/reference/imagick/imagick/animateimages.xml @@ -1,6 +1,6 @@ - + Imagick::animateImages Animates an image or images @@ -13,11 +13,11 @@ stringx_server - + This method animates the image onto a local or remote X server. This method is not available on Windows. &imagick.method.available.0x636; - + @@ -27,9 +27,9 @@ x_server - + X server address - + @@ -38,9 +38,9 @@ &reftitle.returnvalues; - + &imagick.return.success; - + diff --git a/reference/imagick/imagick/annotateimage.xml b/reference/imagick/imagick/annotateimage.xml index 6e0ed07b4..8c27fb2e9 100644 --- a/reference/imagick/imagick/annotateimage.xml +++ b/reference/imagick/imagick/annotateimage.xml @@ -1,6 +1,6 @@ - + Imagick::annotateImage Annotates an image with text @@ -16,9 +16,9 @@ floatangle stringtext - + Annotates an image with text. - + @@ -28,41 +28,41 @@ draw_settings - + The ImagickDraw object that contains settings for drawing the text - + x - + Horizontal offset in pixels to the left of text - + y - + Vertical offset in pixels to the baseline of text - + angle - + The angle at which to write the text - + text - + The string to draw - + @@ -71,9 +71,9 @@ &reftitle.returnvalues; - + &imagick.return.success; - + @@ -81,9 +81,9 @@ Using <function>Imagick::annotateImage</function>: - + Annotate text on an empty image - + - + Imagick::appendImages Append a set of images @@ -12,9 +12,9 @@ public ImagickImagick::appendImages boolstack - + Append a set of images into one larger image. - + @@ -24,11 +24,11 @@ stack - + Whether to stack the images vertically. By default (or if &false; is specified) images are stacked left-to-right. If stack is &true;, images are stacked top-to-bottom. - + @@ -37,16 +37,16 @@ &reftitle.returnvalues; - + Returns Imagick instance on success. - + &reftitle.errors; - + &imagick.imagick.throws; - + diff --git a/reference/imagick/imagick/autolevelimage.xml b/reference/imagick/imagick/autolevelimage.xml index 3faa13c15..fe670c553 100644 --- a/reference/imagick/imagick/autolevelimage.xml +++ b/reference/imagick/imagick/autolevelimage.xml @@ -13,9 +13,9 @@ public boolImagick::autoLevelImage intchannelImagick::CHANNEL_DEFAULT - + Adjusts the levels of a particular image channel by scaling the minimum and maximum values to the full quantum range. - + @@ -25,9 +25,9 @@ channel - + Which channel should the auto-levelling should be done on. - + @@ -35,9 +35,9 @@ &reftitle.returnvalues; - + &imagick.return.success; - + diff --git a/reference/imagick/imagick/averageimages.xml b/reference/imagick/imagick/averageimages.xml index e08ec9b18..8e82ba855 100644 --- a/reference/imagick/imagick/averageimages.xml +++ b/reference/imagick/imagick/averageimages.xml @@ -1,6 +1,6 @@ - + Imagick::averageImages Average a set of images @@ -16,9 +16,9 @@ public ImagickImagick::averageImages - + Average a set of images. - + @@ -28,16 +28,16 @@ &reftitle.returnvalues; - + Returns a new Imagick object on success. - + &reftitle.errors; - + &imagick.imagick.throws; - + diff --git a/reference/imagick/imagick/blackthresholdimage.xml b/reference/imagick/imagick/blackthresholdimage.xml index 2e7c2d2a2..ec29cd98b 100644 --- a/reference/imagick/imagick/blackthresholdimage.xml +++ b/reference/imagick/imagick/blackthresholdimage.xml @@ -1,6 +1,6 @@ - + Imagick::blackThresholdImage Forces all pixels below the threshold into black @@ -12,10 +12,10 @@ public boolImagick::blackThresholdImage mixedthreshold - + Is like Imagick::thresholdImage() but forces all pixels below the threshold into black while leaving all pixels above the threshold unchanged. - + @@ -25,9 +25,9 @@ threshold - + The threshold below which everything turns black - + @@ -36,9 +36,9 @@ &reftitle.returnvalues; - + &imagick.return.success; - + diff --git a/reference/imagick/imagick/blueshiftimage.xml b/reference/imagick/imagick/blueshiftimage.xml index 119566897..8a9d11369 100644 --- a/reference/imagick/imagick/blueshiftimage.xml +++ b/reference/imagick/imagick/blueshiftimage.xml @@ -13,10 +13,10 @@ public boolImagick::blueShiftImage floatfactor1.5 - - + + Mutes the colors of the image to simulate a scene at nighttime in the moonlight. - + @@ -28,9 +28,9 @@ factor - - - + + + @@ -38,9 +38,9 @@ &reftitle.returnvalues; - + &imagick.return.success; - + diff --git a/reference/imagick/imagick/blurimage.xml b/reference/imagick/imagick/blurimage.xml index 107176f5d..b723587d8 100644 --- a/reference/imagick/imagick/blurimage.xml +++ b/reference/imagick/imagick/blurimage.xml @@ -1,6 +1,6 @@ - + Imagick::blurImage Adds blur filter to image @@ -14,10 +14,10 @@ floatsigma intchannel - + Adds blur filter to image. Optional third parameter to blur a specific channel. - + @@ -27,26 +27,26 @@ radius - + Blur radius - + sigma - + Standard deviation - + channel - + The Channeltype constant. When not supplied, all channels are blurred. - + @@ -55,16 +55,16 @@ &reftitle.returnvalues; - + &imagick.return.success; - + &reftitle.errors; - + &imagick.imagick.throws; - + @@ -72,9 +72,9 @@ Using <function>Imagick::blurImage</function>: - + Blur an image, then display to the browser. - + - + Imagick::borderImage Surrounds the image with a border @@ -14,9 +14,9 @@ intwidth intheight - + Surrounds the image with a border of the color defined by the bordercolor ImagickPixel object. - + @@ -26,25 +26,25 @@ bordercolor - + ImagickPixel object or a string containing the border color - + width - + Border width - + height - + Border height - + @@ -53,9 +53,9 @@ &reftitle.returnvalues; - + &imagick.return.success; - + diff --git a/reference/imagick/imagick/brightnesscontrastimage.xml b/reference/imagick/imagick/brightnesscontrastimage.xml index 1e2ef2576..241d77030 100644 --- a/reference/imagick/imagick/brightnesscontrastimage.xml +++ b/reference/imagick/imagick/brightnesscontrastimage.xml @@ -27,25 +27,25 @@ brightness - - - + + + contrast - - - + + + channel - - - + + + @@ -53,9 +53,9 @@ &reftitle.returnvalues; - + &imagick.return.success; - + diff --git a/reference/imagick/imagick/charcoalimage.xml b/reference/imagick/imagick/charcoalimage.xml index 3f1323bcb..9955e87da 100644 --- a/reference/imagick/imagick/charcoalimage.xml +++ b/reference/imagick/imagick/charcoalimage.xml @@ -1,6 +1,6 @@ - + Imagick::charcoalImage Simulates a charcoal drawing @@ -13,9 +13,9 @@ floatradius floatsigma - + Simulates a charcoal drawing. - + @@ -25,17 +25,17 @@ radius - + The radius of the Gaussian, in pixels, not counting the center pixel - + sigma - + The standard deviation of the Gaussian, in pixels - + @@ -44,9 +44,9 @@ &reftitle.returnvalues; - + &imagick.return.success; - + diff --git a/reference/imagick/imagick/chopimage.xml b/reference/imagick/imagick/chopimage.xml index 3b19a99d0..6f48419f1 100644 --- a/reference/imagick/imagick/chopimage.xml +++ b/reference/imagick/imagick/chopimage.xml @@ -1,6 +1,6 @@ - + Imagick::chopImage Removes a region of an image and trims @@ -15,9 +15,9 @@ intx inty - + Removes a region of an image and collapses the image to occupy the removed portion. - + @@ -27,33 +27,33 @@ width - + Width of the chopped area - + height - + Height of the chopped area - + x - + X origo of the chopped area - + y - + Y origo of the chopped area - + @@ -62,16 +62,16 @@ &reftitle.returnvalues; - + &imagick.return.success; - + &reftitle.errors; - + &imagick.imagick.throws; - + @@ -79,9 +79,9 @@ Using <function>Imagick::chopImage</function>: - + Example of using Imagick::chopImage - + public boolImagick::clampImage intchannelImagick::CHANNEL_DEFAULT - + Restricts the color range from 0 to the quantum depth. - + @@ -26,9 +26,9 @@ channel - - - + + + @@ -36,9 +36,9 @@ &reftitle.returnvalues; - + &return.success; - + diff --git a/reference/imagick/imagick/clear.xml b/reference/imagick/imagick/clear.xml index 719bfb159..3f01f01f6 100644 --- a/reference/imagick/imagick/clear.xml +++ b/reference/imagick/imagick/clear.xml @@ -1,6 +1,6 @@ - + Imagick::clear Clears all resources associated to Imagick object @@ -12,9 +12,9 @@ public boolImagick::clear - + Clears all resources associated to Imagick object - + @@ -24,9 +24,9 @@ &reftitle.returnvalues; - + &imagick.return.success; - + diff --git a/reference/imagick/imagick/clipimage.xml b/reference/imagick/imagick/clipimage.xml index 49fcc0c64..998ef0954 100644 --- a/reference/imagick/imagick/clipimage.xml +++ b/reference/imagick/imagick/clipimage.xml @@ -1,6 +1,6 @@ - + Imagick::clipImage Clips along the first path from the 8BIM profile @@ -12,9 +12,9 @@ public boolImagick::clipImage - + Clips along the first path from the 8BIM profile, if present. - + @@ -24,16 +24,16 @@ &reftitle.returnvalues; - + &imagick.return.success; - + &reftitle.errors; - + &imagick.imagick.throws; - + diff --git a/reference/imagick/imagick/clipimagepath.xml b/reference/imagick/imagick/clipimagepath.xml index 0bb573ea9..2ccc12202 100644 --- a/reference/imagick/imagick/clipimagepath.xml +++ b/reference/imagick/imagick/clipimagepath.xml @@ -14,9 +14,9 @@ stringpathname stringinside - + Clips along the named paths from the 8BIM profile, if present. Later operations take effect inside the path. Id may be a number if preceded with #, to work on a numbered path, e.g., "#1" to use the first path. - + &warn.undocumented.func; @@ -28,17 +28,17 @@ pathname - - - + + + inside - - - + + + @@ -46,9 +46,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/imagick/imagick/clippathimage.xml b/reference/imagick/imagick/clippathimage.xml index a9ca1ebd3..29378cbfe 100644 --- a/reference/imagick/imagick/clippathimage.xml +++ b/reference/imagick/imagick/clippathimage.xml @@ -1,6 +1,6 @@ - + Imagick::clipPathImage Clips along the named paths from the 8BIM profile @@ -13,12 +13,12 @@ stringpathname boolinside - + Clips along the named paths from the 8BIM profile, if present. Later operations take effect inside the path. It may be a number if preceded with #, to work on a numbered path, e.g., "#1" to use the first path. - + @@ -28,18 +28,18 @@ pathname - + The name of the path - + inside - + If &true; later operations take effect inside clipping path. Otherwise later operations take effect outside clipping path. - + @@ -48,16 +48,16 @@ &reftitle.returnvalues; - + &imagick.return.success; - + &reftitle.errors; - + &imagick.imagick.throws; - + diff --git a/reference/imagick/imagick/clone.xml b/reference/imagick/imagick/clone.xml index f9dc3b6d3..e64fc2b09 100644 --- a/reference/imagick/imagick/clone.xml +++ b/reference/imagick/imagick/clone.xml @@ -1,6 +1,6 @@ - + Imagick::clone Makes an exact copy of the Imagick object @@ -12,9 +12,9 @@ public ImagickImagick::clone - + Makes an exact copy of the Imagick object. - + This function has been DEPRECATED as of imagick 3.1.0 @@ -31,9 +31,9 @@ &reftitle.returnvalues; - + A copy of the Imagick object is returned. - + diff --git a/reference/imagick/imagick/clutimage.xml b/reference/imagick/imagick/clutimage.xml index ebd1843b7..975769bf3 100644 --- a/reference/imagick/imagick/clutimage.xml +++ b/reference/imagick/imagick/clutimage.xml @@ -1,6 +1,6 @@ - + Imagick::clutImage Replaces colors in the image @@ -14,10 +14,10 @@ intchannelImagick::CHANNEL_DEFAULT - + Replaces colors in the image from a color lookup table. Optional second parameter to replace colors in a specific channel. &imagick.method.available.0x636; - + @@ -27,18 +27,18 @@ lookup_table - + Imagick object containing the color lookup table - + channel - + The Channeltype constant. When not supplied, default channels are replaced. - + @@ -47,9 +47,9 @@ &reftitle.returnvalues; - + &imagick.return.success; - + @@ -57,9 +57,9 @@ Using <function>Imagick::clutImage</function>: - + Replace colors in the image from a color lookup table. - + - + Imagick::coalesceImages Composites a set of images @@ -12,14 +12,14 @@ public ImagickImagick::coalesceImages - + Composites a set of images while respecting any page offsets and disposal methods. GIF, MIFF, and MNG animation sequences typically start with an image background and each subsequent image varies in size and offset. Returns a new Imagick object where each image in the sequence is the same size as the first and composited with the next image in the sequence. - + @@ -29,16 +29,16 @@ &reftitle.returnvalues; - + Returns a new Imagick object on success. - + &reftitle.errors; - + &imagick.imagick.throws; - + diff --git a/reference/imagick/imagick/colorfloodfillimage.xml b/reference/imagick/imagick/colorfloodfillimage.xml index 4f2d7c632..1a4c343e3 100644 --- a/reference/imagick/imagick/colorfloodfillimage.xml +++ b/reference/imagick/imagick/colorfloodfillimage.xml @@ -1,6 +1,6 @@ - + Imagick::colorFloodfillImage Changes the color value of any pixel that matches target @@ -20,10 +20,10 @@ intx inty - + Changes the color value of any pixel that matches target and is an immediate neighbor. - + @@ -33,43 +33,43 @@ fill - + ImagickPixel object containing the fill color - + fuzz - + The amount of fuzz. For example, set fuzz to 10 and the color red at intensities of 100 and 102 respectively are now interpreted as the same color for the purposes of the floodfill. - + bordercolor - + ImagickPixel object containing the border color - + x - + X start position of the floodfill - + y - + Y start position of the floodfill - + @@ -78,16 +78,16 @@ &reftitle.returnvalues; - + &imagick.return.success; - + &reftitle.errors; - + &imagick.imagick.throws; - + diff --git a/reference/imagick/imagick/colorizeimage.xml b/reference/imagick/imagick/colorizeimage.xml index cc1370157..969d7dcff 100644 --- a/reference/imagick/imagick/colorizeimage.xml +++ b/reference/imagick/imagick/colorizeimage.xml @@ -1,6 +1,6 @@ - + Imagick::colorizeImage Blends the fill color with the image @@ -14,9 +14,9 @@ mixedopacity boollegacy&false; - + Blends the fill color with each pixel in the image. - + @@ -26,18 +26,18 @@ colorize - + ImagickPixel object or a string containing the colorize color - + opacity - - ImagickPixel object or an float containing the opacity value. + + ImagickPixel object or an float containing the opacity value. 1.0 is fully opaque and 0.0 is fully transparent. - + @@ -46,16 +46,16 @@ &reftitle.returnvalues; - + &imagick.return.success; - + &reftitle.errors; - + &imagick.imagick.throws; - + diff --git a/reference/imagick/imagick/colormatriximage.xml b/reference/imagick/imagick/colormatriximage.xml index 53a406e0e..2a2a0cb7e 100644 --- a/reference/imagick/imagick/colormatriximage.xml +++ b/reference/imagick/imagick/colormatriximage.xml @@ -13,9 +13,9 @@ public boolImagick::colorMatrixImage arraycolor_matrix - + Apply color transformation to an image. The method permits saturation changes, hue rotation, luminance to alpha, and various other effects. Although variable-sized transformation matrices can be used, typically one uses a 5x5 matrix for an RGBA image and a 6x6 for CMYKA (or RGBA with offsets). The matrix is similar to those used by Adobe Flash except offsets are in column 6 rather than 5 (in support of CMYKA images) and offsets are normalized (divide Flash offset by 255) - + @@ -26,9 +26,9 @@ color_matrix - - - + + + @@ -36,9 +36,9 @@ &reftitle.returnvalues; - + &imagick.return.success; - + @@ -73,7 +73,7 @@ function colorMatrixImage($imagePath, $colorMatrix) { $imagick->setImageFormat('png'); $imagick->colorMatrixImage($colorMatrix); - + $background->compositeImage($imagick, \Imagick::COMPOSITE_ATOP, 0, 0); header("Content-Type: image/png"); diff --git a/reference/imagick/imagick/combineimages.xml b/reference/imagick/imagick/combineimages.xml index 2fc393654..a9c58f7d3 100644 --- a/reference/imagick/imagick/combineimages.xml +++ b/reference/imagick/imagick/combineimages.xml @@ -1,6 +1,6 @@ - + Imagick::combineImages Combines one or more images into a single image @@ -12,13 +12,13 @@ public ImagickImagick::combineImages intchannelType - + Combines one or more images into a single image. The grayscale value of the pixels of each image in the sequence is assigned in order to the specified channels of the combined image. The typical ordering would be image 1 => Red, 2 => Green, 3 => Blue, etc. - + @@ -28,12 +28,12 @@ channelType - + Provide any channel constant that is valid for your channel mode. To apply to more than one channel, combine channeltype constants using bitwise operators. Refer to this list of channel constants. - + @@ -42,16 +42,16 @@ &reftitle.returnvalues; - + &imagick.return.success; - + &reftitle.errors; - + &imagick.imagick.throws; - + diff --git a/reference/imagick/imagick/commentimage.xml b/reference/imagick/imagick/commentimage.xml index 5291e6160..e8c137afb 100644 --- a/reference/imagick/imagick/commentimage.xml +++ b/reference/imagick/imagick/commentimage.xml @@ -1,6 +1,6 @@ - + Imagick::commentImage Adds a comment to your image @@ -12,9 +12,9 @@ public boolImagick::commentImage stringcomment - + Adds a comment to your image. - + @@ -24,9 +24,9 @@ comment - + The comment to add - + @@ -35,16 +35,16 @@ &reftitle.returnvalues; - + &imagick.return.success; - + &reftitle.errors; - + &imagick.imagick.throws; - + @@ -52,9 +52,9 @@ Using <function>Imagick::commentImage</function>: - + Commenting an image and retrieving the comment: - + - + Imagick::compareImageChannels Returns the difference in one or more images @@ -14,9 +14,9 @@ intchannelType intmetricType - + Compares one or more images and returns the difference image. - + @@ -26,28 +26,28 @@ image - + Imagick object containing the image to compare. - + channelType - + Provide any channel constant that is valid for your channel mode. To apply to more than one channel, combine channeltype constants using bitwise operators. Refer to this list of channel constants. - + metricType - + One of the metric type constants. - + @@ -56,17 +56,17 @@ &reftitle.returnvalues; - + Array consisting of new_wand and distortion. - + &reftitle.errors; - + &imagick.imagick.throws; - + diff --git a/reference/imagick/imagick/compareimagelayers.xml b/reference/imagick/imagick/compareimagelayers.xml index 248911f43..331dba3de 100644 --- a/reference/imagick/imagick/compareimagelayers.xml +++ b/reference/imagick/imagick/compareimagelayers.xml @@ -1,6 +1,6 @@ - + Imagick::compareImageLayers Returns the maximum bounding region between images @@ -13,11 +13,11 @@ intmethod - + Compares each image with the next in a sequence and returns the maximum bounding region of any pixel differences it discovers. &imagick.method.available.0x629; - + @@ -27,9 +27,9 @@ method - + One of the layer method constants. - + @@ -38,16 +38,16 @@ &reftitle.returnvalues; - + &imagick.return.success; - + &reftitle.errors; - + &imagick.imagick.throws; - + @@ -55,9 +55,9 @@ Using <function>Imagick::compareImageLayers</function> - + Comparing image layers - + - + Imagick::compareImages Compares an image to a reconstructed image @@ -13,9 +13,9 @@ Imagickcompare intmetric - + Returns an array containing a reconstructed image and the difference between images. - + @@ -25,18 +25,18 @@ compare - + An image to compare to. - + metric - + Provide a valid metric type constant. Refer to this list of metric constants. - + @@ -45,16 +45,16 @@ &reftitle.returnvalues; - + Returns an array containing a reconstructed image and the difference between images. - + &reftitle.errors; - + &imagick.imagick.throws; - + @@ -62,9 +62,9 @@ Using <function>Imagick::compareImages</function>: - + Compare images and display the reconstructed image - + - + Imagick::compositeImage Composite one image onto another @@ -16,9 +16,9 @@ inty intchannelImagick::CHANNEL_DEFAULT - + Composite one image onto another at the specified offset. Any extra arguments needed for the compose algorithm should passed to setImageArtifact with 'compose:args' as the first parameter and the data as the second parameter. - + @@ -28,46 +28,46 @@ composite_object - + Imagick object which holds the composite image - + compose - - Composite operator. See + Composite operator. See Composite Operator Constants - + x - + The column offset of the composited image - + y - + The row offset of the composited image - + channel - + Provide any channel constant that is valid for your channel mode. To apply to more than one channel, combine channeltype constants using bitwise operators. Refer to this list of channel constants. - + @@ -76,9 +76,9 @@ &reftitle.returnvalues; - + &imagick.return.success; - + @@ -86,9 +86,9 @@ Using <function>Imagick::compositeImage</function>: - + Composite two images with the 'mathematics' compose method - + writeImage("./output.png"); - + &reftitle.seealso; @@ -119,7 +119,7 @@ $src1->writeImage("./output.png"); - + - + Imagick::__construct The Imagick constructor @@ -12,9 +12,9 @@ public Imagick::__construct mixedfiles - + Creates an Imagick instance for a specified image or set of images. - + @@ -23,20 +23,20 @@ files - + The path to an image to load or an array of paths. Paths can include wildcards for file names, or can be URLs. - + - + &reftitle.errors; - + &imagick.imagick.throws; - + diff --git a/reference/imagick/imagick/contrastimage.xml b/reference/imagick/imagick/contrastimage.xml index 3deeec650..1dd6a0a28 100644 --- a/reference/imagick/imagick/contrastimage.xml +++ b/reference/imagick/imagick/contrastimage.xml @@ -1,6 +1,6 @@ - + Imagick::contrastImage Change the contrast of the image @@ -12,12 +12,12 @@ public boolImagick::contrastImage boolsharpen - + Enhances the intensity differences between the lighter and darker elements of the image. Set sharpen to a value other than 0 to increase the image contrast otherwise the contrast is reduced. - + @@ -27,9 +27,9 @@ sharpen - + The sharpen value - + @@ -38,16 +38,16 @@ &reftitle.returnvalues; - + &imagick.return.success; - + &reftitle.errors; - + &imagick.imagick.throws; - + diff --git a/reference/imagick/imagick/contraststretchimage.xml b/reference/imagick/imagick/contraststretchimage.xml index 9f2305d5f..70526ebcf 100644 --- a/reference/imagick/imagick/contraststretchimage.xml +++ b/reference/imagick/imagick/contraststretchimage.xml @@ -1,6 +1,6 @@ - + Imagick::contrastStretchImage Enhances the contrast of a color image @@ -15,10 +15,10 @@ intchannelImagick::CHANNEL_DEFAULT - + Enhances the contrast of a color image by adjusting the pixels color to span the entire range of colors available. &imagick.method.available.0x629; - + @@ -28,28 +28,28 @@ black_point - + The black point. - + white_point - + The white point. - + channel - + Provide any channel constant that is valid for your channel mode. To apply to more than one channel, combine channeltype constants using bitwise operators. Imagick::CHANNEL_ALL. Refer to this list of channel constants. - + @@ -58,9 +58,9 @@ &reftitle.returnvalues; - + &imagick.return.success; - + diff --git a/reference/imagick/imagick/convolveimage.xml b/reference/imagick/imagick/convolveimage.xml index 639c55f43..b2c62964e 100644 --- a/reference/imagick/imagick/convolveimage.xml +++ b/reference/imagick/imagick/convolveimage.xml @@ -1,6 +1,6 @@ - + Imagick::convolveImage Applies a custom convolution kernel to the image @@ -13,9 +13,9 @@ arraykernel intchannelImagick::CHANNEL_DEFAULT - + Applies a custom convolution kernel to the image. - + @@ -25,20 +25,20 @@ kernel - + The convolution kernel - + channel - + Provide any channel constant that is valid for your channel mode. To apply to more than one channel, combine channeltype constants using bitwise operators. Refer to this list of channel constants. - + @@ -47,16 +47,16 @@ &reftitle.returnvalues; - + &imagick.return.success; - + &reftitle.errors; - + &imagick.imagick.throws; - + @@ -70,7 +70,7 @@ setImageBias($bias * \Imagick::getQuantum()); $imagick->convolveImage($kernelMatrix); diff --git a/reference/imagick/imagick/count.xml b/reference/imagick/imagick/count.xml index 4cff71e37..04100576b 100644 --- a/reference/imagick/imagick/count.xml +++ b/reference/imagick/imagick/count.xml @@ -13,9 +13,9 @@ public intImagick::count intmode0 - + Returns the number of images. - + @@ -25,9 +25,9 @@ mode - + An unused argument. Currently there is a non-particularly well defined feature in PHP where calling count() on a countable object might (or might not) require this method to accept a parameter. This parameter is here to be conformant with the interface of countable, even though the param is not used. - + @@ -35,9 +35,9 @@ &reftitle.returnvalues; - + Returns the number of images. - + diff --git a/reference/imagick/imagick/cropimage.xml b/reference/imagick/imagick/cropimage.xml index f70368ccb..128e15568 100644 --- a/reference/imagick/imagick/cropimage.xml +++ b/reference/imagick/imagick/cropimage.xml @@ -1,6 +1,6 @@ - + Imagick::cropImage Extracts a region of the image @@ -15,9 +15,9 @@ intx inty - + Extracts a region of the image. - + @@ -27,33 +27,33 @@ width - + The width of the crop - + height - + The height of the crop - + x - + The X coordinate of the cropped region's top left corner - + y - + The Y coordinate of the cropped region's top left corner - + @@ -62,16 +62,16 @@ &reftitle.returnvalues; - + &imagick.return.success; - + &reftitle.errors; - + &imagick.imagick.throws; - + diff --git a/reference/imagick/imagick/cropthumbnailimage.xml b/reference/imagick/imagick/cropthumbnailimage.xml index 94b66099b..2309d93a3 100644 --- a/reference/imagick/imagick/cropthumbnailimage.xml +++ b/reference/imagick/imagick/cropthumbnailimage.xml @@ -14,10 +14,10 @@ intheight boollegacy&false; - + Creates a fixed size thumbnail by first scaling the image up or down and cropping a specified area from the center. - + @@ -27,17 +27,17 @@ width - + The width of the thumbnail - + height - + The Height of the thumbnail - + @@ -57,16 +57,16 @@ &reftitle.returnvalues; - + &imagick.return.success; - + &reftitle.errors; - + &imagick.imagick.throws; - + &reftitle.changelog; diff --git a/reference/imagick/imagick/current.xml b/reference/imagick/imagick/current.xml index 05e24dafe..0429bbbf5 100644 --- a/reference/imagick/imagick/current.xml +++ b/reference/imagick/imagick/current.xml @@ -1,6 +1,6 @@ - + Imagick::current Returns a reference to the current Imagick object @@ -12,9 +12,9 @@ public ImagickImagick::current - + Returns reference to the current imagick object with image pointer at the correct sequence. - + @@ -24,16 +24,16 @@ &reftitle.returnvalues; - + Returns self on success. - + &reftitle.errors; - + &imagick.imagick.throws; - + diff --git a/reference/imagick/imagick/cyclecolormapimage.xml b/reference/imagick/imagick/cyclecolormapimage.xml index cb5e99c02..27295dde5 100644 --- a/reference/imagick/imagick/cyclecolormapimage.xml +++ b/reference/imagick/imagick/cyclecolormapimage.xml @@ -1,6 +1,6 @@ - + Imagick::cycleColormapImage Displaces an image's colormap @@ -12,11 +12,11 @@ public boolImagick::cycleColormapImage intdisplace - + Displaces an image's colormap by a given number of positions. If you cycle the colormap a number of times you can produce a psychedelic effect. - + @@ -26,9 +26,9 @@ displace - + The amount to displace the colormap. - + @@ -37,16 +37,16 @@ &reftitle.returnvalues; - + &imagick.return.success; - + &reftitle.errors; - + &imagick.imagick.throws; - + diff --git a/reference/imagick/imagick/decipherimage.xml b/reference/imagick/imagick/decipherimage.xml index 20bfc4fac..e4d1556dd 100644 --- a/reference/imagick/imagick/decipherimage.xml +++ b/reference/imagick/imagick/decipherimage.xml @@ -1,6 +1,6 @@ - + Imagick::decipherImage Deciphers an image @@ -13,11 +13,11 @@ stringpassphrase - + Deciphers image that has been enciphered before. The image must be enciphered using Imagick::encipherImage. &imagick.method.available.0x639; - + @@ -27,9 +27,9 @@ passphrase - + The passphrase - + @@ -38,9 +38,9 @@ &reftitle.returnvalues; - + &imagick.return.success; - + diff --git a/reference/imagick/imagick/deconstructimages.xml b/reference/imagick/imagick/deconstructimages.xml index 5b0fd7a88..b626aac44 100644 --- a/reference/imagick/imagick/deconstructimages.xml +++ b/reference/imagick/imagick/deconstructimages.xml @@ -1,6 +1,6 @@ - + Imagick::deconstructImages Returns certain pixel differences between images @@ -12,10 +12,10 @@ public ImagickImagick::deconstructImages - + Compares each image with the next in a sequence and returns the maximum bounding region of any pixel differences it discovers. - + @@ -25,16 +25,16 @@ &reftitle.returnvalues; - + Returns a new Imagick object on success. - + &reftitle.errors; - + &imagick.imagick.throws; - + diff --git a/reference/imagick/imagick/deleteimageartifact.xml b/reference/imagick/imagick/deleteimageartifact.xml index 5d2f309d6..0978da1cb 100644 --- a/reference/imagick/imagick/deleteimageartifact.xml +++ b/reference/imagick/imagick/deleteimageartifact.xml @@ -1,6 +1,6 @@ - + Imagick::deleteImageArtifact Delete image artifact @@ -12,11 +12,11 @@ public boolImagick::deleteImageArtifact stringartifact - - Deletes an artifact associated with the image. The difference between image properties and + + Deletes an artifact associated with the image. The difference between image properties and image artifacts is that properties are public and artifacts are private. &imagick.method.available.0x657; - + @@ -26,9 +26,9 @@ artifact - + The name of the artifact to delete - + @@ -37,16 +37,16 @@ &reftitle.returnvalues; - + &imagick.return.success; - + &reftitle.errors; - + &imagick.imagick.throws; - + diff --git a/reference/imagick/imagick/deleteimageproperty.xml b/reference/imagick/imagick/deleteimageproperty.xml index 6710cf07f..4de5f77fd 100644 --- a/reference/imagick/imagick/deleteimageproperty.xml +++ b/reference/imagick/imagick/deleteimageproperty.xml @@ -13,9 +13,9 @@ public boolImagick::deleteImageProperty stringname - + Deletes an image property. - + @@ -25,9 +25,9 @@ name - + The name of the property to delete. - + @@ -35,9 +35,9 @@ &reftitle.returnvalues; - + &imagick.return.success; - + diff --git a/reference/imagick/imagick/deskewimage.xml b/reference/imagick/imagick/deskewimage.xml index 9d0bc7866..dfac10f55 100644 --- a/reference/imagick/imagick/deskewimage.xml +++ b/reference/imagick/imagick/deskewimage.xml @@ -13,10 +13,10 @@ public boolImagick::deskewImage floatthreshold - + This method can be used to remove skew from for example scanned images where the paper was not properly placed on the scanning surface. &imagick.method.available.0x645; - + @@ -26,9 +26,9 @@ threshold - + Deskew threshold - + @@ -37,9 +37,9 @@ &reftitle.returnvalues; - + - + @@ -54,7 +54,7 @@ function deskewImage($threshold) { $imagick = new \Imagick(realpath("images/NYTimes-Page1-11-11-1918.jpg")); $deskewImagick = clone $imagick; - + //This is the only thing required for deskewing. $deskewImagick->deskewImage($threshold); diff --git a/reference/imagick/imagick/despeckleimage.xml b/reference/imagick/imagick/despeckleimage.xml index 7d16a2625..f9d2b51c8 100644 --- a/reference/imagick/imagick/despeckleimage.xml +++ b/reference/imagick/imagick/despeckleimage.xml @@ -1,6 +1,6 @@ - + Imagick::despeckleImage Reduces the speckle noise in an image @@ -12,9 +12,9 @@ public boolImagick::despeckleImage - + Reduces the speckle noise in an image while preserving the edges of the original image. - + @@ -24,16 +24,16 @@ &reftitle.returnvalues; - + &imagick.return.success; - + &reftitle.errors; - + &imagick.imagick.throws; - + diff --git a/reference/imagick/imagick/destroy.xml b/reference/imagick/imagick/destroy.xml index 71ba57ad1..3d29d9e3f 100644 --- a/reference/imagick/imagick/destroy.xml +++ b/reference/imagick/imagick/destroy.xml @@ -1,6 +1,6 @@ - + Imagick::destroy Destroys the Imagick object @@ -12,10 +12,10 @@ public boolImagick::destroy - - Destroys the Imagick object and frees all resources associated with it. + + Destroys the Imagick object and frees all resources associated with it. This method is deprecated in favour of Imagick::clear. - + @@ -25,9 +25,9 @@ &reftitle.returnvalues; - + &imagick.return.success; - + diff --git a/reference/imagick/imagick/displayimage.xml b/reference/imagick/imagick/displayimage.xml index d72fb78a9..d6d95f33e 100644 --- a/reference/imagick/imagick/displayimage.xml +++ b/reference/imagick/imagick/displayimage.xml @@ -1,6 +1,6 @@ - + Imagick::displayImage Displays an image @@ -12,9 +12,9 @@ public boolImagick::displayImage stringservername - + This method displays an image on a X server. - + @@ -24,9 +24,9 @@ servername - + The X server name - + @@ -35,16 +35,16 @@ &reftitle.returnvalues; - + &imagick.return.success; - + &reftitle.errors; - + &imagick.imagick.throws; - + diff --git a/reference/imagick/imagick/displayimages.xml b/reference/imagick/imagick/displayimages.xml index d4cc2cac8..9553d707f 100644 --- a/reference/imagick/imagick/displayimages.xml +++ b/reference/imagick/imagick/displayimages.xml @@ -1,6 +1,6 @@ - + Imagick::displayImages Displays an image or image sequence @@ -12,9 +12,9 @@ public boolImagick::displayImages stringservername - + Displays an image or image sequence on a X server. - + @@ -24,9 +24,9 @@ servername - + The X server name - + @@ -35,16 +35,16 @@ &reftitle.returnvalues; - + &imagick.return.success; - + - + &reftitle.errors; - + &imagick.imagick.throws; - + diff --git a/reference/imagick/imagick/distortimage.xml b/reference/imagick/imagick/distortimage.xml index 6cb651fce..ca4761a33 100644 --- a/reference/imagick/imagick/distortimage.xml +++ b/reference/imagick/imagick/distortimage.xml @@ -14,21 +14,21 @@ arrayarguments boolbestfit - + Distorts an image using various distortion methods, by mapping color lookups of the source image to a new destination image usually of the same size as the source image, unless 'bestfit' is set to &true;. - - + + If 'bestfit' is enabled, and distortion allows it, the destination image is adjusted to ensure the whole source 'image' will just fit within the final destination image, which will be sized and offset accordingly. Also in many cases the virtual offset of the source image will be taken into account in the mapping. - - + + &imagick.method.available.0x636; - + @@ -38,26 +38,26 @@ method - - The method of image distortion. See + The method of image distortion. See distortion constants - + arguments - + The arguments for this distortion method - + bestfit - + Attempt to resize destination to fit distorted source - + @@ -66,16 +66,16 @@ &reftitle.returnvalues; - + &imagick.return.success; - + &reftitle.errors; - + &imagick.imagick.throws; - + @@ -83,9 +83,9 @@ Using <function>Imagick::distortImage</function>: - + Distort an image and display to the browser. - + setImageVirtualPixelMethod(Imagick::VIRTUALPIXELMETHOD_TRANSPARENT); $im->setImageMatte(true); /* Control points for the distortion */ -$controlPoints = array( 10, 10, +$controlPoints = array( 10, 10, 10, 5, 10, $im->getImageHeight() - 20, @@ -117,7 +117,7 @@ $controlPoints = array( 10, 10, $im->getImageWidth() - 10, $im->getImageHeight() - 10, $im->getImageWidth() - 10, $im->getImageHeight() - 30); -/* Perform the distortion */ +/* Perform the distortion */ $im->distortImage(Imagick::DISTORTION_PERSPECTIVE, $controlPoints, true); /* Output the image */ diff --git a/reference/imagick/imagick/drawimage.xml b/reference/imagick/imagick/drawimage.xml index 5e211b2b5..4a4cf204e 100644 --- a/reference/imagick/imagick/drawimage.xml +++ b/reference/imagick/imagick/drawimage.xml @@ -1,6 +1,6 @@ - + Imagick::drawImage Renders the ImagickDraw object on the current image @@ -12,9 +12,9 @@ public boolImagick::drawImage ImagickDrawdraw - + Renders the ImagickDraw object on the current image. - + @@ -24,9 +24,9 @@ draw - + The drawing operations to render on the image. - + @@ -35,9 +35,9 @@ &reftitle.returnvalues; - + &imagick.return.success; - + diff --git a/reference/imagick/imagick/edgeimage.xml b/reference/imagick/imagick/edgeimage.xml index d37ecdddc..7db37530d 100644 --- a/reference/imagick/imagick/edgeimage.xml +++ b/reference/imagick/imagick/edgeimage.xml @@ -1,6 +1,6 @@ - + Imagick::edgeImage Enhance edges within the image @@ -12,10 +12,10 @@ public boolImagick::edgeImage floatradius - + Enhance edges within the image with a convolution filter of the given radius. Use radius 0 and it will be auto-selected. - + @@ -25,9 +25,9 @@ radius - + The radius of the operation. - + @@ -36,16 +36,16 @@ &reftitle.returnvalues; - + &imagick.return.success; - + &reftitle.errors; - + &imagick.imagick.throws; - + diff --git a/reference/imagick/imagick/embossimage.xml b/reference/imagick/imagick/embossimage.xml index 35fb70e94..95a17b883 100644 --- a/reference/imagick/imagick/embossimage.xml +++ b/reference/imagick/imagick/embossimage.xml @@ -1,6 +1,6 @@ - + Imagick::embossImage Returns a grayscale image with a three-dimensional effect @@ -13,12 +13,12 @@ floatradius floatsigma - + Returns a grayscale image with a three-dimensional effect. We convolve - the image with a Gaussian operator of the given radius and standard - deviation (sigma). For reasonable results, radius should be larger than + the image with a Gaussian operator of the given radius and standard + deviation (sigma). For reasonable results, radius should be larger than sigma. Use a radius of 0 and it will choose a suitable radius for you. - + @@ -28,17 +28,17 @@ radius - + The radius of the effect - + sigma - + The sigma of the effect - + @@ -47,16 +47,16 @@ &reftitle.returnvalues; - + &imagick.return.success; - + &reftitle.errors; - + &imagick.imagick.throws; - + diff --git a/reference/imagick/imagick/encipherimage.xml b/reference/imagick/imagick/encipherimage.xml index 55a854e20..5d7077e40 100644 --- a/reference/imagick/imagick/encipherimage.xml +++ b/reference/imagick/imagick/encipherimage.xml @@ -1,6 +1,6 @@ - + Imagick::encipherImage Enciphers an image @@ -13,11 +13,11 @@ stringpassphrase - + Converts plain pixels to enciphered pixels. The image is not readable until it has been deciphered using Imagick::decipherImage &imagick.method.available.0x639; - + @@ -27,9 +27,9 @@ passphrase - + The passphrase - + @@ -38,9 +38,9 @@ &reftitle.returnvalues; - + &imagick.return.success; - + diff --git a/reference/imagick/imagick/enhanceimage.xml b/reference/imagick/imagick/enhanceimage.xml index 56c061171..b8fdcd395 100644 --- a/reference/imagick/imagick/enhanceimage.xml +++ b/reference/imagick/imagick/enhanceimage.xml @@ -1,6 +1,6 @@ - + Imagick::enhanceImage Improves the quality of a noisy image @@ -12,9 +12,9 @@ public boolImagick::enhanceImage - + Applies a digital filter that improves the quality of a noisy image. - + @@ -24,16 +24,16 @@ &reftitle.returnvalues; - + &imagick.return.success; - + &reftitle.errors; - + &imagick.imagick.throws; - + diff --git a/reference/imagick/imagick/equalizeimage.xml b/reference/imagick/imagick/equalizeimage.xml index a4404706d..75cd65a91 100644 --- a/reference/imagick/imagick/equalizeimage.xml +++ b/reference/imagick/imagick/equalizeimage.xml @@ -1,6 +1,6 @@ - + Imagick::equalizeImage Equalizes the image histogram @@ -12,9 +12,9 @@ public boolImagick::equalizeImage - + Equalizes the image histogram. - + @@ -24,16 +24,16 @@ &reftitle.returnvalues; - + &imagick.return.success; - + &reftitle.errors; - + &imagick.imagick.throws; - + diff --git a/reference/imagick/imagick/evaluateimage.xml b/reference/imagick/imagick/evaluateimage.xml index 7a9b0ca27..77eff8195 100644 --- a/reference/imagick/imagick/evaluateimage.xml +++ b/reference/imagick/imagick/evaluateimage.xml @@ -28,28 +28,28 @@ op - + The evaluation operator - + constant - + The value of the operator - + channel - + Provide any channel constant that is valid for your channel mode. To apply to more than one channel, combine channeltype constants using bitwise operators. Refer to this list of channel constants. - + @@ -58,26 +58,26 @@ &reftitle.returnvalues; - + &imagick.return.success; - + &reftitle.errors; - + &imagick.imagick.throws; - + - + &reftitle.examples; Using <function>Imagick::evaluateImage</function> - + Using evaluateImage to reduce opacity in an image. - + stringmap intSTORAGE - - Exports image pixels into an array. The map defines the ordering of the exported + + Exports image pixels into an array. The map defines the ordering of the exported pixels. The size of the returned array is width * height * strlen(map). &imagick.method.available.0x647; - + @@ -32,50 +32,50 @@ x - + X-coordinate of the exported area - + y - + Y-coordinate of the exported area - + width - + Width of the exported aread - + height - + Height of the exported area - + map - - Ordering of the exported pixels. For example "RGB". - Valid characters for the map are R, G, B, A, O, C, Y, M, K, I and P. - + + Ordering of the exported pixels. For example "RGB". + Valid characters for the map are R, G, B, A, O, C, Y, M, K, I and P. + STORAGE - + Refer to this list of pixel type constants - + @@ -84,26 +84,26 @@ &reftitle.returnvalues; - + Returns an array containing the pixels values. - + &reftitle.errors; - + &imagick.imagick.throws; - + - + &reftitle.examples; Using <function>Imagick::exportImagePixels</function> - + Export image pixels into an array - + inty - + Comfortability method for setting image size. The method sets the image size and allows setting x,y coordinates where the new area begins. &imagick.method.available.0x631; - + @@ -41,33 +41,33 @@ width - + The new width - + height - + The new height - + x - + X position for the new size - + y - + Y position for the new size - + @@ -76,9 +76,9 @@ &reftitle.returnvalues; - + &imagick.return.success; - + diff --git a/reference/imagick/imagick/filter.xml b/reference/imagick/imagick/filter.xml index 4ed48422f..bcffabcb9 100644 --- a/reference/imagick/imagick/filter.xml +++ b/reference/imagick/imagick/filter.xml @@ -18,11 +18,11 @@ ImagickKernelImagickKernel intchannelImagick::CHANNEL_UNDEFINED - + Applies a custom convolution kernel to the image. - + + - @@ -31,17 +31,17 @@ ImagickKernel - + An instance of ImagickKernel that represents either a single kernel or a linked series of kernels. - + channel - + &imagick.parameter.channel; - + @@ -49,9 +49,9 @@ &reftitle.returnvalues; - + &imagick.return.success; - + @@ -72,10 +72,10 @@ function filter($imagePath) { [0, 5, 0], [-1, 0, -1], ]; - + $kernel = \ImagickKernel::fromMatrix($matrix); - $strength = 0.5; - $kernel->scale($strength, \Imagick::NORMALIZE_KERNEL_VALUE); + $strength = 0.5; + $kernel->scale($strength, \Imagick::NORMALIZE_KERNEL_VALUE); $kernel->addUnityKernel(1 - $strength); $imagick->filter($kernel); diff --git a/reference/imagick/imagick/flattenimages.xml b/reference/imagick/imagick/flattenimages.xml index 9aa556a69..6775fda46 100644 --- a/reference/imagick/imagick/flattenimages.xml +++ b/reference/imagick/imagick/flattenimages.xml @@ -1,6 +1,6 @@ - + Imagick::flattenImages Merges a sequence of images @@ -16,9 +16,9 @@ public ImagickImagick::flattenImages - + Merges a sequence of images. This is useful for combining Photoshop layers into a single image. - + @@ -28,16 +28,16 @@ &reftitle.returnvalues; - + &imagick.return.success; - + &reftitle.errors; - + &imagick.imagick.throws; - + diff --git a/reference/imagick/imagick/flipimage.xml b/reference/imagick/imagick/flipimage.xml index eb2647459..ded041c56 100644 --- a/reference/imagick/imagick/flipimage.xml +++ b/reference/imagick/imagick/flipimage.xml @@ -1,6 +1,6 @@ - + Imagick::flipImage Creates a vertical mirror image @@ -12,9 +12,9 @@ public boolImagick::flipImage - + Creates a vertical mirror image by reflecting the pixels around the central x-axis. - + @@ -24,16 +24,16 @@ &reftitle.returnvalues; - + &imagick.return.success; - + &reftitle.errors; - + &imagick.imagick.throws; - + diff --git a/reference/imagick/imagick/floodfillpaintimage.xml b/reference/imagick/imagick/floodfillpaintimage.xml index 4c103909b..7253326b9 100644 --- a/reference/imagick/imagick/floodfillpaintimage.xml +++ b/reference/imagick/imagick/floodfillpaintimage.xml @@ -1,6 +1,6 @@ - + Imagick::floodFillPaintImage Changes the color value of any pixel that matches target @@ -19,12 +19,12 @@ intchannelImagick::CHANNEL_DEFAULT - + Changes the color value of any pixel that matches target and is an - immediate neighbor. This method is a replacement for deprecated + immediate neighbor. This method is a replacement for deprecated Imagick::paintFloodFillImage. &imagick.method.available.0x638; - + @@ -34,57 +34,57 @@ fill - + ImagickPixel object or a string containing the fill color - + fuzz - + &imagick.parameter.fuzz; - + target - + ImagickPixel object or a string containing the target color to paint - + x - + X start position of the floodfill - + y - + Y start position of the floodfill - + invert - + If &true; paints any pixel that does not match the target color. - + channel - + &imagick.parameter.channel; - + @@ -93,9 +93,9 @@ &reftitle.returnvalues; - + &imagick.return.success; - + @@ -129,7 +129,7 @@ $y = 1; /* Get the color we are painting */ $target = $combined->getImagePixelColor($x, $y); -/* Paints pixel in position 1,1 black and all neighboring +/* Paints pixel in position 1,1 black and all neighboring pixels that match the target color */ $combined->floodfillPaintImage("black", 1, $target, $x, $y, false); diff --git a/reference/imagick/imagick/flopimage.xml b/reference/imagick/imagick/flopimage.xml index 708bdc923..623892c7e 100644 --- a/reference/imagick/imagick/flopimage.xml +++ b/reference/imagick/imagick/flopimage.xml @@ -1,6 +1,6 @@ - + Imagick::flopImage Creates a horizontal mirror image @@ -12,9 +12,9 @@ public boolImagick::flopImage - + Creates a horizontal mirror image by reflecting the pixels around the central y-axis. - + @@ -24,16 +24,16 @@ &reftitle.returnvalues; - + &imagick.return.success; - + &reftitle.errors; - + &imagick.imagick.throws; - + diff --git a/reference/imagick/imagick/forwardfouriertransformimage.xml b/reference/imagick/imagick/forwardfouriertransformimage.xml index 5523a36a5..b2891a2bb 100644 --- a/reference/imagick/imagick/forwardfouriertransformimage.xml +++ b/reference/imagick/imagick/forwardfouriertransformimage.xml @@ -13,9 +13,9 @@ public boolImagick::forwardFourierTransformimage boolmagnitude - + Implements the discrete Fourier transform (DFT) of the image either as a magnitude / phase or real / imaginary image pair. - + @@ -25,9 +25,9 @@ magnitude - + If true, return as magnitude / phase pair otherwise a real / imaginary image pair. - + @@ -35,9 +35,9 @@ &reftitle.returnvalues; - + &imagick.return.success; - + diff --git a/reference/imagick/imagick/frameimage.xml b/reference/imagick/imagick/frameimage.xml index 72909d03a..4790626e6 100644 --- a/reference/imagick/imagick/frameimage.xml +++ b/reference/imagick/imagick/frameimage.xml @@ -1,6 +1,6 @@ - + Imagick::frameImage Adds a simulated three-dimensional border @@ -16,13 +16,13 @@ intinner_bevel intouter_bevel - + Adds a simulated three-dimensional border around the image. The width and height specify the border width of the vertical and horizontal sides of the frame. The inner and outer bevels indicate the width of the inner and outer shadows of the frame. - + @@ -32,41 +32,41 @@ matte_color - + ImagickPixel object or a string representing the matte color - + width - + The width of the border - + height - + The height of the border - + inner_bevel - + The inner bevel width - + outer_bevel - + The outer bevel width - + @@ -75,16 +75,16 @@ &reftitle.returnvalues; - + &imagick.return.success; - + &reftitle.errors; - + &imagick.imagick.throws; - + diff --git a/reference/imagick/imagick/functionimage.xml b/reference/imagick/imagick/functionimage.xml index 625c8e280..9029fd4e1 100644 --- a/reference/imagick/imagick/functionimage.xml +++ b/reference/imagick/imagick/functionimage.xml @@ -15,16 +15,16 @@ arrayarguments intchannelImagick::CHANNEL_DEFAULT - + Applies an arithmetic, relational, or logical expression to a pseudo image. - - + + See also ImageMagick v6 Examples - Image Transformations — Function, Multi-Argument Evaluate - - + + &imagick.method.available.0x649; - + @@ -34,17 +34,17 @@ function - + Refer to this list of function constants - + arguments - + Array of arguments to pass to this function. - + @@ -53,16 +53,16 @@ &reftitle.returnvalues; - + &imagick.return.success; - + &reftitle.errors; - + &imagick.imagick.throws; - + @@ -92,7 +92,7 @@ echo $imagick->getImageBlob(); - + Create a gradient from the polynomial (4x^2 - 4x + 1) diff --git a/reference/imagick/imagick/fximage.xml b/reference/imagick/imagick/fximage.xml index 82f863f70..a5891c786 100644 --- a/reference/imagick/imagick/fximage.xml +++ b/reference/imagick/imagick/fximage.xml @@ -1,6 +1,6 @@ - + Imagick::fxImage Evaluate expression for each pixel in the image @@ -13,11 +13,11 @@ stringexpression intchannelImagick::CHANNEL_DEFAULT - + Evaluate expression for each pixel in the image. Consult The Fx Special Effects Image Operator for more information. - + @@ -27,20 +27,20 @@ expression - + The expression. - + channel - + Provide any channel constant that is valid for your channel mode. To apply to more than one channel, combine channeltype constants using bitwise operators. Refer to this list of channel constants. - + @@ -49,16 +49,16 @@ &reftitle.returnvalues; - + &imagick.return.success; - + &reftitle.errors; - + &imagick.imagick.throws; - + diff --git a/reference/imagick/imagick/gammaimage.xml b/reference/imagick/imagick/gammaimage.xml index d23283635..9c2d828ef 100644 --- a/reference/imagick/imagick/gammaimage.xml +++ b/reference/imagick/imagick/gammaimage.xml @@ -1,6 +1,6 @@ - + Imagick::gammaImage Gamma-corrects an image @@ -13,13 +13,13 @@ floatgamma intchannelImagick::CHANNEL_DEFAULT - + Gamma-corrects an image. The same image viewed on different devices will have perceptual differences in the way the image's intensities are represented on the screen. Specify individual gamma levels for the red, green, and blue channels, or adjust all three with the gamma parameter. Values typically range from 0.8 to 2.3. - + @@ -29,20 +29,20 @@ gamma - + The amount of gamma-correction. - + channel - + Provide any channel constant that is valid for your channel mode. To apply to more than one channel, combine channeltype constants using bitwise operators. Refer to this list of channel constants. - + @@ -51,16 +51,16 @@ &reftitle.returnvalues; - + &imagick.return.success; - + &reftitle.errors; - + &imagick.imagick.throws; - + diff --git a/reference/imagick/imagick/gaussianblurimage.xml b/reference/imagick/imagick/gaussianblurimage.xml index 419b5125e..99659cb73 100644 --- a/reference/imagick/imagick/gaussianblurimage.xml +++ b/reference/imagick/imagick/gaussianblurimage.xml @@ -1,6 +1,6 @@ - + Imagick::gaussianBlurImage Blurs an image @@ -14,12 +14,12 @@ floatsigma intchannelImagick::CHANNEL_DEFAULT - + Blurs an image. We convolve the image with a Gaussian operator of the given radius and standard deviation (sigma). For reasonable results, the radius should be larger than sigma. Use a radius of 0 and selects a suitable radius for you. - + @@ -29,28 +29,28 @@ radius - + The radius of the Gaussian, in pixels, not counting the center pixel. - + sigma - + The standard deviation of the Gaussian, in pixels. - + channel - + Provide any channel constant that is valid for your channel mode. To apply to more than one channel, combine channeltype constants using bitwise operators. Refer to this list of channel constants. - + @@ -59,16 +59,16 @@ &reftitle.returnvalues; - + &imagick.return.success; - + &reftitle.errors; - + &imagick.imagick.throws; - + diff --git a/reference/imagick/imagick/getcolorspace.xml b/reference/imagick/imagick/getcolorspace.xml index 6ae2e5963..f421a1471 100644 --- a/reference/imagick/imagick/getcolorspace.xml +++ b/reference/imagick/imagick/getcolorspace.xml @@ -1,6 +1,6 @@ - + Imagick::getColorspace Gets the colorspace @@ -12,10 +12,10 @@ public intImagick::getColorspace - + Gets the global colorspace value. &imagick.method.available.0x657; - + @@ -25,9 +25,9 @@ &reftitle.returnvalues; - + Returns an integer which can be compared against COLORSPACE constants. - + diff --git a/reference/imagick/imagick/getcompression.xml b/reference/imagick/imagick/getcompression.xml index a87396f33..576e6e9a0 100644 --- a/reference/imagick/imagick/getcompression.xml +++ b/reference/imagick/imagick/getcompression.xml @@ -1,6 +1,6 @@ - + Imagick::getCompression Gets the object compression type @@ -13,9 +13,9 @@ - + Gets the object compression type. - + @@ -25,9 +25,9 @@ &reftitle.returnvalues; - + Returns the compression constant - + diff --git a/reference/imagick/imagick/getcompressionquality.xml b/reference/imagick/imagick/getcompressionquality.xml index 4d6fc24e6..756c8b79c 100644 --- a/reference/imagick/imagick/getcompressionquality.xml +++ b/reference/imagick/imagick/getcompressionquality.xml @@ -1,6 +1,6 @@ - + Imagick::getCompressionQuality Gets the object compression quality @@ -13,9 +13,9 @@ - + Gets the object compression quality. - + @@ -25,9 +25,9 @@ &reftitle.returnvalues; - + Returns integer describing the compression quality - + diff --git a/reference/imagick/imagick/getcopyright.xml b/reference/imagick/imagick/getcopyright.xml index d7d00bf3d..9e1e61d1d 100644 --- a/reference/imagick/imagick/getcopyright.xml +++ b/reference/imagick/imagick/getcopyright.xml @@ -1,6 +1,6 @@ - + Imagick::getCopyright Returns the ImageMagick API copyright as a string @@ -12,9 +12,9 @@ public static stringImagick::getCopyright - + Returns the ImageMagick API copyright as a string. - + @@ -24,10 +24,10 @@ &reftitle.returnvalues; - + Returns a string containing the copyright notice of Imagemagick and Magickwand C API. - + diff --git a/reference/imagick/imagick/getfilename.xml b/reference/imagick/imagick/getfilename.xml index 9035ac888..c5593d1f9 100644 --- a/reference/imagick/imagick/getfilename.xml +++ b/reference/imagick/imagick/getfilename.xml @@ -1,6 +1,6 @@ - + Imagick::getFilename The filename associated with an image sequence @@ -12,9 +12,9 @@ public stringImagick::getFilename - + Returns the filename associated with an image sequence. - + @@ -24,16 +24,16 @@ &reftitle.returnvalues; - + Returns a string on success. - + &reftitle.errors; - + &imagick.imagick.throws; - + diff --git a/reference/imagick/imagick/getfont.xml b/reference/imagick/imagick/getfont.xml index 407cccd8b..2691ef198 100644 --- a/reference/imagick/imagick/getfont.xml +++ b/reference/imagick/imagick/getfont.xml @@ -1,6 +1,6 @@ - + Imagick::getFont Gets font @@ -12,10 +12,10 @@ public stringImagick::getFont - + Returns the objects font property. &imagick.method.available.0x637; - + @@ -25,9 +25,9 @@ &reftitle.returnvalues; - + Returns the string containing the font name or &false; if not font is set. - + diff --git a/reference/imagick/imagick/getformat.xml b/reference/imagick/imagick/getformat.xml index 7dc877cf5..c3a32e760 100644 --- a/reference/imagick/imagick/getformat.xml +++ b/reference/imagick/imagick/getformat.xml @@ -1,6 +1,6 @@ - + Imagick::getFormat Returns the format of the Imagick object @@ -12,9 +12,9 @@ public stringImagick::getFormat - + Returns the format of the Imagick object. - + @@ -24,16 +24,16 @@ &reftitle.returnvalues; - + Returns the format of the image. - + &reftitle.errors; - + &imagick.imagick.throws; - + diff --git a/reference/imagick/imagick/getgravity.xml b/reference/imagick/imagick/getgravity.xml index a4d6709de..6ed2c4b11 100644 --- a/reference/imagick/imagick/getgravity.xml +++ b/reference/imagick/imagick/getgravity.xml @@ -1,6 +1,6 @@ - + Imagick::getGravity Gets the gravity @@ -13,10 +13,10 @@ - + Gets the global gravity property for the Imagick object. &imagick.method.available.0x640; - + @@ -26,10 +26,10 @@ &reftitle.returnvalues; - - Returns the gravity property. Refer to the list of + + Returns the gravity property. Refer to the list of gravity constants. - + diff --git a/reference/imagick/imagick/gethomeurl.xml b/reference/imagick/imagick/gethomeurl.xml index e73225df6..7a5202799 100644 --- a/reference/imagick/imagick/gethomeurl.xml +++ b/reference/imagick/imagick/gethomeurl.xml @@ -1,6 +1,6 @@ - + Imagick::getHomeURL Returns the ImageMagick home URL @@ -12,9 +12,9 @@ public static stringImagick::getHomeURL - + Returns the ImageMagick home URL. - + @@ -24,9 +24,9 @@ &reftitle.returnvalues; - + Returns a link to the imagemagick homepage. - + diff --git a/reference/imagick/imagick/getimage.xml b/reference/imagick/imagick/getimage.xml index 5d56989dc..8b43ed8fc 100644 --- a/reference/imagick/imagick/getimage.xml +++ b/reference/imagick/imagick/getimage.xml @@ -1,6 +1,6 @@ - + Imagick::getImage Returns a new Imagick object @@ -12,9 +12,9 @@ public ImagickImagick::getImage - + Returns a new Imagick object with the current image sequence. - + @@ -24,16 +24,16 @@ &reftitle.returnvalues; - + Returns a new Imagick object with the current image sequence. - + &reftitle.errors; - + &imagick.imagick.throws; - + diff --git a/reference/imagick/imagick/getimagealphachannel.xml b/reference/imagick/imagick/getimagealphachannel.xml index c61718eea..d92655e15 100644 --- a/reference/imagick/imagick/getimagealphachannel.xml +++ b/reference/imagick/imagick/getimagealphachannel.xml @@ -1,6 +1,6 @@ - + Imagick::getImageAlphaChannel Checks if the image has an alpha channel @@ -13,9 +13,9 @@ - + Returns whether the image has an alpha channel. - + @@ -25,18 +25,18 @@ &reftitle.returnvalues; - + Returns &true; if the image has an alpha channel value and &false; if not, i.e. the image is RGB rather than RGBA or CMYK rather than CMYKA. - + &reftitle.errors; - + &imagick.imagick.throws; - + diff --git a/reference/imagick/imagick/getimageartifact.xml b/reference/imagick/imagick/getimageartifact.xml index 1aff02bb8..d1f3dc979 100644 --- a/reference/imagick/imagick/getimageartifact.xml +++ b/reference/imagick/imagick/getimageartifact.xml @@ -1,6 +1,6 @@ - + Imagick::getImageArtifact Get image artifact @@ -12,11 +12,11 @@ public stringImagick::getImageArtifact stringartifact - - Gets an artifact associated with the image. The difference between image properties and + + Gets an artifact associated with the image. The difference between image properties and image artifacts is that properties are public and artifacts are private. &imagick.method.available.0x657; - + @@ -26,9 +26,9 @@ artifact - + The name of the artifact - + @@ -37,16 +37,16 @@ &reftitle.returnvalues; - + Returns the artifact value on success. - + &reftitle.errors; - + &imagick.imagick.throws; - + diff --git a/reference/imagick/imagick/getimageattribute.xml b/reference/imagick/imagick/getimageattribute.xml index 5095ea9db..c852a69f2 100644 --- a/reference/imagick/imagick/getimageattribute.xml +++ b/reference/imagick/imagick/getimageattribute.xml @@ -17,9 +17,9 @@ public stringImagick::getImageAttribute stringkey - + Returns a named attribute. - + @@ -30,9 +30,9 @@ key - + The key of the attribute to get. - + @@ -40,9 +40,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/imagick/imagick/getimagebackgroundcolor.xml b/reference/imagick/imagick/getimagebackgroundcolor.xml index 2be924ff3..07ba6ac7f 100644 --- a/reference/imagick/imagick/getimagebackgroundcolor.xml +++ b/reference/imagick/imagick/getimagebackgroundcolor.xml @@ -1,6 +1,6 @@ - + Imagick::getImageBackgroundColor Returns the image background color @@ -12,9 +12,9 @@ public ImagickPixelImagick::getImageBackgroundColor - + Returns the image background color. - + @@ -24,16 +24,16 @@ &reftitle.returnvalues; - + Returns an ImagickPixel set to the background color of the image. - + &reftitle.errors; - + &imagick.imagick.throws; - + diff --git a/reference/imagick/imagick/getimageblob.xml b/reference/imagick/imagick/getimageblob.xml index 9cdc770c3..16d5c5146 100644 --- a/reference/imagick/imagick/getimageblob.xml +++ b/reference/imagick/imagick/getimageblob.xml @@ -1,6 +1,6 @@ - + Imagick::getImageBlob Returns the image sequence as a blob @@ -12,12 +12,12 @@ public stringImagick::getImageBlob - + Implements direct to memory image formats. It returns the image sequence as a string. The format of the image determines the format of the returned blob (GIF, JPEG, PNG, etc.). To return a different image format, use Imagick::setImageFormat(). - + @@ -27,16 +27,16 @@ &reftitle.returnvalues; - + Returns a string containing the image. - + &reftitle.errors; - + &imagick.imagick.throws; - + diff --git a/reference/imagick/imagick/getimageblueprimary.xml b/reference/imagick/imagick/getimageblueprimary.xml index 271f6d0ef..16e8138f7 100644 --- a/reference/imagick/imagick/getimageblueprimary.xml +++ b/reference/imagick/imagick/getimageblueprimary.xml @@ -1,6 +1,6 @@ - + Imagick::getImageBluePrimary Returns the chromaticy blue primary point @@ -12,9 +12,9 @@ public arrayImagick::getImageBluePrimary - + Returns the chromaticity blue primary point for the image. - + @@ -24,17 +24,17 @@ x - + The chromaticity blue primary x-point. - + y - + The chromaticity blue primary y-point. - + @@ -43,16 +43,16 @@ &reftitle.returnvalues; - + Array consisting of "x" and "y" coordinates of point. - + &reftitle.errors; - + &imagick.imagick.throws; - + diff --git a/reference/imagick/imagick/getimagebordercolor.xml b/reference/imagick/imagick/getimagebordercolor.xml index ad2150f4a..3846c91f5 100644 --- a/reference/imagick/imagick/getimagebordercolor.xml +++ b/reference/imagick/imagick/getimagebordercolor.xml @@ -1,6 +1,6 @@ - + Imagick::getImageBorderColor Returns the image border color @@ -12,9 +12,9 @@ public ImagickPixelImagick::getImageBorderColor - + Returns the image border color. - + @@ -24,16 +24,16 @@ &reftitle.returnvalues; - + &imagick.return.success; - + &reftitle.errors; - + &imagick.imagick.throws; - + diff --git a/reference/imagick/imagick/getimagechanneldepth.xml b/reference/imagick/imagick/getimagechanneldepth.xml index 282bbccdd..c81047f8d 100644 --- a/reference/imagick/imagick/getimagechanneldepth.xml +++ b/reference/imagick/imagick/getimagechanneldepth.xml @@ -1,6 +1,6 @@ - + Imagick::getImageChannelDepth Gets the depth for a particular image channel @@ -13,9 +13,9 @@ intchannel - + Gets the depth for a particular image channel. - + @@ -25,9 +25,9 @@ channel - + &imagick.parameter.channel; - + @@ -36,9 +36,9 @@ &reftitle.returnvalues; - + &imagick.return.success; - + diff --git a/reference/imagick/imagick/getimagechanneldistortion.xml b/reference/imagick/imagick/getimagechanneldistortion.xml index f531292e2..5b46c5605 100644 --- a/reference/imagick/imagick/getimagechanneldistortion.xml +++ b/reference/imagick/imagick/getimagechanneldistortion.xml @@ -1,6 +1,6 @@ - + Imagick::getImageChannelDistortion Compares image channels of an image to a reconstructed image @@ -14,10 +14,10 @@ intchannel intmetric - + Compares one or more image channels of an image to a reconstructed image and returns the specified distortion metric. - + @@ -27,28 +27,28 @@ reference - + Imagick object to compare to. - + channel - + Provide any channel constant that is valid for your channel mode. To apply to more than one channel, combine channeltype constants using bitwise operators. Refer to this list of channel constants. - + metric - + One of the metric type constants. - + @@ -57,16 +57,16 @@ &reftitle.returnvalues; - + &imagick.return.success; - + &reftitle.errors; - + &imagick.imagick.throws; - + diff --git a/reference/imagick/imagick/getimagechanneldistortions.xml b/reference/imagick/imagick/getimagechanneldistortions.xml index f31b52125..54401a0a7 100644 --- a/reference/imagick/imagick/getimagechanneldistortions.xml +++ b/reference/imagick/imagick/getimagechanneldistortions.xml @@ -1,6 +1,6 @@ - + Imagick::getImageChannelDistortions Gets channel distortions @@ -15,10 +15,10 @@ intchannelImagick::CHANNEL_DEFAULT - + Compares one or more image channels of an image to a reconstructed image and returns the specified distortion metrics &imagick.method.available.0x644; - + @@ -28,25 +28,25 @@ reference - + Imagick object containing the reference image - + metric - + Refer to this list of metric type constants. - + channel - + &imagick.parameter.channel; - + @@ -55,16 +55,16 @@ &reftitle.returnvalues; - + Returns a float describing the channel distortion. - + &reftitle.errors; - + &imagick.imagick.throws; - + diff --git a/reference/imagick/imagick/getimagechannelextrema.xml b/reference/imagick/imagick/getimagechannelextrema.xml index 6a7314520..de83492b7 100644 --- a/reference/imagick/imagick/getimagechannelextrema.xml +++ b/reference/imagick/imagick/getimagechannelextrema.xml @@ -1,6 +1,6 @@ - + Imagick::getImageChannelExtrema Gets the extrema for one or more image channels @@ -16,10 +16,10 @@ public arrayImagick::getImageChannelExtrema intchannel - + Gets the extrema for one or more image channels. Return value is an associative array with the keys "minima" and "maxima". - + @@ -29,12 +29,12 @@ channel - + Provide any channel constant that is valid for your channel mode. To apply to more than one channel, combine channeltype constants using bitwise operators. Refer to this list of channel constants. - + @@ -43,16 +43,16 @@ &reftitle.returnvalues; - + &imagick.return.success; - + &reftitle.errors; - + &imagick.imagick.throws; - + diff --git a/reference/imagick/imagick/getimagechannelkurtosis.xml b/reference/imagick/imagick/getimagechannelkurtosis.xml index dc440f310..a166a550f 100644 --- a/reference/imagick/imagick/getimagechannelkurtosis.xml +++ b/reference/imagick/imagick/getimagechannelkurtosis.xml @@ -13,9 +13,9 @@ public arrayImagick::getImageChannelKurtosis intchannelImagick::CHANNEL_DEFAULT - + Get the kurtosis and skewness of a specific channel. &imagick.method.available.0x649; - + @@ -25,9 +25,9 @@ channel - + &imagick.parameter.channel; - + @@ -36,17 +36,17 @@ &reftitle.returnvalues; - + Returns an array with kurtosis and skewness members. - + &reftitle.errors; - + &imagick.imagick.throws; - + diff --git a/reference/imagick/imagick/getimagechannelmean.xml b/reference/imagick/imagick/getimagechannelmean.xml index 23d5e7333..781db7a4e 100644 --- a/reference/imagick/imagick/getimagechannelmean.xml +++ b/reference/imagick/imagick/getimagechannelmean.xml @@ -1,6 +1,6 @@ - + Imagick::getImageChannelMean Gets the mean and standard deviation @@ -12,9 +12,9 @@ public arrayImagick::getImageChannelMean intchannel - + Gets the mean and standard deviation of one or more image channels. - + @@ -24,12 +24,12 @@ channel - + Provide any channel constant that is valid for your channel mode. To apply to more than one channel, combine channeltype constants using bitwise operators. Refer to this list of channel constants. - + @@ -38,17 +38,17 @@ &reftitle.returnvalues; - + Returns an array with "mean" and "standardDeviation" members. - + &reftitle.errors; - + &imagick.imagick.throws; - + diff --git a/reference/imagick/imagick/getimagechannelrange.xml b/reference/imagick/imagick/getimagechannelrange.xml index 32622523a..ce9115dd9 100644 --- a/reference/imagick/imagick/getimagechannelrange.xml +++ b/reference/imagick/imagick/getimagechannelrange.xml @@ -1,6 +1,6 @@ - + Imagick::getImageChannelRange Gets channel range @@ -13,10 +13,10 @@ intchannel - + Gets the range for one or more image channels. &imagick.method.available.0x640; - + @@ -26,9 +26,9 @@ channel - + &imagick.parameter.channel; - + @@ -37,16 +37,16 @@ &reftitle.returnvalues; - + Returns an array containing minima and maxima values of the channel(s). - + &reftitle.errors; - + &imagick.imagick.throws; - + diff --git a/reference/imagick/imagick/getimagechannelstatistics.xml b/reference/imagick/imagick/getimagechannelstatistics.xml index cf4dbdd7b..710b93ff7 100644 --- a/reference/imagick/imagick/getimagechannelstatistics.xml +++ b/reference/imagick/imagick/getimagechannelstatistics.xml @@ -1,6 +1,6 @@ - + Imagick::getImageChannelStatistics Returns statistics for each channel in the image @@ -12,11 +12,11 @@ public arrayImagick::getImageChannelStatistics - + Returns statistics for each channel in the image. The statistics include the channel depth, its minima and maxima, the mean, and the standard deviation. - + @@ -26,9 +26,9 @@ &reftitle.returnvalues; - + &imagick.return.success; - + diff --git a/reference/imagick/imagick/getimageclipmask.xml b/reference/imagick/imagick/getimageclipmask.xml index 3b8119f78..cda2e0a99 100644 --- a/reference/imagick/imagick/getimageclipmask.xml +++ b/reference/imagick/imagick/getimageclipmask.xml @@ -1,6 +1,6 @@ - + Imagick::getImageClipMask Gets image clip mask @@ -17,10 +17,10 @@ - + Returns the image clip mask. The clip mask is an Imagick object containing the clip mask. &imagick.method.available.0x636; - + @@ -30,16 +30,16 @@ &reftitle.returnvalues; - + Returns an Imagick object containing the clip mask. - + &reftitle.errors; - + &imagick.imagick.throws; - + diff --git a/reference/imagick/imagick/getimagecolormapcolor.xml b/reference/imagick/imagick/getimagecolormapcolor.xml index be239b42a..87872eaf8 100644 --- a/reference/imagick/imagick/getimagecolormapcolor.xml +++ b/reference/imagick/imagick/getimagecolormapcolor.xml @@ -1,6 +1,6 @@ - + Imagick::getImageColormapColor Returns the color of the specified colormap index @@ -12,9 +12,9 @@ public ImagickPixelImagick::getImageColormapColor intindex - + Returns the color of the specified colormap index. - + @@ -24,9 +24,9 @@ index - + The offset into the image colormap. - + @@ -35,16 +35,16 @@ &reftitle.returnvalues; - + &imagick.return.success; - + &reftitle.errors; - + &imagick.imagick.throws; - + diff --git a/reference/imagick/imagick/getimagecolors.xml b/reference/imagick/imagick/getimagecolors.xml index 9c428bc15..85307db5d 100644 --- a/reference/imagick/imagick/getimagecolors.xml +++ b/reference/imagick/imagick/getimagecolors.xml @@ -1,6 +1,6 @@ - + Imagick::getImageColors Gets the number of unique colors in the image @@ -12,9 +12,9 @@ public intImagick::getImageColors - + Gets the number of unique colors in the image. - + @@ -24,9 +24,9 @@ &reftitle.returnvalues; - + Returns an int, the number of unique colors in the image. - + diff --git a/reference/imagick/imagick/getimagecolorspace.xml b/reference/imagick/imagick/getimagecolorspace.xml index 830906fea..eed1a9746 100644 --- a/reference/imagick/imagick/getimagecolorspace.xml +++ b/reference/imagick/imagick/getimagecolorspace.xml @@ -1,6 +1,6 @@ - + Imagick::getImageColorspace Gets the image colorspace @@ -12,9 +12,9 @@ public intImagick::getImageColorspace - + Gets the image colorspace. - + @@ -24,9 +24,9 @@ &reftitle.returnvalues; - + Returns an integer which can be compared against COLORSPACE constants. - + diff --git a/reference/imagick/imagick/getimagecompose.xml b/reference/imagick/imagick/getimagecompose.xml index 7de0538f0..b4108d11c 100644 --- a/reference/imagick/imagick/getimagecompose.xml +++ b/reference/imagick/imagick/getimagecompose.xml @@ -1,6 +1,6 @@ - + Imagick::getImageCompose Returns the composite operator associated with the image @@ -12,9 +12,9 @@ public intImagick::getImageCompose - + Returns the composite operator associated with the image. - + @@ -24,9 +24,9 @@ &reftitle.returnvalues; - + &imagick.return.success; - + diff --git a/reference/imagick/imagick/getimagecompression.xml b/reference/imagick/imagick/getimagecompression.xml index 1bc6e5a65..04a8cfcdf 100644 --- a/reference/imagick/imagick/getimagecompression.xml +++ b/reference/imagick/imagick/getimagecompression.xml @@ -1,6 +1,6 @@ - + Imagick::getImageCompression Gets the current image's compression type @@ -13,9 +13,9 @@ - + Gets the current image's compression type. - + @@ -25,9 +25,9 @@ &reftitle.returnvalues; - + Returns the compression constant - + diff --git a/reference/imagick/imagick/getimagecompressionquality.xml b/reference/imagick/imagick/getimagecompressionquality.xml index 6c887b843..bd746e75a 100644 --- a/reference/imagick/imagick/getimagecompressionquality.xml +++ b/reference/imagick/imagick/getimagecompressionquality.xml @@ -1,6 +1,6 @@ - + Imagick::getImageCompressionQuality Gets the current image's compression quality @@ -13,9 +13,9 @@ - + Gets the current image's compression quality - + @@ -25,9 +25,9 @@ &reftitle.returnvalues; - + Returns integer describing the images compression quality - + diff --git a/reference/imagick/imagick/getimagedelay.xml b/reference/imagick/imagick/getimagedelay.xml index c9644d94a..0a96b733f 100644 --- a/reference/imagick/imagick/getimagedelay.xml +++ b/reference/imagick/imagick/getimagedelay.xml @@ -1,6 +1,6 @@ - + Imagick::getImageDelay Gets the image delay @@ -12,9 +12,9 @@ public intImagick::getImageDelay - + Gets the image delay. - + @@ -24,16 +24,16 @@ &reftitle.returnvalues; - + Returns the image delay. - + &reftitle.errors; - + &imagick.imagick.throws; - + diff --git a/reference/imagick/imagick/getimagedepth.xml b/reference/imagick/imagick/getimagedepth.xml index d7cd2ed0e..a53392081 100644 --- a/reference/imagick/imagick/getimagedepth.xml +++ b/reference/imagick/imagick/getimagedepth.xml @@ -1,6 +1,6 @@ - + Imagick::getImageDepth Gets the image depth @@ -12,9 +12,9 @@ public intImagick::getImageDepth - + Gets the image depth. - + @@ -24,9 +24,9 @@ &reftitle.returnvalues; - + The image depth. - + diff --git a/reference/imagick/imagick/getimagedispose.xml b/reference/imagick/imagick/getimagedispose.xml index 3da2a2d6a..660cb6849 100644 --- a/reference/imagick/imagick/getimagedispose.xml +++ b/reference/imagick/imagick/getimagedispose.xml @@ -1,6 +1,6 @@ - + Imagick::getImageDispose Gets the image disposal method @@ -12,9 +12,9 @@ public intImagick::getImageDispose - + Gets the image disposal method. - + @@ -24,16 +24,16 @@ &reftitle.returnvalues; - + Returns the dispose method on success. - + &reftitle.errors; - + &imagick.imagick.throws; - + diff --git a/reference/imagick/imagick/getimagedistortion.xml b/reference/imagick/imagick/getimagedistortion.xml index eb3b207a7..332b3af3a 100644 --- a/reference/imagick/imagick/getimagedistortion.xml +++ b/reference/imagick/imagick/getimagedistortion.xml @@ -1,6 +1,6 @@ - + Imagick::getImageDistortion Compares an image to a reconstructed image @@ -13,10 +13,10 @@ MagickWandreference intmetric - + Compares an image to a reconstructed image and returns the specified distortion metric. - + @@ -26,17 +26,17 @@ reference - + Imagick object to compare to. - + metric - + One of the metric type constants. - + @@ -45,17 +45,17 @@ &reftitle.returnvalues; - + Returns the distortion metric used on the image (or the best guess thereof). - + &reftitle.errors; - + &imagick.imagick.throws; - + diff --git a/reference/imagick/imagick/getimageextrema.xml b/reference/imagick/imagick/getimageextrema.xml index 6f0457178..efef9a27c 100644 --- a/reference/imagick/imagick/getimageextrema.xml +++ b/reference/imagick/imagick/getimageextrema.xml @@ -1,6 +1,6 @@ - + Imagick::getImageExtrema Gets the extrema for the image @@ -16,9 +16,9 @@ public arrayImagick::getImageExtrema - + Gets the extrema for the image. Returns an associative array with the keys "min" and "max". - + @@ -28,16 +28,16 @@ &reftitle.returnvalues; - + Returns an associative array with the keys "min" and "max". - + &reftitle.errors; - + &imagick.imagick.throws; - + diff --git a/reference/imagick/imagick/getimagefilename.xml b/reference/imagick/imagick/getimagefilename.xml index 23c4461b7..ac29b6500 100644 --- a/reference/imagick/imagick/getimagefilename.xml +++ b/reference/imagick/imagick/getimagefilename.xml @@ -1,6 +1,6 @@ - + Imagick::getImageFilename Returns the filename of a particular image in a sequence @@ -12,9 +12,9 @@ public stringImagick::getImageFilename - + Returns the filename of a particular image in a sequence. - + @@ -24,16 +24,16 @@ &reftitle.returnvalues; - + Returns a string with the filename of the image. - + &reftitle.errors; - + &imagick.imagick.throws; - + diff --git a/reference/imagick/imagick/getimageformat.xml b/reference/imagick/imagick/getimageformat.xml index 6fb7bf1f5..082648a9f 100644 --- a/reference/imagick/imagick/getimageformat.xml +++ b/reference/imagick/imagick/getimageformat.xml @@ -1,6 +1,6 @@ - + Imagick::getImageFormat Returns the format of a particular image in a sequence @@ -12,9 +12,9 @@ public stringImagick::getImageFormat - + Returns the format of a particular image in a sequence. - + @@ -24,16 +24,16 @@ &reftitle.returnvalues; - + Returns a string containing the image format on success. - + &reftitle.errors; - + &imagick.imagick.throws; - + diff --git a/reference/imagick/imagick/getimagegamma.xml b/reference/imagick/imagick/getimagegamma.xml index 1e877c8ba..c7b157d19 100644 --- a/reference/imagick/imagick/getimagegamma.xml +++ b/reference/imagick/imagick/getimagegamma.xml @@ -1,6 +1,6 @@ - + Imagick::getImageGamma Gets the image gamma @@ -12,9 +12,9 @@ public floatImagick::getImageGamma - + Gets the image gamma. - + @@ -24,16 +24,16 @@ &reftitle.returnvalues; - + Returns the image gamma on success. - + &reftitle.errors; - + &imagick.imagick.throws; - + diff --git a/reference/imagick/imagick/getimagegeometry.xml b/reference/imagick/imagick/getimagegeometry.xml index 0e65740b6..71dc0c048 100644 --- a/reference/imagick/imagick/getimagegeometry.xml +++ b/reference/imagick/imagick/getimagegeometry.xml @@ -1,6 +1,6 @@ - + Imagick::getImageGeometry Gets the width and height as an associative array @@ -12,9 +12,9 @@ public arrayImagick::getImageGeometry - + Returns the width and height as an associative array. - + @@ -24,16 +24,16 @@ &reftitle.returnvalues; - + Returns an array with the width/height of the image. - + &reftitle.errors; - + &imagick.imagick.throws; - + diff --git a/reference/imagick/imagick/getimagegravity.xml b/reference/imagick/imagick/getimagegravity.xml index f39636ebd..52c8e7ba4 100644 --- a/reference/imagick/imagick/getimagegravity.xml +++ b/reference/imagick/imagick/getimagegravity.xml @@ -1,6 +1,6 @@ - + Imagick::getImageGravity Gets the image gravity @@ -13,12 +13,12 @@ - + Gets the current gravity value of the image. Unlike Imagick::getGravity, this method returns the gravity defined for the current image sequence. &imagick.method.available.0x644; - + @@ -28,10 +28,10 @@ &reftitle.returnvalues; - - Returns the images gravity property. Refer to the list of + + Returns the images gravity property. Refer to the list of gravity constants. - + diff --git a/reference/imagick/imagick/getimagegreenprimary.xml b/reference/imagick/imagick/getimagegreenprimary.xml index 529147842..8938a6361 100644 --- a/reference/imagick/imagick/getimagegreenprimary.xml +++ b/reference/imagick/imagick/getimagegreenprimary.xml @@ -1,6 +1,6 @@ - + Imagick::getImageGreenPrimary Returns the chromaticy green primary point @@ -12,9 +12,9 @@ public arrayImagick::getImageGreenPrimary - + Returns the chromaticity green primary point. Returns an array with the keys "x" and "y". - + @@ -24,17 +24,17 @@ &reftitle.returnvalues; - + Returns an array with the keys "x" and "y" on success, throws an ImagickException on failure. - + &reftitle.errors; - + &imagick.imagick.throws; - + diff --git a/reference/imagick/imagick/getimageheight.xml b/reference/imagick/imagick/getimageheight.xml index 592e7a020..e8fca06ea 100644 --- a/reference/imagick/imagick/getimageheight.xml +++ b/reference/imagick/imagick/getimageheight.xml @@ -1,6 +1,6 @@ - + Imagick::getImageHeight Returns the image height @@ -12,9 +12,9 @@ public intImagick::getImageHeight - + Returns the image height. - + @@ -24,16 +24,16 @@ &reftitle.returnvalues; - + Returns the image height in pixels. - + &reftitle.errors; - + &imagick.imagick.throws; - + diff --git a/reference/imagick/imagick/getimagehistogram.xml b/reference/imagick/imagick/getimagehistogram.xml index 17e1e1757..b83377fa7 100644 --- a/reference/imagick/imagick/getimagehistogram.xml +++ b/reference/imagick/imagick/getimagehistogram.xml @@ -1,6 +1,6 @@ - + Imagick::getImageHistogram Gets the image histogram @@ -12,9 +12,9 @@ public arrayImagick::getImageHistogram - + Returns the image histogram as an array of ImagickPixel objects. - + @@ -24,16 +24,16 @@ &reftitle.returnvalues; - + Returns the image histogram as an array of ImagickPixel objects. - + &reftitle.errors; - + &imagick.imagick.throws; - + @@ -63,10 +63,10 @@ function getColorStatistics($histogramElements, $colorChannel) { } ksort($colorStatistics); - + return $colorStatistics; } - + function getImageHistogram($imagePath) { @@ -126,7 +126,7 @@ function getImageHistogram($imagePath) { } $histogram->drawImage($draw); - + header( "Content-Type: image/png" ); echo $histogram; } diff --git a/reference/imagick/imagick/getimageindex.xml b/reference/imagick/imagick/getimageindex.xml index a54450f67..cc6746b8a 100644 --- a/reference/imagick/imagick/getimageindex.xml +++ b/reference/imagick/imagick/getimageindex.xml @@ -1,6 +1,6 @@ - + Imagick::getImageIndex Gets the index of the current active image @@ -16,11 +16,11 @@ public intImagick::getImageIndex - + Returns the index of the current active image within the Imagick object. This method has been deprecated. See Imagick::getIteratorIndex. - + @@ -30,16 +30,16 @@ &reftitle.returnvalues; - + Returns an integer containing the index of the image in the stack. - + &reftitle.errors; - + &imagick.imagick.throws; - + diff --git a/reference/imagick/imagick/getimageinterlacescheme.xml b/reference/imagick/imagick/getimageinterlacescheme.xml index 608173aad..97f48a650 100644 --- a/reference/imagick/imagick/getimageinterlacescheme.xml +++ b/reference/imagick/imagick/getimageinterlacescheme.xml @@ -1,6 +1,6 @@ - + Imagick::getImageInterlaceScheme Gets the image interlace scheme @@ -12,9 +12,9 @@ public intImagick::getImageInterlaceScheme - + Gets the image interlace scheme. - + @@ -24,10 +24,10 @@ &reftitle.returnvalues; - + Returns the interlace scheme as an integer on success. - &imagick.imagickexception.throw; - + &imagick.imagickexception.throw; + diff --git a/reference/imagick/imagick/getimageinterpolatemethod.xml b/reference/imagick/imagick/getimageinterpolatemethod.xml index 491f47a74..622009085 100644 --- a/reference/imagick/imagick/getimageinterpolatemethod.xml +++ b/reference/imagick/imagick/getimageinterpolatemethod.xml @@ -1,6 +1,6 @@ - + Imagick::getImageInterpolateMethod Returns the interpolation method @@ -12,10 +12,10 @@ public intImagick::getImageInterpolateMethod - - Returns the interpolation method for the specified image. The method is one of + + Returns the interpolation method for the specified image. The method is one of the Imagick::INTERPOLATE_* constants. - + @@ -25,16 +25,16 @@ &reftitle.returnvalues; - + Returns the interpolate method on success. - + &reftitle.errors; - + &imagick.imagick.throws; - + diff --git a/reference/imagick/imagick/getimageiterations.xml b/reference/imagick/imagick/getimageiterations.xml index eb0265a45..e95c166d8 100644 --- a/reference/imagick/imagick/getimageiterations.xml +++ b/reference/imagick/imagick/getimageiterations.xml @@ -1,6 +1,6 @@ - + Imagick::getImageIterations Gets the image iterations @@ -12,9 +12,9 @@ public intImagick::getImageIterations - + Gets the image iterations. - + @@ -24,16 +24,16 @@ &reftitle.returnvalues; - + Returns the image iterations as an integer. - + &reftitle.errors; - + &imagick.imagick.throws; - + diff --git a/reference/imagick/imagick/getimagelength.xml b/reference/imagick/imagick/getimagelength.xml index 13474f100..bdc2e09b2 100644 --- a/reference/imagick/imagick/getimagelength.xml +++ b/reference/imagick/imagick/getimagelength.xml @@ -1,6 +1,6 @@ - + Imagick::getImageLength Returns the image length in bytes @@ -12,9 +12,9 @@ public intImagick::getImageLength - + Returns the image length in bytes - + @@ -24,9 +24,9 @@ &reftitle.returnvalues; - + Returns an int containing the current image size. - + @@ -34,9 +34,9 @@ Using <function>Imagick::getImageLength</function>: - + Getting image length in bytes - + - + Imagick::getImageMatte Return if the image has a matte channel @@ -17,10 +17,10 @@ - + Returns &true; if the image has a matte channel otherwise false. &imagick.method.available.0x629; - + @@ -30,9 +30,9 @@ &reftitle.returnvalues; - + &imagick.return.success; - + diff --git a/reference/imagick/imagick/getimagemattecolor.xml b/reference/imagick/imagick/getimagemattecolor.xml index 317790ab3..ad83efcec 100644 --- a/reference/imagick/imagick/getimagemattecolor.xml +++ b/reference/imagick/imagick/getimagemattecolor.xml @@ -1,6 +1,6 @@ - + Imagick::getImageMatteColor Returns the image matte color @@ -16,9 +16,9 @@ public ImagickPixelImagick::getImageMatteColor - + Returns the image matte color. - + @@ -28,16 +28,16 @@ &reftitle.returnvalues; - + Returns ImagickPixel object on success. - + &reftitle.errors; - + &imagick.imagick.throws; - + diff --git a/reference/imagick/imagick/getimagemimetype.xml b/reference/imagick/imagick/getimagemimetype.xml index a4b7e3c70..10a174874 100644 --- a/reference/imagick/imagick/getimagemimetype.xml +++ b/reference/imagick/imagick/getimagemimetype.xml @@ -13,9 +13,9 @@ public stringImagick::getImageMimeType - + Returns the image mime-type. - + @@ -26,9 +26,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/imagick/imagick/getimageorientation.xml b/reference/imagick/imagick/getimageorientation.xml index d1beff313..80d9be116 100644 --- a/reference/imagick/imagick/getimageorientation.xml +++ b/reference/imagick/imagick/getimageorientation.xml @@ -1,6 +1,6 @@ - + Imagick::getImageOrientation Gets the image orientation @@ -13,10 +13,10 @@ - + Gets the image orientation. The return value is one of the orientation constants. - + @@ -26,16 +26,16 @@ &reftitle.returnvalues; - + Returns an int on success. - + &reftitle.errors; - + &imagick.imagick.throws; - + diff --git a/reference/imagick/imagick/getimagepage.xml b/reference/imagick/imagick/getimagepage.xml index 447e96699..d7a03976d 100644 --- a/reference/imagick/imagick/getimagepage.xml +++ b/reference/imagick/imagick/getimagepage.xml @@ -1,6 +1,6 @@ - + Imagick::getImagePage Returns the page geometry @@ -12,10 +12,10 @@ public arrayImagick::getImagePage - + Returns the page geometry associated with the image in an array with the keys "width", "height", "x", and "y". - + @@ -25,17 +25,17 @@ &reftitle.returnvalues; - + Returns the page geometry associated with the image in an array with the keys "width", "height", "x", and "y". - + &reftitle.errors; - + &imagick.imagick.throws; - + diff --git a/reference/imagick/imagick/getimagepixelcolor.xml b/reference/imagick/imagick/getimagepixelcolor.xml index c5768690c..30b6a6cd9 100644 --- a/reference/imagick/imagick/getimagepixelcolor.xml +++ b/reference/imagick/imagick/getimagepixelcolor.xml @@ -1,6 +1,6 @@ - + Imagick::getImagePixelColor Returns the color of the specified pixel @@ -13,9 +13,9 @@ intx inty - + Returns the color of the specified pixel. - + @@ -25,17 +25,17 @@ x - + The x-coordinate of the pixel - + y - + The y-coordinate of the pixel - + @@ -44,16 +44,16 @@ &reftitle.returnvalues; - + Returns an ImagickPixel instance for the color at the coordinates given. - + &reftitle.errors; - + &imagick.imagick.throws; - + diff --git a/reference/imagick/imagick/getimageprofile.xml b/reference/imagick/imagick/getimageprofile.xml index 5189bbf5d..7936e4dcc 100644 --- a/reference/imagick/imagick/getimageprofile.xml +++ b/reference/imagick/imagick/getimageprofile.xml @@ -1,6 +1,6 @@ - + Imagick::getImageProfile Returns the named image profile @@ -12,9 +12,9 @@ public stringImagick::getImageProfile stringname - + Returns the named image profile. - + @@ -24,9 +24,9 @@ name - + The name of the profile to return. - + @@ -35,16 +35,16 @@ &reftitle.returnvalues; - + Returns a string containing the image profile. - + &reftitle.errors; - + &imagick.imagick.throws; - + diff --git a/reference/imagick/imagick/getimageprofiles.xml b/reference/imagick/imagick/getimageprofiles.xml index 7e5f7c160..f4f6a1a99 100644 --- a/reference/imagick/imagick/getimageprofiles.xml +++ b/reference/imagick/imagick/getimageprofiles.xml @@ -1,6 +1,6 @@ - + Imagick::getImageProfiles Returns the image profiles @@ -14,10 +14,10 @@ boolinclude_values&true; - + Returns all associated profiles that match the pattern. If &false; is passed as second parameter only the profile names are returned. &imagick.method.available.0x636; - + @@ -27,17 +27,17 @@ pattern - + The pattern for profile names. - + include_values - + Whether to return only profile names. If &false; then only profile names will be returned. - + @@ -46,9 +46,9 @@ &reftitle.returnvalues; - + Returns an array containing the image profiles or profile names. - + diff --git a/reference/imagick/imagick/getimageproperties.xml b/reference/imagick/imagick/getimageproperties.xml index d8e708de2..674e03110 100644 --- a/reference/imagick/imagick/getimageproperties.xml +++ b/reference/imagick/imagick/getimageproperties.xml @@ -14,10 +14,10 @@ boolinclude_values&true; - + Returns all associated properties that match the pattern. If &false; is passed as second parameter only the property names are returned. &imagick.method.available.0x636; - + @@ -27,17 +27,17 @@ pattern - + The pattern for property names. - + include_values - + Whether to return only property names. If &false; then only property names will be returned. - + @@ -46,9 +46,9 @@ &reftitle.returnvalues; - + Returns an array containing the image properties or property names. - + @@ -56,9 +56,9 @@ Using <function>Imagick::getImageProperties</function>: - + An example of extracting EXIF information. - + getImageProperties("exif:*"); /* Loop through the EXIF properties */ foreach ($exifArray as $name => $property) { - echo "{$name} => {$property}
\n"; + echo "{$name} => {$property}
\n"; } ?> diff --git a/reference/imagick/imagick/getimageproperty.xml b/reference/imagick/imagick/getimageproperty.xml index 93b62655d..816e814db 100644 --- a/reference/imagick/imagick/getimageproperty.xml +++ b/reference/imagick/imagick/getimageproperty.xml @@ -1,6 +1,6 @@ - + Imagick::getImageProperty Returns the named image property @@ -13,9 +13,9 @@ stringname - + Returns the named image property. &imagick.method.available.0x632; - + @@ -25,9 +25,9 @@ name - - name of the property (for example Exif:DateTime) - + + name of the property (for example Exif:DateTime) + @@ -36,10 +36,10 @@ &reftitle.returnvalues; - + Returns a string containing the image property, false if a property with the given name does not exist. - + @@ -47,9 +47,9 @@ Using <function>Imagick::getImageProperty</function>: - + Setting and getting image property - + - + Imagick::getImageRedPrimary Returns the chromaticity red primary point @@ -12,9 +12,9 @@ public arrayImagick::getImageRedPrimary - + Returns the chromaticity red primary point as an array with the keys "x" and "y". - + @@ -24,18 +24,18 @@ &reftitle.returnvalues; - + Returns the chromaticity red primary point as an array with the keys "x" and "y". &imagick.imagickexception.throw; - + &reftitle.errors; - + &imagick.imagick.throws; - + diff --git a/reference/imagick/imagick/getimageregion.xml b/reference/imagick/imagick/getimageregion.xml index f18015937..a8c231fe2 100644 --- a/reference/imagick/imagick/getimageregion.xml +++ b/reference/imagick/imagick/getimageregion.xml @@ -1,11 +1,11 @@ - + Imagick::getImageRegion Extracts a region of the image - + &reftitle.description; @@ -15,11 +15,11 @@ intx inty - + Extracts a region of the image and returns it as a new Imagick object. - + - + &reftitle.parameters; @@ -27,53 +27,53 @@ width - + The width of the extracted region. - + height - + The height of the extracted region. - + x - + X-coordinate of the top-left corner of the extracted region. - + y - + Y-coordinate of the top-left corner of the extracted region. - + - + &reftitle.returnvalues; - + Extracts a region of the image and returns it as a new wand. - + &reftitle.errors; - + &imagick.imagick.throws; - + - + - + Imagick::getImageRenderingIntent Gets the image rendering intent @@ -12,9 +12,9 @@ public intImagick::getImageRenderingIntent - + Gets the image rendering intent. - + @@ -24,17 +24,17 @@ &reftitle.returnvalues; - + Returns the image rendering intent. - + &reftitle.errors; - + &imagick.imagick.throws; - + diff --git a/reference/imagick/imagick/getimageresolution.xml b/reference/imagick/imagick/getimageresolution.xml index 7c4bff848..75955c094 100644 --- a/reference/imagick/imagick/getimageresolution.xml +++ b/reference/imagick/imagick/getimageresolution.xml @@ -1,6 +1,6 @@ - + Imagick::getImageResolution Gets the image X and Y resolution @@ -12,9 +12,9 @@ public arrayImagick::getImageResolution - + Gets the image X and Y resolution. - + @@ -24,16 +24,16 @@ &reftitle.returnvalues; - + Returns the resolution as an array. - + &reftitle.errors; - + &imagick.imagick.throws; - + diff --git a/reference/imagick/imagick/getimagesblob.xml b/reference/imagick/imagick/getimagesblob.xml index 79d635ce5..34d12ca0f 100644 --- a/reference/imagick/imagick/getimagesblob.xml +++ b/reference/imagick/imagick/getimagesblob.xml @@ -1,6 +1,6 @@ - + Imagick::getImagesBlob Returns all image sequences as a blob @@ -12,12 +12,12 @@ public stringImagick::getImagesBlob - + Implements direct to memory image formats. It returns all image sequences as a string. The format of the image determines the format of the returned blob (GIF, JPEG, PNG, etc.). To return a different image format, use Imagick::setImageFormat(). - + @@ -27,10 +27,10 @@ &reftitle.returnvalues; - + Returns a string containing the images. On failure, throws ImagickException. - + diff --git a/reference/imagick/imagick/getimagescene.xml b/reference/imagick/imagick/getimagescene.xml index 66c71fdc2..94d1401a8 100644 --- a/reference/imagick/imagick/getimagescene.xml +++ b/reference/imagick/imagick/getimagescene.xml @@ -1,6 +1,6 @@ - + Imagick::getImageScene Gets the image scene @@ -12,9 +12,9 @@ public intImagick::getImageScene - + Gets the image scene. - + @@ -24,16 +24,16 @@ &reftitle.returnvalues; - + Returns the image scene. - + &reftitle.errors; - + &imagick.imagick.throws; - + diff --git a/reference/imagick/imagick/getimagesignature.xml b/reference/imagick/imagick/getimagesignature.xml index 910a9a723..b8d5c059d 100644 --- a/reference/imagick/imagick/getimagesignature.xml +++ b/reference/imagick/imagick/getimagesignature.xml @@ -1,6 +1,6 @@ - + Imagick::getImageSignature Generates an SHA-256 message digest @@ -12,9 +12,9 @@ public stringImagick::getImageSignature - + Generates an SHA-256 message digest for the image pixel stream. - + @@ -24,16 +24,16 @@ &reftitle.returnvalues; - + Returns a string containing the SHA-256 hash of the file. - + &reftitle.errors; - + &imagick.imagick.throws; - + diff --git a/reference/imagick/imagick/getimagesize.xml b/reference/imagick/imagick/getimagesize.xml index ac6107535..337ec02a7 100644 --- a/reference/imagick/imagick/getimagesize.xml +++ b/reference/imagick/imagick/getimagesize.xml @@ -1,6 +1,6 @@ - + Imagick::getImageSize Returns the image length in bytes @@ -16,10 +16,10 @@ public intImagick::getImageSize - + Returns the image length in bytes. Deprecated in favour of Imagick::getImageLength() - + @@ -29,9 +29,9 @@ &reftitle.returnvalues; - + Returns an int containing the current image size. - + diff --git a/reference/imagick/imagick/getimagetickspersecond.xml b/reference/imagick/imagick/getimagetickspersecond.xml index 838b3194b..faccd60f9 100644 --- a/reference/imagick/imagick/getimagetickspersecond.xml +++ b/reference/imagick/imagick/getimagetickspersecond.xml @@ -1,6 +1,6 @@ - + Imagick::getImageTicksPerSecond Gets the image ticks-per-second @@ -12,9 +12,9 @@ public intImagick::getImageTicksPerSecond - + Gets the image ticks-per-second. - + @@ -24,16 +24,16 @@ &reftitle.returnvalues; - + Returns the image ticks-per-second. - + &reftitle.errors; - + &imagick.imagick.throws; - + diff --git a/reference/imagick/imagick/getimagetotalinkdensity.xml b/reference/imagick/imagick/getimagetotalinkdensity.xml index e32439504..f509c4b89 100644 --- a/reference/imagick/imagick/getimagetotalinkdensity.xml +++ b/reference/imagick/imagick/getimagetotalinkdensity.xml @@ -1,6 +1,6 @@ - + Imagick::getImageTotalInkDensity Gets the image total ink density @@ -12,9 +12,9 @@ public floatImagick::getImageTotalInkDensity - + Gets the image total ink density. - + @@ -24,10 +24,10 @@ &reftitle.returnvalues; - + Returns the image total ink density of the image. &imagick.imagickexception.throw; - + diff --git a/reference/imagick/imagick/getimagetype.xml b/reference/imagick/imagick/getimagetype.xml index bcf42f3e1..8fe72a06b 100644 --- a/reference/imagick/imagick/getimagetype.xml +++ b/reference/imagick/imagick/getimagetype.xml @@ -1,6 +1,6 @@ - + Imagick::getImageType Gets the potential image type @@ -12,16 +12,16 @@ public intImagick::getImageType - + Gets the potential image type. - + &reftitle.parameters; &no.function.parameters; - + &reftitle.returnvalues; @@ -88,9 +88,9 @@ &reftitle.errors; - + &imagick.imagick.throws; - + diff --git a/reference/imagick/imagick/getimageunits.xml b/reference/imagick/imagick/getimageunits.xml index bdc55d69c..8c9a5f086 100644 --- a/reference/imagick/imagick/getimageunits.xml +++ b/reference/imagick/imagick/getimageunits.xml @@ -1,6 +1,6 @@ - + Imagick::getImageUnits Gets the image units of resolution @@ -12,9 +12,9 @@ public intImagick::getImageUnits - + Gets the image units of resolution. - + @@ -24,16 +24,16 @@ &reftitle.returnvalues; - + Returns the image units of resolution. - + &reftitle.errors; - + &imagick.imagick.throws; - + diff --git a/reference/imagick/imagick/getimagevirtualpixelmethod.xml b/reference/imagick/imagick/getimagevirtualpixelmethod.xml index 453853b62..316642576 100644 --- a/reference/imagick/imagick/getimagevirtualpixelmethod.xml +++ b/reference/imagick/imagick/getimagevirtualpixelmethod.xml @@ -1,6 +1,6 @@ - + Imagick::getImageVirtualPixelMethod Returns the virtual pixel method @@ -12,9 +12,9 @@ public intImagick::getImageVirtualPixelMethod - + Returns the virtual pixel method for the specified image. - + @@ -24,16 +24,16 @@ &reftitle.returnvalues; - + Returns the virtual pixel method on success. - + &reftitle.errors; - + &imagick.imagick.throws; - + diff --git a/reference/imagick/imagick/getimagewhitepoint.xml b/reference/imagick/imagick/getimagewhitepoint.xml index e0c34cdc5..03512e70b 100644 --- a/reference/imagick/imagick/getimagewhitepoint.xml +++ b/reference/imagick/imagick/getimagewhitepoint.xml @@ -1,6 +1,6 @@ - + Imagick::getImageWhitePoint Returns the chromaticity white point @@ -12,9 +12,9 @@ public arrayImagick::getImageWhitePoint - + Returns the chromaticity white point as an associative array with the keys "x" and "y". - + @@ -24,17 +24,17 @@ &reftitle.returnvalues; - + Returns the chromaticity white point as an associative array with the keys "x" and "y". - + &reftitle.errors; - + &imagick.imagick.throws; - + diff --git a/reference/imagick/imagick/getimagewidth.xml b/reference/imagick/imagick/getimagewidth.xml index 67cd2fa5e..68999b489 100644 --- a/reference/imagick/imagick/getimagewidth.xml +++ b/reference/imagick/imagick/getimagewidth.xml @@ -1,6 +1,6 @@ - + Imagick::getImageWidth Returns the image width @@ -12,9 +12,9 @@ public intImagick::getImageWidth - + Returns the image width. - + @@ -24,16 +24,16 @@ &reftitle.returnvalues; - + Returns the image width. - + &reftitle.errors; - + &imagick.imagick.throws; - + diff --git a/reference/imagick/imagick/getinterlacescheme.xml b/reference/imagick/imagick/getinterlacescheme.xml index 7c3de2c80..f4a7a9cb2 100644 --- a/reference/imagick/imagick/getinterlacescheme.xml +++ b/reference/imagick/imagick/getinterlacescheme.xml @@ -1,6 +1,6 @@ - + Imagick::getInterlaceScheme Gets the object interlace scheme @@ -12,9 +12,9 @@ public intImagick::getInterlaceScheme - + Gets the object interlace scheme. - + @@ -24,17 +24,17 @@ &reftitle.returnvalues; - + Gets the wand interlace scheme. - + &reftitle.errors; - + &imagick.imagick.throws; - + diff --git a/reference/imagick/imagick/getiteratorindex.xml b/reference/imagick/imagick/getiteratorindex.xml index 914877fa7..90bc9e7ec 100644 --- a/reference/imagick/imagick/getiteratorindex.xml +++ b/reference/imagick/imagick/getiteratorindex.xml @@ -1,6 +1,6 @@ - + Imagick::getIteratorIndex Gets the index of the current active image @@ -13,10 +13,10 @@ - + Returns the index of the current active image within the Imagick object. &imagick.method.available.0x629; - + @@ -26,16 +26,16 @@ &reftitle.returnvalues; - + Returns an integer containing the index of the image in the stack. - + &reftitle.errors; - + &imagick.imagick.throws; - + @@ -43,9 +43,9 @@ Using <function>Imagick::getIteratorIndex</function>: - + Create images, set and get the iterator index - + - + Imagick::getNumberImages Returns the number of images in the object @@ -12,9 +12,9 @@ public intImagick::getNumberImages - + Returns the number of images associated with Imagick object. - + @@ -24,16 +24,16 @@ &reftitle.returnvalues; - + Returns the number of images associated with Imagick object. - + &reftitle.errors; - + &imagick.imagick.throws; - + diff --git a/reference/imagick/imagick/getoption.xml b/reference/imagick/imagick/getoption.xml index 81364077f..9a1380a59 100644 --- a/reference/imagick/imagick/getoption.xml +++ b/reference/imagick/imagick/getoption.xml @@ -1,6 +1,6 @@ - + Imagick::getOption Returns a value associated with the specified key @@ -12,9 +12,9 @@ public stringImagick::getOption stringkey - + Returns a value associated within the object for the specified key. - + @@ -24,9 +24,9 @@ key - + The name of the option - + @@ -35,16 +35,16 @@ &reftitle.returnvalues; - + Returns a value associated with a wand and the specified key. - + &reftitle.errors; - + &imagick.imagick.throws; - + diff --git a/reference/imagick/imagick/getpackagename.xml b/reference/imagick/imagick/getpackagename.xml index 97687f87e..6a1b75d5d 100644 --- a/reference/imagick/imagick/getpackagename.xml +++ b/reference/imagick/imagick/getpackagename.xml @@ -1,6 +1,6 @@ - + Imagick::getPackageName Returns the ImageMagick package name @@ -12,9 +12,9 @@ public static stringImagick::getPackageName - + Returns the ImageMagick package name. - + @@ -24,16 +24,16 @@ &reftitle.returnvalues; - + Returns the ImageMagick package name as a string. - + &reftitle.errors; - + &imagick.imagick.throws; - + diff --git a/reference/imagick/imagick/getpage.xml b/reference/imagick/imagick/getpage.xml index 2f9eaddfc..fc28ac6b5 100644 --- a/reference/imagick/imagick/getpage.xml +++ b/reference/imagick/imagick/getpage.xml @@ -1,6 +1,6 @@ - + Imagick::getPage Returns the page geometry @@ -12,10 +12,10 @@ public arrayImagick::getPage - + Returns the page geometry associated with the Imagick object in an associative array with the keys "width", "height", "x", and "y". - + @@ -25,11 +25,11 @@ &reftitle.returnvalues; - + Returns the page geometry associated with the Imagick object in an associative array with the keys "width", "height", "x", and "y", throwing ImagickException on error. - + diff --git a/reference/imagick/imagick/getpixeliterator.xml b/reference/imagick/imagick/getpixeliterator.xml index b6bd21183..340432c3e 100644 --- a/reference/imagick/imagick/getpixeliterator.xml +++ b/reference/imagick/imagick/getpixeliterator.xml @@ -1,6 +1,6 @@ - + Imagick::getPixelIterator Returns a MagickPixelIterator @@ -12,9 +12,9 @@ public ImagickPixelIteratorImagick::getPixelIterator - + Returns a MagickPixelIterator. - + @@ -24,16 +24,16 @@ &reftitle.returnvalues; - + Returns an ImagickPixelIterator on success. - + &reftitle.errors; - + &imagick.imagick.throws; - + diff --git a/reference/imagick/imagick/getpixelregioniterator.xml b/reference/imagick/imagick/getpixelregioniterator.xml index 94be187db..6fded1bb9 100644 --- a/reference/imagick/imagick/getpixelregioniterator.xml +++ b/reference/imagick/imagick/getpixelregioniterator.xml @@ -1,11 +1,11 @@ - + Imagick::getPixelRegionIterator Get an ImagickPixelIterator for an image section - + &reftitle.description; @@ -15,11 +15,11 @@ intcolumns introws - + Get an ImagickPixelIterator for an image section. - + - + &reftitle.parameters; @@ -27,51 +27,51 @@ x - + The x-coordinate of the region. - + y - + The y-coordinate of the region. - + columns - + The width of the region. - + rows - + The height of the region. - + - + &reftitle.returnvalues; - + Returns an ImagickPixelIterator for an image section. - + - + &reftitle.errors; - + &imagick.imagick.throws; - + @@ -79,9 +79,9 @@ <methodname>Imagick::getPixelRegionIterator</methodname> example - + Iterate over the pixels in the top left of the image, changing them to be black. - + writeImage("./output.png"); - + - + Imagick::getPointSize Gets point size @@ -12,10 +12,10 @@ public floatImagick::getPointSize - + Returns the objects point size property. &imagick.method.available.0x637; - + @@ -25,9 +25,9 @@ &reftitle.returnvalues; - + Returns a &float; containing the point size. - + diff --git a/reference/imagick/imagick/getquantum.xml b/reference/imagick/imagick/getquantum.xml index d58f5a24f..29be5039d 100644 --- a/reference/imagick/imagick/getquantum.xml +++ b/reference/imagick/imagick/getquantum.xml @@ -13,9 +13,9 @@ public static intImagick::getQuantum - + Returns the ImageMagick quantum range. If HDRI was enabled then the type is a float, if not it is an int. - + @@ -27,9 +27,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/imagick/imagick/getquantumdepth.xml b/reference/imagick/imagick/getquantumdepth.xml index 2df8045d0..63d156fcf 100644 --- a/reference/imagick/imagick/getquantumdepth.xml +++ b/reference/imagick/imagick/getquantumdepth.xml @@ -1,6 +1,6 @@ - + Imagick::getQuantumDepth Gets the quantum depth @@ -12,9 +12,9 @@ public static arrayImagick::getQuantumDepth - + Returns the Imagick quantum depth. - + @@ -24,17 +24,17 @@ &reftitle.returnvalues; - + Returns an array with "quantumDepthLong" and "quantumDepthString" members. - + &reftitle.errors; - + &imagick.imagick.throws; - + diff --git a/reference/imagick/imagick/getquantumrange.xml b/reference/imagick/imagick/getquantumrange.xml index 0a16cffb1..4cacd2b71 100644 --- a/reference/imagick/imagick/getquantumrange.xml +++ b/reference/imagick/imagick/getquantumrange.xml @@ -1,6 +1,6 @@ - + Imagick::getQuantumRange Returns the Imagick quantum range @@ -12,9 +12,9 @@ public static arrayImagick::getQuantumRange - + Returns the quantum range for the Imagick instance. - + @@ -24,18 +24,18 @@ &reftitle.returnvalues; - + Returns an associative array containing the quantum range as an - int ("quantumRangeLong") and as a + int ("quantumRangeLong") and as a string ("quantumRangeString"). - + &reftitle.errors; - + &imagick.imagick.throws; - + diff --git a/reference/imagick/imagick/getregistry.xml b/reference/imagick/imagick/getregistry.xml index 2d8d0ea6f..01a49015a 100644 --- a/reference/imagick/imagick/getregistry.xml +++ b/reference/imagick/imagick/getregistry.xml @@ -13,9 +13,9 @@ public static stringImagick::getRegistry stringkey - + Get the StringRegistry entry for the named key or false if not set. - + @@ -25,9 +25,9 @@ key - + The entry to get. - + @@ -35,9 +35,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/imagick/imagick/getreleasedate.xml b/reference/imagick/imagick/getreleasedate.xml index d1faed186..7d0208c97 100644 --- a/reference/imagick/imagick/getreleasedate.xml +++ b/reference/imagick/imagick/getreleasedate.xml @@ -1,6 +1,6 @@ - + Imagick::getReleaseDate Returns the ImageMagick release date @@ -12,9 +12,9 @@ public static stringImagick::getReleaseDate - + Returns the ImageMagick release date as a string. - + @@ -24,16 +24,16 @@ &reftitle.returnvalues; - + Returns the ImageMagick release date as a string. - + &reftitle.errors; - + &imagick.imagick.throws; - + diff --git a/reference/imagick/imagick/getresource.xml b/reference/imagick/imagick/getresource.xml index 7947ef727..f0cfb511d 100644 --- a/reference/imagick/imagick/getresource.xml +++ b/reference/imagick/imagick/getresource.xml @@ -1,6 +1,6 @@ - + Imagick::getResource Returns the specified resource's memory usage @@ -12,9 +12,9 @@ public static intImagick::getResource inttype - + Returns the specified resource's memory usage in megabytes. - + @@ -24,9 +24,9 @@ type - + Refer to the list of resourcetype constants. - + @@ -35,16 +35,16 @@ &reftitle.returnvalues; - + Returns the specified resource's memory usage in megabytes. - + &reftitle.errors; - + &imagick.imagick.throws; - + diff --git a/reference/imagick/imagick/getresourcelimit.xml b/reference/imagick/imagick/getresourcelimit.xml index 3e0c69e85..680350f40 100644 --- a/reference/imagick/imagick/getresourcelimit.xml +++ b/reference/imagick/imagick/getresourcelimit.xml @@ -1,6 +1,6 @@ - + Imagick::getResourceLimit Returns the specified resource limit @@ -12,9 +12,9 @@ public static intImagick::getResourceLimit inttype - + Returns the specified resource limit. - + @@ -24,10 +24,10 @@ type - - One of the + One of the resourcetype constants. - + @@ -36,17 +36,17 @@ &reftitle.returnvalues; - + Returns the specified resource limit. The unit depends on the type of the resource being limited. - + &reftitle.errors; - + &imagick.imagick.throws; - + diff --git a/reference/imagick/imagick/getsamplingfactors.xml b/reference/imagick/imagick/getsamplingfactors.xml index bc563e598..a006feccd 100644 --- a/reference/imagick/imagick/getsamplingfactors.xml +++ b/reference/imagick/imagick/getsamplingfactors.xml @@ -1,6 +1,6 @@ - + Imagick::getSamplingFactors Gets the horizontal and vertical sampling factor @@ -12,9 +12,9 @@ public arrayImagick::getSamplingFactors - + Gets the horizontal and vertical sampling factor. - + @@ -24,17 +24,17 @@ &reftitle.returnvalues; - + Returns an associative array with the horizontal and vertical sampling factors of the image. - + &reftitle.errors; - + &imagick.imagick.throws; - + diff --git a/reference/imagick/imagick/getsize.xml b/reference/imagick/imagick/getsize.xml index a8c026e42..29c833b1c 100644 --- a/reference/imagick/imagick/getsize.xml +++ b/reference/imagick/imagick/getsize.xml @@ -1,6 +1,6 @@ - + Imagick::getSize Returns the size associated with the Imagick object @@ -12,13 +12,13 @@ public arrayImagick::getSize - + Get the size in pixels associated with the Imagick object, previously set by Imagick::setSize. - + - + This method just returns the size that was set using Imagick::setSize. If you want to get the actual width / height of the image, use Imagick::getImageWidth and Imagick::getImageHeight. - + @@ -29,12 +29,12 @@ &reftitle.returnvalues; - + Returns the size associated with the Imagick object as an array with the keys "columns" and "rows". - + - + &reftitle.examples; diff --git a/reference/imagick/imagick/getsizeoffset.xml b/reference/imagick/imagick/getsizeoffset.xml index 030a228c0..936cccd7c 100644 --- a/reference/imagick/imagick/getsizeoffset.xml +++ b/reference/imagick/imagick/getsizeoffset.xml @@ -1,6 +1,6 @@ - + Imagick::getSizeOffset Returns the size offset @@ -13,10 +13,10 @@ - + Returns the size offset associated with the Imagick object. &imagick.method.available.0x629; - + @@ -26,16 +26,16 @@ &reftitle.returnvalues; - + Returns the size offset associated with the Imagick object. - + &reftitle.errors; - + &imagick.imagick.throws; - + diff --git a/reference/imagick/imagick/getversion.xml b/reference/imagick/imagick/getversion.xml index ade82032b..6d01a1984 100644 --- a/reference/imagick/imagick/getversion.xml +++ b/reference/imagick/imagick/getversion.xml @@ -1,6 +1,6 @@ - + Imagick::getVersion Returns the ImageMagick API version @@ -12,9 +12,9 @@ public static arrayImagick::getVersion - + Returns the ImageMagick API version as a string and as a number. - + @@ -24,16 +24,16 @@ &reftitle.returnvalues; - + Returns the ImageMagick API version as a string and as a number. - + &reftitle.errors; - + &imagick.imagick.throws; - + diff --git a/reference/imagick/imagick/haldclutimage.xml b/reference/imagick/imagick/haldclutimage.xml index e4050b768..a39a61fbb 100644 --- a/reference/imagick/imagick/haldclutimage.xml +++ b/reference/imagick/imagick/haldclutimage.xml @@ -14,10 +14,10 @@ Imagickclut intchannelImagick::CHANNEL_DEFAULT - - Replaces colors in the image using a Hald lookup table. Hald images can be created using + + Replaces colors in the image using a Hald lookup table. Hald images can be created using HALD color coder. - + @@ -27,17 +27,17 @@ clut - + Imagick object containing the Hald lookup image. - + channel - + &imagick.parameter.channel; - + @@ -46,16 +46,16 @@ &reftitle.returnvalues; - + &imagick.return.success; - + &reftitle.errors; - + &imagick.imagick.throws; - + diff --git a/reference/imagick/imagick/hasnextimage.xml b/reference/imagick/imagick/hasnextimage.xml index 0e3ecf144..6d19022ac 100644 --- a/reference/imagick/imagick/hasnextimage.xml +++ b/reference/imagick/imagick/hasnextimage.xml @@ -1,6 +1,6 @@ - + Imagick::hasNextImage Checks if the object has more images @@ -12,9 +12,9 @@ public boolImagick::hasNextImage - + Returns &true; if the object has more images when traversing the list in the forward direction. - + @@ -24,10 +24,10 @@ &reftitle.returnvalues; - + Returns &true; if the object has more images when traversing the list in the forward direction, returns &false; if there are none. - + diff --git a/reference/imagick/imagick/haspreviousimage.xml b/reference/imagick/imagick/haspreviousimage.xml index c32d4da37..5db6e992d 100644 --- a/reference/imagick/imagick/haspreviousimage.xml +++ b/reference/imagick/imagick/haspreviousimage.xml @@ -1,6 +1,6 @@ - + Imagick::hasPreviousImage Checks if the object has a previous image @@ -12,9 +12,9 @@ public boolImagick::hasPreviousImage - + Returns &true; if the object has more images when traversing the list in the reverse direction - + @@ -24,10 +24,10 @@ &reftitle.returnvalues; - + Returns &true; if the object has more images when traversing the list in the reverse direction, returns &false; if there are none. - + diff --git a/reference/imagick/imagick/identifyformat.xml b/reference/imagick/imagick/identifyformat.xml index c7f4e67a7..0ae048c56 100644 --- a/reference/imagick/imagick/identifyformat.xml +++ b/reference/imagick/imagick/identifyformat.xml @@ -13,9 +13,9 @@ public stringfalseImagick::identifyFormat stringembedText - + Replaces any embedded formatting characters with the appropriate image property and returns the interpreted text. See http://www.imagemagick.org/script/escape.php for escape sequences. - + @@ -26,9 +26,9 @@ embedText - + A string containing formatting sequences e.g. "Trim box: %@ number of unique colors: %k". - + @@ -36,9 +36,9 @@ &reftitle.returnvalues; - + Returns format&return.falseforfailure;. - + diff --git a/reference/imagick/imagick/identifyimage.xml b/reference/imagick/imagick/identifyimage.xml index 6540a424c..9b5d5fc6e 100644 --- a/reference/imagick/imagick/identifyimage.xml +++ b/reference/imagick/imagick/identifyimage.xml @@ -1,6 +1,6 @@ - + Imagick::identifyImage Identifies an image and fetches attributes @@ -12,10 +12,10 @@ public arrayImagick::identifyImage boolappendRawOutput&false; - + Identifies an image and returns the attributes. Attributes include the image width, height, size, and others. - + @@ -25,9 +25,9 @@ appendRawOutput - + If &true; then the raw output is appended to the array. - + @@ -36,19 +36,19 @@ &reftitle.returnvalues; - + Identifies an image and returns the attributes. Attributes include the image width, height, size, and others. - + &reftitle.errors; - + &imagick.imagick.throws; - + - + &reftitle.examples; diff --git a/reference/imagick/imagick/implodeimage.xml b/reference/imagick/imagick/implodeimage.xml index 3806daac5..663e2c666 100644 --- a/reference/imagick/imagick/implodeimage.xml +++ b/reference/imagick/imagick/implodeimage.xml @@ -1,6 +1,6 @@ - + Imagick::implodeImage Creates a new image as a copy @@ -12,10 +12,10 @@ public boolImagick::implodeImage floatradius - + Creates a new image that is a copy of an existing one with the image pixels "imploded" by the specified percentage. - + @@ -25,9 +25,9 @@ radius - + The radius of the implode - + @@ -36,16 +36,16 @@ &reftitle.returnvalues; - + &imagick.return.success; - + &reftitle.errors; - + &imagick.imagick.throws; - + diff --git a/reference/imagick/imagick/importimagepixels.xml b/reference/imagick/imagick/importimagepixels.xml index 2cbaf67ac..cf3a643e6 100644 --- a/reference/imagick/imagick/importimagepixels.xml +++ b/reference/imagick/imagick/importimagepixels.xml @@ -19,12 +19,12 @@ intstorage arraypixels - + Imports pixels from an array into an image. The map is usually 'RGB'. This method imposes the following constraints for the parameters: amount of pixels in the array must match width x height x length of the map. &imagick.method.available.0x645; - + @@ -35,60 +35,60 @@ x - + The image x position - + y - + The image y position - + width - + The image width - + height - + The image height - + map - + Map of pixel ordering as a string. This can be for example RGB. - The value can be any combination or order of R = red, G = green, B = blue, A = alpha (0 is transparent), + The value can be any combination or order of R = red, G = green, B = blue, A = alpha (0 is transparent), O = opacity (0 is opaque), C = cyan, Y = yellow, M = magenta, K = black, I = intensity (for grayscale), P = pad. - + storage - - The pixel storage method. + + The pixel storage method. Refer to this list of pixel constants. - + pixels - + The array of pixels - + @@ -97,16 +97,16 @@ &reftitle.returnvalues; - + &imagick.return.success; - + &reftitle.errors; - + &imagick.imagick.throws; - + @@ -121,9 +121,9 @@ /* Generate array of pixels. 2000 pixels per color stripe */ $count = 2000 * 3; -$pixels = +$pixels = array_merge(array_pad(array(), $count, 0), - array_pad(array(), $count, 255), + array_pad(array(), $count, 255), array_pad(array(), $count, 0), array_pad(array(), $count, 255), array_pad(array(), $count, 0)); diff --git a/reference/imagick/imagick/inversefouriertransformimage.xml b/reference/imagick/imagick/inversefouriertransformimage.xml index 50100a761..f0c1163df 100644 --- a/reference/imagick/imagick/inversefouriertransformimage.xml +++ b/reference/imagick/imagick/inversefouriertransformimage.xml @@ -14,9 +14,9 @@ Imagickcomplement boolmagnitude - + Implements the inverse discrete Fourier transform (DFT) of the image either as a magnitude / phase or real / imaginary image pair. - + &warn.undocumented.func; @@ -28,17 +28,17 @@ complement - + The second image to combine with this one to form either the magnitude / phase or real / imaginary image pair. - + magnitude - + If true, combine as magnitude / phase pair otherwise a real / imaginary image pair. - + @@ -46,9 +46,9 @@ &reftitle.returnvalues; - + &imagick.return.success; - + diff --git a/reference/imagick/imagick/labelimage.xml b/reference/imagick/imagick/labelimage.xml index d4316ce0c..76857019e 100644 --- a/reference/imagick/imagick/labelimage.xml +++ b/reference/imagick/imagick/labelimage.xml @@ -1,6 +1,6 @@ - + Imagick::labelImage Adds a label to an image @@ -12,9 +12,9 @@ public boolImagick::labelImage stringlabel - + Adds a label to an image. - + @@ -24,9 +24,9 @@ label - + The label to add - + @@ -35,9 +35,9 @@ &reftitle.returnvalues; - + &imagick.return.success; - + diff --git a/reference/imagick/imagick/levelimage.xml b/reference/imagick/imagick/levelimage.xml index 8995e9cd6..1454a10e6 100644 --- a/reference/imagick/imagick/levelimage.xml +++ b/reference/imagick/imagick/levelimage.xml @@ -1,6 +1,6 @@ - + Imagick::levelImage Adjusts the levels of an image @@ -15,7 +15,7 @@ floatwhitePoint intchannelImagick::CHANNEL_DEFAULT - + Adjusts the levels of an image by scaling the colors falling between specified white and black points to the full available quantum range. The parameters provided represent @@ -25,7 +25,7 @@ correction to apply to the image. White point specifies the lightest color in the image. Colors brighter than the white point are set to the maximum quantum value. - + @@ -35,36 +35,36 @@ blackPoint - + The image black point - + gamma - + The gamma value - + whitePoint - + The image white point - + channel - + Provide any channel constant that is valid for your channel mode. To apply to more than one channel, combine channeltype constants using bitwise operators. Refer to this list of channel constants. - + @@ -73,16 +73,16 @@ &reftitle.returnvalues; - + &imagick.return.success; - + &reftitle.errors; - + &imagick.imagick.throws; - + diff --git a/reference/imagick/imagick/linearstretchimage.xml b/reference/imagick/imagick/linearstretchimage.xml index aa1ae18fa..5098f2944 100644 --- a/reference/imagick/imagick/linearstretchimage.xml +++ b/reference/imagick/imagick/linearstretchimage.xml @@ -1,6 +1,6 @@ - + Imagick::linearStretchImage Stretches with saturation the image intensity @@ -14,9 +14,9 @@ floatwhitePoint - + Stretches with saturation the image intensity. - + @@ -26,17 +26,17 @@ blackPoint - + The image black point - + whitePoint - + The image white point - + @@ -45,9 +45,9 @@ &reftitle.returnvalues; - + &imagick.return.success; - + diff --git a/reference/imagick/imagick/liquidrescaleimage.xml b/reference/imagick/imagick/liquidrescaleimage.xml index 063107fb9..d555432ca 100644 --- a/reference/imagick/imagick/liquidrescaleimage.xml +++ b/reference/imagick/imagick/liquidrescaleimage.xml @@ -1,6 +1,6 @@ - + Imagick::liquidRescaleImage Animates an image or images @@ -16,12 +16,12 @@ floatrigidity - + This method scales the images using liquid rescaling method. This method is an implementation of a technique called seam carving. In order for this method to work as expected ImageMagick must be compiled with liblqr support. &imagick.method.available.0x639; - + @@ -31,35 +31,35 @@ width - + The width of the target size - + height - + The height of the target size - + delta_x - - How much the seam can traverse on x-axis. + + How much the seam can traverse on x-axis. Passing 0 causes the seams to be straight. - + rigidity - - Introduces a bias for non-straight seams. This parameter is + + Introduces a bias for non-straight seams. This parameter is typically 0. - + @@ -68,9 +68,9 @@ &reftitle.returnvalues; - + &imagick.return.success; - + diff --git a/reference/imagick/imagick/listregistry.xml b/reference/imagick/imagick/listregistry.xml index 209f7148c..2f2c95445 100644 --- a/reference/imagick/imagick/listregistry.xml +++ b/reference/imagick/imagick/listregistry.xml @@ -13,9 +13,9 @@ public static arrayImagick::listRegistry - + List all the registry settings. Returns an array of all the key/value pairs in the registry - + @@ -26,9 +26,9 @@ &reftitle.returnvalues; - + An array containing the key/values from the registry. - + diff --git a/reference/imagick/imagick/magnifyimage.xml b/reference/imagick/imagick/magnifyimage.xml index 45dab1cf1..6383cb785 100644 --- a/reference/imagick/imagick/magnifyimage.xml +++ b/reference/imagick/imagick/magnifyimage.xml @@ -1,6 +1,6 @@ - + Imagick::magnifyImage Scales an image proportionally 2x @@ -12,9 +12,9 @@ public boolImagick::magnifyImage - + Is a convenience method that scales an image proportionally to twice its original size. - + @@ -24,16 +24,16 @@ &reftitle.returnvalues; - + &imagick.return.success; - + &reftitle.errors; - + &imagick.imagick.throws; - + diff --git a/reference/imagick/imagick/mapimage.xml b/reference/imagick/imagick/mapimage.xml index 192f642d5..bfca73ec5 100644 --- a/reference/imagick/imagick/mapimage.xml +++ b/reference/imagick/imagick/mapimage.xml @@ -1,6 +1,6 @@ - + Imagick::mapImage Replaces the colors of an image with the closest color from a reference image @@ -26,15 +26,15 @@ map - - + + dither - - + + @@ -43,16 +43,16 @@ &reftitle.returnvalues; - + &imagick.return.success; - + &reftitle.errors; - + &imagick.imagick.throws; - + diff --git a/reference/imagick/imagick/mattefloodfillimage.xml b/reference/imagick/imagick/mattefloodfillimage.xml index 0be21adbb..4ae6a741a 100644 --- a/reference/imagick/imagick/mattefloodfillimage.xml +++ b/reference/imagick/imagick/mattefloodfillimage.xml @@ -1,6 +1,6 @@ - + Imagick::matteFloodfillImage Changes the transparency value of a color @@ -20,13 +20,13 @@ intx inty - + Changes the transparency value of any pixel that matches target and is an immediate neighbor. If the method FillToBorderMethod is specified, the transparency value is changed for any neighbor pixel that does not match the bordercolor member of image. - + @@ -36,43 +36,43 @@ alpha - + The level of transparency: 1.0 is fully opaque and 0.0 is fully transparent. - + fuzz - + The fuzz member of image defines how much tolerance is acceptable to consider two colors as the same. - + bordercolor - + An ImagickPixel object or string representing the border color. - + x - + The starting x coordinate of the operation. - + y - + The starting y coordinate of the operation. - + @@ -81,16 +81,16 @@ &reftitle.returnvalues; - + &imagick.return.success; - + &reftitle.errors; - + &imagick.imagick.throws; - + diff --git a/reference/imagick/imagick/medianfilterimage.xml b/reference/imagick/imagick/medianfilterimage.xml index f0f8c364d..77a2c4786 100644 --- a/reference/imagick/imagick/medianfilterimage.xml +++ b/reference/imagick/imagick/medianfilterimage.xml @@ -1,6 +1,6 @@ - + Imagick::medianFilterImage Applies a digital filter @@ -16,11 +16,11 @@ public boolImagick::medianFilterImage floatradius - + Applies a digital filter that improves the quality of a noisy image. Each pixel is replaced by the median in a set of neighboring pixels as defined by radius. - + @@ -30,9 +30,9 @@ radius - + The radius of the pixel neighborhood. - + @@ -41,16 +41,16 @@ &reftitle.returnvalues; - + &imagick.return.success; - + &reftitle.errors; - + &imagick.imagick.throws; - + diff --git a/reference/imagick/imagick/mergeimagelayers.xml b/reference/imagick/imagick/mergeimagelayers.xml index c0619798e..9b463e31e 100644 --- a/reference/imagick/imagick/mergeimagelayers.xml +++ b/reference/imagick/imagick/mergeimagelayers.xml @@ -1,6 +1,6 @@ - + Imagick::mergeImageLayers Merges image layers @@ -12,12 +12,12 @@ public ImagickImagick::mergeImageLayers intlayer_method - + Merges image layers into one. This method is useful when working with image formats that use multiple layers such as PSD. The merging is controlled using the layer_method which defines how the layers are merged. &imagick.method.available.0x637; - + @@ -27,9 +27,9 @@ layer_method - + One of the Imagick::LAYERMETHOD_* constants - + @@ -38,18 +38,18 @@ &reftitle.returnvalues; - + Returns an Imagick object containing the merged image. - + - + &reftitle.errors; - + &imagick.imagick.throws; - + - + &reftitle.examples; @@ -85,7 +85,7 @@ function mergeImageLayers($layerMethodType, $imagePath1, $imagePath2) { Imagick::flattenImages - + diff --git a/reference/imagick/imagick/minifyimage.xml b/reference/imagick/imagick/minifyimage.xml index e55cc5d6d..d670cc2a7 100644 --- a/reference/imagick/imagick/minifyimage.xml +++ b/reference/imagick/imagick/minifyimage.xml @@ -1,6 +1,6 @@ - + Imagick::minifyImage Scales an image proportionally to half its size @@ -12,9 +12,9 @@ public boolImagick::minifyImage - + Is a convenience method that scales an image proportionally to one-half its original size - + @@ -24,9 +24,9 @@ &reftitle.returnvalues; - + &imagick.return.success; - + diff --git a/reference/imagick/imagick/modulateimage.xml b/reference/imagick/imagick/modulateimage.xml index f4d2ea09b..3f78f2d03 100644 --- a/reference/imagick/imagick/modulateimage.xml +++ b/reference/imagick/imagick/modulateimage.xml @@ -1,6 +1,6 @@ - + Imagick::modulateImage Control the brightness, saturation, and hue @@ -14,13 +14,13 @@ floatsaturation floathue - + Lets you control the brightness, saturation, and hue of an image. Hue is the percentage of absolute rotation from the current position. For example 50 results in a counter-clockwise rotation of 90 degrees, 150 results in a clockwise rotation of 90 degrees, with 0 and 200 both resulting in a rotation of 180 degrees. - + @@ -30,22 +30,22 @@ brightness - - + + saturation - - + + hue - - + + @@ -54,9 +54,9 @@ &reftitle.returnvalues; - + &imagick.return.success; - + diff --git a/reference/imagick/imagick/montageimage.xml b/reference/imagick/imagick/montageimage.xml index dc5053d17..769db4213 100644 --- a/reference/imagick/imagick/montageimage.xml +++ b/reference/imagick/imagick/montageimage.xml @@ -1,11 +1,11 @@ - + Imagick::montageImage Creates a composite image - + &reftitle.description; @@ -16,13 +16,13 @@ intmode stringframe - + Creates a composite image by combining several separate images. The images are tiled on the composite image with the name of the image optionally appearing just below the individual tile. - + - + &reftitle.parameters; @@ -30,57 +30,57 @@ draw - + The font name, size, and color are obtained from this object. - + tile_geometry - + The number of tiles per row and page (e.g. 6x4+0+0). - + thumbnail_geometry - + Preferred image size and border size of each thumbnail (e.g. 120x120+4+3). - + mode - - Thumbnail framing mode, see + Thumbnail framing mode, see Montage Mode constants. - + frame - + Surround the image with an ornamental border (e.g. 15x15+3+3). The frame color is that of the thumbnail's matte color. - + - + &reftitle.returnvalues; - + Creates a composite image and returns it as a new Imagick object. - + - + - + Imagick::morphImages Method morphs a set of images @@ -12,11 +12,11 @@ public ImagickImagick::morphImages intnumber_frames - + Method morphs a set of images. Both the image pixels and size are linearly interpolated to give the appearance of a meta-morphosis from one image to the next. - + @@ -26,9 +26,9 @@ number_frames - + The number of in-between images to generate. - + @@ -37,10 +37,10 @@ &reftitle.returnvalues; - + This method returns a new Imagick object on success. &imagick.imagickexception.throw; - + diff --git a/reference/imagick/imagick/morphology.xml b/reference/imagick/imagick/morphology.xml index a198574c1..d6cd9f4f3 100644 --- a/reference/imagick/imagick/morphology.xml +++ b/reference/imagick/imagick/morphology.xml @@ -16,12 +16,12 @@ ImagickKernelImagickKernel intchannelImagick::CHANNEL_DEFAULT - + Applies a user supplied kernel to the image according to the given morphology method. - + + - @@ -30,33 +30,33 @@ morphologyMethod - + Which morphology method to use one of the \Imagick::MORPHOLOGY_* constants. - + iterations - + The number of iteration to apply the morphology function. A value of -1 means loop until no change found. How this is applied may depend on the morphology method. Typically this is a value of 1. - + ImagickKernel - - - + + + channel - - - + + + @@ -64,9 +64,9 @@ &reftitle.returnvalues; - + &imagick.return.success; - + @@ -100,7 +100,7 @@ // Top-left pixel must be black // Bottom right pixel must be white // We don't care about the rest. - + $imagick = $this->getCharacterOutline(); $kernel = \ImagickKernel::fromMatrix(self::$correlateMatrix, [2, 2]); @@ -441,7 +441,7 @@ $leftEdgeKernel = \ImagickKernel::fromMatrix([[0, 1]], [1, 0]); $rightEdgeKernel = \ImagickKernel::fromMatrix([[1, 0]], [0, 0]); $leftEdgeKernel->addKernel($rightEdgeKernel); - + $canvas->morphology(\Imagick::MORPHOLOGY_THINNING, 3, $leftEdgeKernel); header("Content-Type: image/png"); echo $canvas->getImageBlob(); @@ -499,7 +499,7 @@ getCharacterOutline(); - $kernel = \ImagickKernel::fromBuiltIn(\Imagick::KERNEL_DISK, "2"); + $kernel = \ImagickKernel::fromBuiltIn(\Imagick::KERNEL_DISK, "2"); $canvas->morphology(\Imagick::MORPHOLOGY_ITERATIVE, 3, $kernel); $canvas->autoLevelImage(); header("Content-Type: image/png"); diff --git a/reference/imagick/imagick/mosaicimages.xml b/reference/imagick/imagick/mosaicimages.xml index 07fdf02cf..9a7cc0c62 100644 --- a/reference/imagick/imagick/mosaicimages.xml +++ b/reference/imagick/imagick/mosaicimages.xml @@ -1,6 +1,6 @@ - + Imagick::mosaicImages Forms a mosaic from images @@ -16,11 +16,11 @@ public ImagickImagick::mosaicImages - + Inlays an image sequence to form a single coherent picture. It returns a wand with each image in the sequence composited at the location defined by the page offset of the image. - + @@ -30,9 +30,9 @@ &reftitle.returnvalues; - + &imagick.return.success; - + diff --git a/reference/imagick/imagick/motionblurimage.xml b/reference/imagick/imagick/motionblurimage.xml index b8fc82b69..841529632 100644 --- a/reference/imagick/imagick/motionblurimage.xml +++ b/reference/imagick/imagick/motionblurimage.xml @@ -1,6 +1,6 @@ - + Imagick::motionBlurImage Simulates motion blur @@ -13,15 +13,15 @@ floatradius floatsigma floatangle - intchannelImagick::CHANNEL_DEFAULT + intchannelImagick::CHANNEL_DEFAULT - + Simulates motion blur. We convolve the image with a Gaussian operator of the given radius and standard deviation (sigma). For reasonable results, radius should be larger than sigma. Use a radius of 0 and MotionBlurImage() selects a suitable radius for you. Angle gives the angle of the blurring motion. - + @@ -31,38 +31,38 @@ radius - + The radius of the Gaussian, in pixels, not counting the center pixel. - + sigma - + The standard deviation of the Gaussian, in pixels. - + angle - + Apply the effect along this angle. - + channel - + Provide any channel constant that is valid for your channel mode. To apply to more than one channel, combine channeltype constants using bitwise operators. Refer to this list of channel constants. The channel argument affects only if Imagick is compiled against ImageMagick version 6.4.4 or greater. - + @@ -71,9 +71,9 @@ &reftitle.returnvalues; - + &imagick.return.success; - + diff --git a/reference/imagick/imagick/negateimage.xml b/reference/imagick/imagick/negateimage.xml index 64daefb08..6b5aad87e 100644 --- a/reference/imagick/imagick/negateimage.xml +++ b/reference/imagick/imagick/negateimage.xml @@ -1,6 +1,6 @@ - + Imagick::negateImage Negates the colors in the reference image @@ -13,11 +13,11 @@ boolgray intchannelImagick::CHANNEL_DEFAULT - + Negates the colors in the reference image. The Grayscale option means that only grayscale values within the image are negated. - + @@ -27,20 +27,20 @@ gray - + Whether to only negate grayscale pixels within the image. - + channel - + Provide any channel constant that is valid for your channel mode. To apply to more than one channel, combine channeltype constants using bitwise operators. Refer to this list of channel constants. - + @@ -49,16 +49,16 @@ &reftitle.returnvalues; - + &imagick.return.success; - + &reftitle.errors; - + &imagick.imagick.throws; - + diff --git a/reference/imagick/imagick/newimage.xml b/reference/imagick/imagick/newimage.xml index 3eca99a87..eb72501b1 100644 --- a/reference/imagick/imagick/newimage.xml +++ b/reference/imagick/imagick/newimage.xml @@ -1,6 +1,6 @@ - + Imagick::newImage Creates a new image @@ -15,9 +15,9 @@ mixedbackground stringformat - + Creates a new image and associates ImagickPixel value as background color - + @@ -27,33 +27,33 @@ cols - + Columns in the new image - + rows - + Rows in the new image - + background - + The background color used for this image - + format - + Image format. This parameter was added in Imagick version 2.0.1. - + @@ -62,16 +62,16 @@ &reftitle.returnvalues; - + &imagick.return.success; - + &reftitle.errors; - + &imagick.imagick.throws; - + @@ -104,9 +104,9 @@ Using <function>Imagick::newImage</function>: - + Create a new image and display it. - + - + Imagick::newPseudoImage Creates a new image @@ -14,9 +14,9 @@ introws stringpseudoString - + Creates a new image using ImageMagick pseudo-formats. - + @@ -26,25 +26,25 @@ columns - + columns in the new image - + rows - + rows in the new image - + pseudoString - + string containing pseudo image definition. - + @@ -53,16 +53,16 @@ &reftitle.returnvalues; - + &imagick.return.success; - + &reftitle.errors; - + &imagick.imagick.throws; - + diff --git a/reference/imagick/imagick/nextimage.xml b/reference/imagick/imagick/nextimage.xml index b46311aa8..5467f9e9f 100644 --- a/reference/imagick/imagick/nextimage.xml +++ b/reference/imagick/imagick/nextimage.xml @@ -1,6 +1,6 @@ - + Imagick::nextImage Moves to the next image @@ -12,9 +12,9 @@ public boolImagick::nextImage - + Associates the next image in the image list with an Imagick object. - + @@ -24,9 +24,9 @@ &reftitle.returnvalues; - + &imagick.return.success; - + diff --git a/reference/imagick/imagick/normalizeimage.xml b/reference/imagick/imagick/normalizeimage.xml index f79e5bc80..a44b51718 100644 --- a/reference/imagick/imagick/normalizeimage.xml +++ b/reference/imagick/imagick/normalizeimage.xml @@ -1,6 +1,6 @@ - + Imagick::normalizeImage Enhances the contrast of a color image @@ -12,10 +12,10 @@ public boolImagick::normalizeImage intchannelImagick::CHANNEL_DEFAULT - + Enhances the contrast of a color image by adjusting the pixels color to span the entire range of colors available. - + @@ -25,12 +25,12 @@ channel - + Provide any channel constant that is valid for your channel mode. To apply to more than one channel, combine channeltype constants using bitwise operators. Refer to this list of channel constants. - + @@ -39,9 +39,9 @@ &reftitle.returnvalues; - + &imagick.return.success; - + diff --git a/reference/imagick/imagick/oilpaintimage.xml b/reference/imagick/imagick/oilpaintimage.xml index 00eeada71..b2ba7ed1f 100644 --- a/reference/imagick/imagick/oilpaintimage.xml +++ b/reference/imagick/imagick/oilpaintimage.xml @@ -1,6 +1,6 @@ - + Imagick::oilPaintImage Simulates an oil painting @@ -12,11 +12,11 @@ public boolImagick::oilPaintImage floatradius - + Applies a special effect filter that simulates an oil painting. Each pixel is replaced by the most frequent color occurring in a circular region defined by radius. - + @@ -26,9 +26,9 @@ radius - + The radius of the circular neighborhood. - + @@ -37,9 +37,9 @@ &reftitle.returnvalues; - + &imagick.return.success; - + diff --git a/reference/imagick/imagick/opaquepaintimage.xml b/reference/imagick/imagick/opaquepaintimage.xml index 1edffcfc2..c594c51fe 100644 --- a/reference/imagick/imagick/opaquepaintimage.xml +++ b/reference/imagick/imagick/opaquepaintimage.xml @@ -1,6 +1,6 @@ - + Imagick::opaquePaintImage Changes the color value of any pixel that matches target @@ -17,10 +17,10 @@ intchannelImagick::CHANNEL_DEFAULT - + Changes any pixel that matches color with the color defined by fill. &imagick.method.available.0x638; - + @@ -30,41 +30,41 @@ target - + ImagickPixel object or a string containing the color to change - + fill - + The replacement color - + fuzz - + &imagick.parameter.fuzz; - + invert - + If &true; paints any pixel that does not match the target color. - + channel - + &imagick.parameter.channel; - + @@ -73,9 +73,9 @@ &reftitle.returnvalues; - + &imagick.return.success; - + diff --git a/reference/imagick/imagick/optimizeimagelayers.xml b/reference/imagick/imagick/optimizeimagelayers.xml index 860ee74d0..cdfce85c6 100644 --- a/reference/imagick/imagick/optimizeimagelayers.xml +++ b/reference/imagick/imagick/optimizeimagelayers.xml @@ -1,6 +1,6 @@ - + Imagick::optimizeImageLayers Removes repeated portions of images to optimize @@ -13,13 +13,13 @@ - + Compares each image the GIF disposed forms of the previous image in the sequence. From this it attempts to select the smallest cropped image to replace each frame, while preserving the results - of the animation. + of the animation. &imagick.method.available.0x629; - + @@ -29,16 +29,16 @@ &reftitle.returnvalues; - + &imagick.return.success; - + &reftitle.errors; - + &imagick.imagick.throws; - + @@ -46,9 +46,9 @@ Using <function>Imagick::optimizeImageLayers</function> - + Reading, optimizing and writing a GIF image - + - + Imagick::orderedPosterizeImage Performs an ordered dither @@ -18,11 +18,11 @@ intchannelImagick::CHANNEL_DEFAULT - - Performs an ordered dither based on a number of pre-defined dithering threshold maps, - but over multiple intensity levels, which can be different for different channels, + + Performs an ordered dither based on a number of pre-defined dithering threshold maps, + but over multiple intensity levels, which can be different for different channels, according to the input arguments. &imagick.method.available.0x631; - + @@ -32,20 +32,20 @@ threshold_map - + A string containing the name of the threshold dither map to use - + channel - + Provide any channel constant that is valid for your channel mode. To apply to more than one channel, combine channeltype constants using bitwise operators. Refer to this list of channel constants. - + @@ -54,16 +54,16 @@ &reftitle.returnvalues; - + &imagick.return.success; - + &reftitle.errors; - + &imagick.imagick.throws; - + @@ -78,11 +78,11 @@ orderedPosterizeImage($orderedPosterizeType); $imagick->setImageFormat('png'); - + header("Content-Type: image/png"); echo $imagick->getImageBlob(); } diff --git a/reference/imagick/imagick/paintfloodfillimage.xml b/reference/imagick/imagick/paintfloodfillimage.xml index b0a5c503b..67a4550bc 100644 --- a/reference/imagick/imagick/paintfloodfillimage.xml +++ b/reference/imagick/imagick/paintfloodfillimage.xml @@ -1,6 +1,6 @@ - + Imagick::paintFloodfillImage Changes the color value of any pixel that matches target @@ -22,11 +22,11 @@ intchannelImagick::CHANNEL_DEFAULT - + Changes the color value of any pixel that matches target and is an immediate neighbor. As of ImageMagick 6.3.8 this method has been deprecated and Imagick::floodfillPaintImage should be used instead. - + @@ -36,51 +36,51 @@ fill - + ImagickPixel object or a string containing the fill color - + fuzz - + The amount of fuzz. For example, set fuzz to 10 and the color red at intensities of 100 and 102 respectively are now interpreted as the same color for the purposes of the floodfill. - + bordercolor - + ImagickPixel object or a string containing the border color - + x - + X start position of the floodfill - + y - + Y start position of the floodfill - + channel - + &imagick.parameter.channel; - + @@ -89,9 +89,9 @@ &reftitle.returnvalues; - + &imagick.return.success; - + diff --git a/reference/imagick/imagick/paintopaqueimage.xml b/reference/imagick/imagick/paintopaqueimage.xml index 69ab54588..7852d38ee 100644 --- a/reference/imagick/imagick/paintopaqueimage.xml +++ b/reference/imagick/imagick/paintopaqueimage.xml @@ -1,6 +1,6 @@ - + Imagick::paintOpaqueImage Change any pixel that matches color @@ -19,9 +19,9 @@ floatfuzz intchannelImagick::CHANNEL_DEFAULT - + Changes any pixel that matches color with the color defined by fill. - + @@ -31,38 +31,38 @@ target - + Change this target color to the fill color within the image. An ImagickPixel object or a string representing the target color. - + fill - + An ImagickPixel object or a string representing the fill color. - + fuzz - + The fuzz member of image defines how much tolerance is acceptable to consider two colors as the same. - + channel - + Provide any channel constant that is valid for your channel mode. To apply to more than one channel, combine channeltype constants using bitwise operators. Refer to this list of channel constants. - + @@ -71,16 +71,16 @@ &reftitle.returnvalues; - + &imagick.return.success; - + &reftitle.errors; - + &imagick.imagick.throws; - + diff --git a/reference/imagick/imagick/painttransparentimage.xml b/reference/imagick/imagick/painttransparentimage.xml index a3d4c9a2a..ff4f6615c 100644 --- a/reference/imagick/imagick/painttransparentimage.xml +++ b/reference/imagick/imagick/painttransparentimage.xml @@ -1,6 +1,6 @@ - + Imagick::paintTransparentImage Changes any pixel that matches color with the color defined by fill @@ -18,9 +18,9 @@ floatalpha floatfuzz - + Changes any pixel that matches color with the color defined by fill. - + @@ -30,27 +30,27 @@ target - + Change this target color to specified opacity value within the image. - + alpha - - The level of transparency: 1.0 is fully opaque and 0.0 is fully + + The level of transparency: 1.0 is fully opaque and 0.0 is fully transparent. - + fuzz - + The fuzz member of image defines how much tolerance is acceptable to consider two colors as the same. - + @@ -59,16 +59,16 @@ &reftitle.returnvalues; - + &imagick.return.success; - + &reftitle.errors; - + &imagick.imagick.throws; - + diff --git a/reference/imagick/imagick/pingimage.xml b/reference/imagick/imagick/pingimage.xml index 317c11c38..6c8e2727a 100644 --- a/reference/imagick/imagick/pingimage.xml +++ b/reference/imagick/imagick/pingimage.xml @@ -1,6 +1,6 @@ - + Imagick::pingImage Fetch basic attributes about the image @@ -12,10 +12,10 @@ public boolImagick::pingImage stringfilename - + This method can be used to query image width, height, size, and format without reading the whole image in to memory. - + @@ -25,9 +25,9 @@ filename - + The filename to read the information from. - + @@ -36,9 +36,9 @@ &reftitle.returnvalues; - + &imagick.return.success; - + diff --git a/reference/imagick/imagick/pingimageblob.xml b/reference/imagick/imagick/pingimageblob.xml index 3c8275140..65902b4d3 100644 --- a/reference/imagick/imagick/pingimageblob.xml +++ b/reference/imagick/imagick/pingimageblob.xml @@ -1,6 +1,6 @@ - + Imagick::pingImageBlob Quickly fetch attributes @@ -13,11 +13,11 @@ stringimage - + This method can be used to query image width, height, size, and - format without reading the whole image to memory. + format without reading the whole image to memory. &imagick.method.available.0x629; - + @@ -27,9 +27,9 @@ image - + A string containing the image. - + @@ -38,9 +38,9 @@ &reftitle.returnvalues; - + &imagick.return.success; - + @@ -48,9 +48,9 @@ Using <function>Imagick::pingImageBlob</function> - + Pinging an image from a string - + - + Imagick::pingImageFile Get basic image attributes in a lightweight manner @@ -14,11 +14,11 @@ stringfileName - + This method can be used to query image width, height, size, and - format without reading the whole image to memory. + format without reading the whole image to memory. &imagick.method.available.0x629; - + @@ -28,17 +28,17 @@ filehandle - + An open filehandle to the image. - + fileName - + Optional filename for this image. - + @@ -47,9 +47,9 @@ &reftitle.returnvalues; - + &imagick.return.success; - + @@ -57,9 +57,9 @@ Using <function>Imagick::pingImageFile</function> - + Opening a remote location - + - + Imagick::polaroidImage Simulates a Polaroid picture @@ -14,9 +14,9 @@ floatangle - + Simulates a Polaroid picture. &imagick.method.available.0x632; - + @@ -26,17 +26,17 @@ properties - + The polaroid properties - + angle - + The polaroid angle - + @@ -45,9 +45,9 @@ &reftitle.returnvalues; - + &imagick.return.success; - + @@ -55,9 +55,9 @@ A <function>Imagick::polaroidImage</function> example - + An example of using Imagick::polaroidImage() - + - + Imagick::posterizeImage Reduces the image to a limited number of color level @@ -13,9 +13,9 @@ intlevels booldither - + Reduces the image to a limited number of color level. - + @@ -25,15 +25,15 @@ levels - - + + dither - - + + @@ -42,9 +42,9 @@ &reftitle.returnvalues; - + &imagick.return.success; - + diff --git a/reference/imagick/imagick/previewimages.xml b/reference/imagick/imagick/previewimages.xml index e04425a2f..6461387ee 100644 --- a/reference/imagick/imagick/previewimages.xml +++ b/reference/imagick/imagick/previewimages.xml @@ -1,6 +1,6 @@ - + Imagick::previewImages Quickly pin-point appropriate parameters for image processing @@ -12,11 +12,11 @@ public boolImagick::previewImages intpreview - + Tiles 9 thumbnails of the specified image with an image processing operation applied at varying strengths. This is helpful to quickly pin-point an appropriate parameter for an image processing operation. - + @@ -26,9 +26,9 @@ preview - + Preview type. See Preview type constants - + @@ -37,16 +37,16 @@ &reftitle.returnvalues; - + &imagick.return.success; - + &reftitle.errors; - + &imagick.imagick.throws; - + diff --git a/reference/imagick/imagick/previousimage.xml b/reference/imagick/imagick/previousimage.xml index 88a79f871..af0ed50aa 100644 --- a/reference/imagick/imagick/previousimage.xml +++ b/reference/imagick/imagick/previousimage.xml @@ -1,6 +1,6 @@ - + Imagick::previousImage Move to the previous image in the object @@ -12,9 +12,9 @@ public boolImagick::previousImage - + Associates the previous image in an image list with the Imagick object. - + @@ -24,9 +24,9 @@ &reftitle.returnvalues; - + &imagick.return.success; - + diff --git a/reference/imagick/imagick/profileimage.xml b/reference/imagick/imagick/profileimage.xml index 92d5ede99..57e8c8d1e 100644 --- a/reference/imagick/imagick/profileimage.xml +++ b/reference/imagick/imagick/profileimage.xml @@ -1,6 +1,6 @@ - + Imagick::profileImage Adds or removes a profile from an image @@ -53,16 +53,16 @@ &reftitle.returnvalues; - + &imagick.return.success; - + &reftitle.errors; - + &imagick.imagick.throws; - + diff --git a/reference/imagick/imagick/quantizeimage.xml b/reference/imagick/imagick/quantizeimage.xml index 82cf4a5cc..3624e78c4 100644 --- a/reference/imagick/imagick/quantizeimage.xml +++ b/reference/imagick/imagick/quantizeimage.xml @@ -1,6 +1,6 @@ - + Imagick::quantizeImage Analyzes the colors within a reference image @@ -25,36 +25,36 @@ numberColors - - + + colorspace - - + + treedepth - - + + dither - - + + measureError - - + + @@ -63,16 +63,16 @@ &reftitle.returnvalues; - + &imagick.return.success; - + &reftitle.errors; - + &imagick.imagick.throws; - + diff --git a/reference/imagick/imagick/quantizeimages.xml b/reference/imagick/imagick/quantizeimages.xml index a328c2f16..11533825f 100644 --- a/reference/imagick/imagick/quantizeimages.xml +++ b/reference/imagick/imagick/quantizeimages.xml @@ -1,6 +1,6 @@ - + Imagick::quantizeImages Analyzes the colors within a sequence of images @@ -25,36 +25,36 @@ numberColors - - + + colorspace - - + + treedepth - - + + dither - - + + measureError - - + + @@ -63,16 +63,16 @@ &reftitle.returnvalues; - + &imagick.return.success; - + &reftitle.errors; - + &imagick.imagick.throws; - + diff --git a/reference/imagick/imagick/queryfontmetrics.xml b/reference/imagick/imagick/queryfontmetrics.xml index 99a8a31f9..0af319070 100644 --- a/reference/imagick/imagick/queryfontmetrics.xml +++ b/reference/imagick/imagick/queryfontmetrics.xml @@ -1,11 +1,11 @@ - + Imagick::queryFontMetrics Returns an array representing the font metrics - + &reftitle.description; @@ -14,11 +14,11 @@ stringtext boolmultiline - + Returns a multi-dimensional array representing the font metrics. - + - + &reftitle.parameters; @@ -26,54 +26,54 @@ properties - + ImagickDraw object containing font properties - + text - + The text - + multiline - + Multiline parameter. If left empty it is autodetected - + - + - + &reftitle.returnvalues; - + Returns a multi-dimensional array representing the font metrics. - + &reftitle.errors; - + &imagick.imagick.throws; - + - + &reftitle.examples; Using <function>Imagick::queryFontMetrics</function>: - + Query the metrics for the text and dump the results on the screen. - + queryFontMetrics($draw, "Hello World!")); - + - + Imagick::queryFonts Returns the configured fonts - + &reftitle.description; public static arrayImagick::queryFonts stringpattern"*" - + Returns the configured fonts. - + - + &reftitle.parameters; @@ -24,29 +24,29 @@ pattern - + The query pattern - + - + &reftitle.returnvalues; - + Returns an array containing the configured fonts. - + &reftitle.errors; - + &imagick.imagick.throws; - + - + @@ -61,7 +61,7 @@ $output .= "Fonts that match 'Helvetica*' are:
"; $fontList = \Imagick::queryFonts("Helvetica*"); - + foreach ($fontList as $fontName) { $output .= '
  • '. $fontName."
    • "; } diff --git a/reference/imagick/imagick/queryformats.xml b/reference/imagick/imagick/queryformats.xml index dc9a035f3..ee88ff7a5 100644 --- a/reference/imagick/imagick/queryformats.xml +++ b/reference/imagick/imagick/queryformats.xml @@ -1,6 +1,6 @@ - + Imagick::queryFormats Returns formats supported by Imagick @@ -12,9 +12,9 @@ public static arrayImagick::queryFormats stringpattern"*" - + Returns formats supported by Imagick. - +     @@ -24,8 +24,8 @@ pattern - - + + @@ -34,16 +34,16 @@ &reftitle.returnvalues; - + Returns an array containing the formats supported by Imagick. - + &reftitle.errors; - + &imagick.imagick.throws; - + diff --git a/reference/imagick/imagick/radialblurimage.xml b/reference/imagick/imagick/radialblurimage.xml index 748ff7ee9..6314586e9 100644 --- a/reference/imagick/imagick/radialblurimage.xml +++ b/reference/imagick/imagick/radialblurimage.xml @@ -1,6 +1,6 @@ - + Imagick::radialBlurImage Radial blurs an image @@ -17,9 +17,9 @@ floatangle intchannelImagick::CHANNEL_DEFAULT - + Radial blurs an image. - + @@ -29,15 +29,15 @@ angle - - + + channel - - + + @@ -46,9 +46,9 @@ &reftitle.returnvalues; - + &imagick.return.success; - + diff --git a/reference/imagick/imagick/raiseimage.xml b/reference/imagick/imagick/raiseimage.xml index 7a9103775..b524fe7d8 100644 --- a/reference/imagick/imagick/raiseimage.xml +++ b/reference/imagick/imagick/raiseimage.xml @@ -1,6 +1,6 @@ - + Imagick::raiseImage Creates a simulated 3d button-like effect @@ -16,12 +16,12 @@ inty boolraise - + Creates a simulated three-dimensional button-like effect by lightening and darkening the edges of the image. Members width and height of raise_info define the width of the vertical and horizontal edge of the effect. - + @@ -31,36 +31,36 @@ width - - + + height - - + + x - - + + y - - + + raise - - + + @@ -69,9 +69,9 @@ &reftitle.returnvalues; - + &imagick.return.success; - + diff --git a/reference/imagick/imagick/randomthresholdimage.xml b/reference/imagick/imagick/randomthresholdimage.xml index 600e9b682..6691ec15a 100644 --- a/reference/imagick/imagick/randomthresholdimage.xml +++ b/reference/imagick/imagick/randomthresholdimage.xml @@ -1,6 +1,6 @@ - + Imagick::randomThresholdImage Creates a high-contrast, two-color image @@ -15,11 +15,11 @@ intchannelImagick::CHANNEL_DEFAULT - + Changes the value of individual pixels based on the intensity of each pixel compared to threshold. The result is a high-contrast, two color image. &imagick.method.available.0x629; - + @@ -29,28 +29,28 @@ low - + The low point - + high - + The high point - + channel - + Provide any channel constant that is valid for your channel mode. To apply to more than one channel, combine channeltype constants using bitwise operators. Refer to this list of channel constants. - + @@ -59,9 +59,9 @@ &reftitle.returnvalues; - + &imagick.return.success; - + diff --git a/reference/imagick/imagick/readimage.xml b/reference/imagick/imagick/readimage.xml index 7a3cc0d29..803dc5a7e 100644 --- a/reference/imagick/imagick/readimage.xml +++ b/reference/imagick/imagick/readimage.xml @@ -1,6 +1,6 @@ - + Imagick::readImage Reads image from filename @@ -12,9 +12,9 @@ public boolImagick::readImage stringfilename - + Reads image from filename - + @@ -24,8 +24,8 @@ filename - - + + @@ -34,9 +34,9 @@ &reftitle.returnvalues; - + &imagick.return.success; - +     diff --git a/reference/imagick/imagick/readimageblob.xml b/reference/imagick/imagick/readimageblob.xml index bbbc8296e..24d563c13 100644 --- a/reference/imagick/imagick/readimageblob.xml +++ b/reference/imagick/imagick/readimageblob.xml @@ -1,6 +1,6 @@ - + Imagick::readImageBlob Reads image from a binary string @@ -13,9 +13,9 @@ stringimage stringfilename - + Reads image from a binary string - + @@ -25,8 +25,8 @@ image - - + + @@ -35,16 +35,16 @@ &reftitle.returnvalues; - + &imagick.return.success; - + &reftitle.errors; - + &imagick.imagick.throws; - + diff --git a/reference/imagick/imagick/readimagefile.xml b/reference/imagick/imagick/readimagefile.xml index 0e1fd81f5..facfd6f66 100644 --- a/reference/imagick/imagick/readimagefile.xml +++ b/reference/imagick/imagick/readimagefile.xml @@ -1,6 +1,6 @@ - + Imagick::readImageFile Reads image from open filehandle @@ -13,9 +13,9 @@ resourcefilehandle stringfileName&null; - + Reads image from open filehandle - + @@ -25,15 +25,15 @@ filehandle - - + + fileName - - + + @@ -42,16 +42,16 @@ &reftitle.returnvalues; - + &imagick.return.success; - + &reftitle.errors; - + &imagick.imagick.throws; - + diff --git a/reference/imagick/imagick/readimages.xml b/reference/imagick/imagick/readimages.xml index 03c77443a..98ced85fa 100644 --- a/reference/imagick/imagick/readimages.xml +++ b/reference/imagick/imagick/readimages.xml @@ -13,9 +13,9 @@ public boolImagick::readImages arrayfilenames - + Reads image from an array of filenames. All the images are held in a single Imagick object. - + @@ -26,9 +26,9 @@ filenames - - - + + + @@ -36,9 +36,9 @@ &reftitle.returnvalues; - + &imagick.return.success; - + diff --git a/reference/imagick/imagick/recolorimage.xml b/reference/imagick/imagick/recolorimage.xml index e5c939cac..134ff1a7a 100644 --- a/reference/imagick/imagick/recolorimage.xml +++ b/reference/imagick/imagick/recolorimage.xml @@ -1,6 +1,6 @@ - + Imagick::recolorImage Recolors image @@ -17,11 +17,11 @@ arraymatrix - + Translate, scale, shear, or rotate image colors. This method supports variable sized matrices but normally 5x5 matrix is used for RGBA and 6x6 is used for CMYK. The last row should contain the normalized values. &imagick.method.available.0x636; - + @@ -31,9 +31,9 @@ matrix - + The matrix containing the color values - + @@ -42,9 +42,9 @@ &reftitle.returnvalues; - + &imagick.return.success; - + @@ -88,7 +88,7 @@ function recolorImage($imagePath) { - + - + Imagick::reduceNoiseImage Smooths the contours of an image @@ -16,13 +16,13 @@ public boolImagick::reduceNoiseImage floatradius - + Smooths the contours of an image while still preserving edge information. The algorithm works by replacing each pixel with its neighbor closest in value. A neighbor is defined by radius. Use a radius of 0 and Imagick::reduceNoiseImage() selects a suitable radius for you. - + @@ -32,8 +32,8 @@ radius - - + + @@ -42,16 +42,16 @@ &reftitle.returnvalues; - + &imagick.return.success; - + &reftitle.errors; - + &imagick.imagick.throws; - + diff --git a/reference/imagick/imagick/remapimage.xml b/reference/imagick/imagick/remapimage.xml index cf49236b5..e592ecff7 100644 --- a/reference/imagick/imagick/remapimage.xml +++ b/reference/imagick/imagick/remapimage.xml @@ -14,10 +14,10 @@ Imagickreplacement intDITHER - + Replaces colors an image with those defined by replacement. The colors are replaced with the closest possible color. &imagick.method.available.0x645; - + @@ -27,17 +27,17 @@ replacement - + An Imagick object containing the replacement colors - + DITHER - + Refer to this list of dither method constants - + @@ -46,16 +46,16 @@ &reftitle.returnvalues; - + &imagick.return.success; - + &reftitle.errors; - + &imagick.imagick.throws; - + diff --git a/reference/imagick/imagick/removeimage.xml b/reference/imagick/imagick/removeimage.xml index 1c35b7fa5..411fedadc 100644 --- a/reference/imagick/imagick/removeimage.xml +++ b/reference/imagick/imagick/removeimage.xml @@ -1,6 +1,6 @@ - + Imagick::removeImage Removes an image from the image list @@ -12,9 +12,9 @@ public boolImagick::removeImage - + Removes an image from the image list. - + @@ -24,16 +24,16 @@ &reftitle.returnvalues; - + &imagick.return.success; - + &reftitle.errors; - + &imagick.imagick.throws; - + diff --git a/reference/imagick/imagick/removeimageprofile.xml b/reference/imagick/imagick/removeimageprofile.xml index 361b84737..a4a53c94d 100644 --- a/reference/imagick/imagick/removeimageprofile.xml +++ b/reference/imagick/imagick/removeimageprofile.xml @@ -1,6 +1,6 @@ - + Imagick::removeImageProfile Removes the named image profile and returns it @@ -12,9 +12,9 @@ public stringImagick::removeImageProfile stringname - + Removes the named image profile and returns it. - + @@ -24,8 +24,8 @@ name - - + + @@ -34,16 +34,16 @@ &reftitle.returnvalues; - + Returns a string containing the profile of the image. - + &reftitle.errors; - + &imagick.imagick.throws; - + diff --git a/reference/imagick/imagick/render.xml b/reference/imagick/imagick/render.xml index b3ca8356c..52d1faba4 100644 --- a/reference/imagick/imagick/render.xml +++ b/reference/imagick/imagick/render.xml @@ -1,6 +1,6 @@ - + Imagick::render Renders all preceding drawing commands @@ -12,9 +12,9 @@ public boolImagick::render - + Renders all preceding drawing commands. - + @@ -24,9 +24,9 @@ &reftitle.returnvalues; - + &imagick.return.success; - + diff --git a/reference/imagick/imagick/resampleimage.xml b/reference/imagick/imagick/resampleimage.xml index c70e3795f..9043c1758 100644 --- a/reference/imagick/imagick/resampleimage.xml +++ b/reference/imagick/imagick/resampleimage.xml @@ -1,6 +1,6 @@ - + Imagick::resampleImage Resample image to desired resolution @@ -15,9 +15,9 @@ intfilter floatblur - + Resample image to desired resolution. - + @@ -27,29 +27,29 @@ x_resolution - - + + y_resolution - - + + filter - - + + blur - - + + @@ -58,9 +58,9 @@ &reftitle.returnvalues; - + &imagick.return.success; - + diff --git a/reference/imagick/imagick/resetimagepage.xml b/reference/imagick/imagick/resetimagepage.xml index 8571a06e5..8cda7196b 100644 --- a/reference/imagick/imagick/resetimagepage.xml +++ b/reference/imagick/imagick/resetimagepage.xml @@ -1,6 +1,6 @@ - + Imagick::resetImagePage Reset image page @@ -13,10 +13,10 @@ stringpage - + The page definition as a string. The string is in format WxH+x+y. &imagick.method.available.0x636; - + @@ -26,9 +26,9 @@ page - + The page definition. For example 7168x5147+0+0 - + @@ -37,9 +37,9 @@ &reftitle.returnvalues; - + &imagick.return.success; - + diff --git a/reference/imagick/imagick/resizeimage.xml b/reference/imagick/imagick/resizeimage.xml index 684a194da..572fef13f 100644 --- a/reference/imagick/imagick/resizeimage.xml +++ b/reference/imagick/imagick/resizeimage.xml @@ -17,10 +17,10 @@ boolbestfit&false; boollegacy&false; - + Scales an image to the desired dimensions with a filter. - + &imagick.bestfit.note; @@ -31,33 +31,33 @@ columns - + Width of the image - + rows - + Height of the image - + filter - + Refer to the list of filter constants. - + blur - + The blur factor where > 1 is blurry, < 1 is sharp. - + @@ -88,9 +88,9 @@ &reftitle.returnvalues; - + &imagick.return.success; - + diff --git a/reference/imagick/imagick/rollimage.xml b/reference/imagick/imagick/rollimage.xml index 56cda4d77..4a7ffd3aa 100644 --- a/reference/imagick/imagick/rollimage.xml +++ b/reference/imagick/imagick/rollimage.xml @@ -1,6 +1,6 @@ - + Imagick::rollImage Offsets an image @@ -13,9 +13,9 @@ intx inty - + Offsets an image as defined by x and y. - + @@ -25,17 +25,17 @@ x - + The X offset. - + y - + The Y offset. - + @@ -44,9 +44,9 @@ &reftitle.returnvalues; - + &imagick.return.success; - + diff --git a/reference/imagick/imagick/rotateimage.xml b/reference/imagick/imagick/rotateimage.xml index 941d01038..07e5de6b6 100644 --- a/reference/imagick/imagick/rotateimage.xml +++ b/reference/imagick/imagick/rotateimage.xml @@ -1,6 +1,6 @@ - + Imagick::rotateImage Rotates an image @@ -13,11 +13,11 @@ mixedbackground floatdegrees - + Rotates an image the specified number of degrees. Empty triangles left over from rotating the image are filled with the background color. - + @@ -27,18 +27,18 @@ background - + The background color - + degrees - + Rotation angle, in degrees. The rotation angle is interpreted as the number of degrees to rotate the image clockwise. - + @@ -47,9 +47,9 @@ &reftitle.returnvalues; - + &imagick.return.success; - + diff --git a/reference/imagick/imagick/rotationalblurimage.xml b/reference/imagick/imagick/rotationalblurimage.xml index 78b1903cb..d0503dadf 100644 --- a/reference/imagick/imagick/rotationalblurimage.xml +++ b/reference/imagick/imagick/rotationalblurimage.xml @@ -14,9 +14,9 @@ floatangle intchannelImagick::CHANNEL_DEFAULT - + Rotational blurs an image. - + @@ -27,17 +27,17 @@ angle - + The angle to apply the blur over. - + channel - + &imagick.parameter.channel; - + @@ -45,9 +45,9 @@ &reftitle.returnvalues; - + &imagick.return.success; - + diff --git a/reference/imagick/imagick/roundcorners.xml b/reference/imagick/imagick/roundcorners.xml index a1feaee6a..cad0f34ac 100644 --- a/reference/imagick/imagick/roundcorners.xml +++ b/reference/imagick/imagick/roundcorners.xml @@ -1,6 +1,6 @@ - + Imagick::roundCorners Rounds image corners @@ -16,16 +16,16 @@ public boolImagick::roundCorners floatx_rounding floaty_rounding - floatstroke_width10 - floatdisplace5 - floatsize_correction-6 + floatstroke_width10 + floatdisplace5 + floatsize_correction-6 - - Rounds image corners. The first two parameters control the amount - of rounding and the three last parameters can be used to fine-tune + + Rounds image corners. The first two parameters control the amount + of rounding and the three last parameters can be used to fine-tune the rounding process. &imagick.method.available.0x629; &imagick.method.not.available.0x700; - + @@ -35,41 +35,41 @@ x_rounding - + x rounding - + y_rounding - + y rounding - + stroke_width - + stroke width - + displace - + image displace - + size_correction - + size correction - + @@ -79,9 +79,9 @@ &reftitle.returnvalues; - + &imagick.return.success; - + @@ -89,9 +89,9 @@ Using <function>Imagick::roundCorners</function>: - + Rounds the image corners - + - + Imagick::sampleImage Scales an image with pixel sampling @@ -13,11 +13,11 @@ intcolumns introws - + Scales an image to the desired dimensions with pixel sampling. Unlike other scaling methods, this method does not introduce any additional color into the scaled image. - + @@ -27,15 +27,15 @@ columns - - + + rows - - + + @@ -44,9 +44,9 @@ &reftitle.returnvalues; - + &imagick.return.success; - + diff --git a/reference/imagick/imagick/scaleimage.xml b/reference/imagick/imagick/scaleimage.xml index 3e1e3ef59..2413f1ae5 100644 --- a/reference/imagick/imagick/scaleimage.xml +++ b/reference/imagick/imagick/scaleimage.xml @@ -15,10 +15,10 @@ boolbestfit&false; boollegacy&false; - + Scales the size of an image to the given dimensions. The other parameter will be calculated if 0 is passed as either param. - + &imagick.bestfit.note; @@ -68,16 +68,16 @@ &reftitle.returnvalues; - + &imagick.return.success; - + &reftitle.errors; - + &imagick.imagick.throws; - + diff --git a/reference/imagick/imagick/segmentimage.xml b/reference/imagick/imagick/segmentimage.xml index fed4e2330..02bad20d0 100644 --- a/reference/imagick/imagick/segmentimage.xml +++ b/reference/imagick/imagick/segmentimage.xml @@ -16,9 +16,9 @@ floatsmooth_threshold boolverbose&false; - + Analyses the image and identifies units that are similar. &imagick.method.available.0x645; - + @@ -28,34 +28,34 @@ COLORSPACE - + One of the COLORSPACE constants. - + cluster_threshold - - A percentage describing minimum number of pixels + + A percentage describing minimum number of pixels contained in hexedra before it is considered valid. - + smooth_threshold - + Eliminates noise from the histogram. - + verbose - + Whether to output detailed information about recognised classes. - + @@ -64,9 +64,9 @@ &reftitle.returnvalues; - + - + diff --git a/reference/imagick/imagick/selectiveblurimage.xml b/reference/imagick/imagick/selectiveblurimage.xml index 4c5332a3e..0f0e31bcf 100644 --- a/reference/imagick/imagick/selectiveblurimage.xml +++ b/reference/imagick/imagick/selectiveblurimage.xml @@ -16,9 +16,9 @@ floatthreshold intchannelImagick::CHANNEL_DEFAULT - + Selectively blur an image within a contrast threshold. It is similar to the unsharpen mask that sharpens everything with contrast above a certain threshold. - + @@ -29,33 +29,33 @@ radius - - - + + + sigma - - - + + + threshold - - - + + + channel - + &imagick.parameter.channel; - + @@ -63,9 +63,9 @@ &reftitle.returnvalues; - + &imagick.return.success; - + diff --git a/reference/imagick/imagick/separateimagechannel.xml b/reference/imagick/imagick/separateimagechannel.xml index ec9606d4a..b80ae98ba 100644 --- a/reference/imagick/imagick/separateimagechannel.xml +++ b/reference/imagick/imagick/separateimagechannel.xml @@ -1,6 +1,6 @@ - + Imagick::separateImageChannel Separates a channel from the image @@ -12,10 +12,10 @@ public boolImagick::separateImageChannel intchannel - + Separates a channel from the image and returns a grayscale image. A channel is a particular color component of each pixel in the image. - + @@ -25,9 +25,9 @@ channel - + Which 'channel' to return. For colorspaces other than RGB, you can still use the CHANNEL_RED, CHANNEL_GREEN, CHANNEL_BLUE constants to indicate the 1st, 2nd and 3rd channels. - + @@ -36,16 +36,16 @@ &reftitle.returnvalues; - + &imagick.return.success; - + &reftitle.errors; - + &imagick.imagick.throws; - + diff --git a/reference/imagick/imagick/sepiatoneimage.xml b/reference/imagick/imagick/sepiatoneimage.xml index 882814be8..16970ea48 100644 --- a/reference/imagick/imagick/sepiatoneimage.xml +++ b/reference/imagick/imagick/sepiatoneimage.xml @@ -1,6 +1,6 @@ - + Imagick::sepiaToneImage Sepia tones an image @@ -12,12 +12,12 @@ public boolImagick::sepiaToneImage floatthreshold - + Applies a special effect to the image, similar to the effect achieved in a photo darkroom by sepia toning. Threshold ranges from 0 to QuantumRange and is a measure of the extent of the sepia toning. A threshold of 80 is a good starting point for a reasonable tone. - + @@ -27,8 +27,8 @@ threshold - - + + @@ -37,16 +37,16 @@ &reftitle.returnvalues; - + &imagick.return.success; - + &reftitle.errors; - + &imagick.imagick.throws; - + diff --git a/reference/imagick/imagick/setbackgroundcolor.xml b/reference/imagick/imagick/setbackgroundcolor.xml index 8a0a67634..91430dda3 100644 --- a/reference/imagick/imagick/setbackgroundcolor.xml +++ b/reference/imagick/imagick/setbackgroundcolor.xml @@ -1,6 +1,6 @@ - + Imagick::setBackgroundColor Sets the object's default background color @@ -12,9 +12,9 @@ public boolImagick::setBackgroundColor mixedbackground - + Sets the object's default background color. - + @@ -24,8 +24,8 @@ background - - + + @@ -34,9 +34,9 @@ &reftitle.returnvalues; - + &imagick.return.success; - + diff --git a/reference/imagick/imagick/setcolorspace.xml b/reference/imagick/imagick/setcolorspace.xml index 2e9860d32..8afa408a1 100644 --- a/reference/imagick/imagick/setcolorspace.xml +++ b/reference/imagick/imagick/setcolorspace.xml @@ -1,6 +1,6 @@ - + Imagick::setColorspace Set colorspace @@ -12,10 +12,10 @@ public boolImagick::setColorspace intCOLORSPACE - + Sets the global colorspace value for the object. &imagick.method.available.0x657; - + @@ -25,9 +25,9 @@ COLORSPACE - + One of the COLORSPACE constants - + @@ -36,16 +36,16 @@ &reftitle.returnvalues; - + &imagick.return.success; - + &reftitle.errors; - + &imagick.imagick.throws; - + diff --git a/reference/imagick/imagick/setcompression.xml b/reference/imagick/imagick/setcompression.xml index 8291334e7..31de1341e 100644 --- a/reference/imagick/imagick/setcompression.xml +++ b/reference/imagick/imagick/setcompression.xml @@ -1,6 +1,6 @@ - + Imagick::setCompression Sets the object's default compression type @@ -12,9 +12,9 @@ public boolImagick::setCompression intcompression - + Sets the object's default compression type - + @@ -24,9 +24,9 @@ compression - + The compression type. See the Imagick::COMPRESSION_* constants. - + @@ -35,9 +35,9 @@ &reftitle.returnvalues; - + &imagick.return.success; - + diff --git a/reference/imagick/imagick/setcompressionquality.xml b/reference/imagick/imagick/setcompressionquality.xml index 39bcd63b8..76ebeb081 100644 --- a/reference/imagick/imagick/setcompressionquality.xml +++ b/reference/imagick/imagick/setcompressionquality.xml @@ -1,6 +1,6 @@ - + Imagick::setCompressionQuality Sets the object's default compression quality @@ -12,16 +12,16 @@ public boolImagick::setCompressionQuality intquality - + Sets the object's default compression quality. - + - + This method only works for new images e.g. those created through Imagick::newPseudoImage. For existing images you should use Imagick::setImageCompressionQuality. - + - + @@ -31,9 +31,9 @@ quality - + An &integer; between 1 and 100, 1 = high compression, 100 low compression. - + @@ -42,9 +42,9 @@ &reftitle.returnvalues; - + &imagick.return.success; - + @@ -74,8 +74,8 @@ function setCompressionQuality($imagePath, $quality) { 0, 0 ); - - $imagick->setFormat("jpg"); + + $imagick->setFormat("jpg"); header("Content-Type: image/jpg"); echo $imagick->getImageBlob(); } diff --git a/reference/imagick/imagick/setfilename.xml b/reference/imagick/imagick/setfilename.xml index 8d573d56b..4a508a42d 100644 --- a/reference/imagick/imagick/setfilename.xml +++ b/reference/imagick/imagick/setfilename.xml @@ -1,6 +1,6 @@ - + Imagick::setFilename Sets the filename before you read or write the image @@ -12,9 +12,9 @@ public boolImagick::setFilename stringfilename - + Sets the filename before you read or write an image file. - + @@ -24,8 +24,8 @@ filename - - + + @@ -34,9 +34,9 @@ &reftitle.returnvalues; - + &imagick.return.success; - + diff --git a/reference/imagick/imagick/setfirstiterator.xml b/reference/imagick/imagick/setfirstiterator.xml index f3551a972..c134f1ffe 100644 --- a/reference/imagick/imagick/setfirstiterator.xml +++ b/reference/imagick/imagick/setfirstiterator.xml @@ -1,6 +1,6 @@ - + Imagick::setFirstIterator Sets the Imagick iterator to the first image @@ -12,9 +12,9 @@ public boolImagick::setFirstIterator - + Sets the Imagick iterator to the first image. - + @@ -24,9 +24,9 @@ &reftitle.returnvalues; - + &imagick.return.success; - + diff --git a/reference/imagick/imagick/setfont.xml b/reference/imagick/imagick/setfont.xml index e453e87e9..257acefe7 100644 --- a/reference/imagick/imagick/setfont.xml +++ b/reference/imagick/imagick/setfont.xml @@ -29,9 +29,9 @@ font - + Font name or a filename - + @@ -40,9 +40,9 @@ &reftitle.returnvalues; - + &imagick.return.success; - + @@ -50,9 +50,9 @@ A <function>Imagick::setFont</function> example - + Example of using Imagick::setFont - + - + Imagick::setFormat Sets the format of the Imagick object @@ -12,9 +12,9 @@ public boolImagick::setFormat stringformat - + Sets the format of the Imagick object. - + @@ -24,8 +24,8 @@ format - - + + @@ -34,9 +34,9 @@ &reftitle.returnvalues; - + &imagick.return.success; - + diff --git a/reference/imagick/imagick/setgravity.xml b/reference/imagick/imagick/setgravity.xml index 7965b8171..8ecd8a343 100644 --- a/reference/imagick/imagick/setgravity.xml +++ b/reference/imagick/imagick/setgravity.xml @@ -1,6 +1,6 @@ - + Imagick::setGravity Sets the gravity @@ -13,10 +13,10 @@ intgravity - + Sets the global gravity property for the Imagick object. &imagick.method.available.0x640; - + @@ -26,10 +26,10 @@ gravity - - The gravity property. Refer to the list of + + The gravity property. Refer to the list of gravity constants. - + @@ -38,9 +38,9 @@ &reftitle.returnvalues; - + &return.void; - + diff --git a/reference/imagick/imagick/setimage.xml b/reference/imagick/imagick/setimage.xml index 06564b40a..6d3f92d2b 100644 --- a/reference/imagick/imagick/setimage.xml +++ b/reference/imagick/imagick/setimage.xml @@ -1,6 +1,6 @@ - + Imagick::setImage Replaces image in the object @@ -12,9 +12,9 @@ public boolImagick::setImage Imagickreplace - + Replaces the current image sequence with the image from replace object. - + @@ -24,9 +24,9 @@ replace - + The replace Imagick object - + @@ -35,16 +35,16 @@ &reftitle.returnvalues; - + &imagick.return.success; - + &reftitle.errors; - + &imagick.imagick.throws; - + @@ -52,9 +52,9 @@ A <function>Imagick::setImage</function> example - + An example of using Imagick::setImage() - + - + Imagick::setImageAlphaChannel Sets image alpha channel @@ -12,11 +12,11 @@ public boolImagick::setImageAlphaChannel intmode - - Activate or deactivate image alpha channel. The mode + + Activate or deactivate image alpha channel. The mode is one of the Imagick::ALPHACHANNEL_* constants. &imagick.method.available.0x638; - + @@ -26,9 +26,9 @@ mode - + One of the Imagick::ALPHACHANNEL_* constants - + @@ -37,16 +37,16 @@ &reftitle.returnvalues; - + &imagick.return.success; - + &reftitle.errors; - + &imagick.imagick.throws; - + diff --git a/reference/imagick/imagick/setimageartifact.xml b/reference/imagick/imagick/setimageartifact.xml index 30b54d061..3ce20a4fc 100644 --- a/reference/imagick/imagick/setimageartifact.xml +++ b/reference/imagick/imagick/setimageartifact.xml @@ -1,6 +1,6 @@ - + Imagick::setImageArtifact Set image artifact @@ -13,11 +13,11 @@ stringartifact stringvalue - - Associates an artifact with the image. The difference between image properties and + + Associates an artifact with the image. The difference between image properties and image artifacts is that properties are public and artifacts are private. &imagick.method.available.0x657; - + @@ -27,17 +27,17 @@ artifact - + The name of the artifact - + value - + The value of the artifact - + @@ -46,16 +46,16 @@ &reftitle.returnvalues; - + &imagick.return.success; - + &reftitle.errors; - + &imagick.imagick.throws; - + @@ -74,7 +74,7 @@ function setImageArtifact() { $src2->setImageVirtualPixelMethod(\Imagick::VIRTUALPIXELMETHOD_TRANSPARENT); $src2->setImageArtifact('compose:args', "1,0,-0.5,0.5"); $src1->compositeImage($src2, Imagick::COMPOSITE_MATHEMATICS, 0, 0); - + $src1->setImageFormat('png'); header("Content-Type: image/png"); echo $src1->getImagesBlob(); diff --git a/reference/imagick/imagick/setimageattribute.xml b/reference/imagick/imagick/setimageattribute.xml index 23fe7c008..8856b73eb 100644 --- a/reference/imagick/imagick/setimageattribute.xml +++ b/reference/imagick/imagick/setimageattribute.xml @@ -18,9 +18,9 @@ stringkey stringvalue - + Sets an image attribute. - + @@ -30,17 +30,17 @@ key - - - + + + value - - - + + + @@ -48,9 +48,9 @@ &reftitle.returnvalues; - + &imagick.return.success; - + diff --git a/reference/imagick/imagick/setimagebackgroundcolor.xml b/reference/imagick/imagick/setimagebackgroundcolor.xml index dac83aad5..5df21c6d1 100644 --- a/reference/imagick/imagick/setimagebackgroundcolor.xml +++ b/reference/imagick/imagick/setimagebackgroundcolor.xml @@ -1,6 +1,6 @@ - + Imagick::setImageBackgroundColor Sets the image background color @@ -12,9 +12,9 @@ public boolImagick::setImageBackgroundColor mixedbackground - + Sets the image background color. - + @@ -24,8 +24,8 @@ background - - + + @@ -34,16 +34,16 @@ &reftitle.returnvalues; - + &imagick.return.success; - + &reftitle.errors; - + &imagick.imagick.throws; - + diff --git a/reference/imagick/imagick/setimagebias.xml b/reference/imagick/imagick/setimagebias.xml index 8a0b9193c..0042accf9 100644 --- a/reference/imagick/imagick/setimagebias.xml +++ b/reference/imagick/imagick/setimagebias.xml @@ -1,6 +1,6 @@ - + Imagick::setImageBias Sets the image bias for any method that convolves an image @@ -16,9 +16,9 @@ public boolImagick::setImageBias floatbias - + Sets the image bias for any method that convolves an image (e.g. Imagick::ConvolveImage()). - + @@ -28,8 +28,8 @@ bias - - + + @@ -38,16 +38,16 @@ &reftitle.returnvalues; - + &imagick.return.success; - + &reftitle.errors; - + &imagick.imagick.throws; - + @@ -74,7 +74,7 @@ function setImageBias($bias) { $imagick->convolveImage($xKernel, \Imagick::CHANNEL_ALL); $imagick->setImageFormat('png'); - + header('Content-type: image/png'); echo $imagick->getImageBlob(); } diff --git a/reference/imagick/imagick/setimagebiasquantum.xml b/reference/imagick/imagick/setimagebiasquantum.xml index 61931d477..7151ab242 100644 --- a/reference/imagick/imagick/setimagebiasquantum.xml +++ b/reference/imagick/imagick/setimagebiasquantum.xml @@ -17,9 +17,9 @@ public voidImagick::setImageBiasQuantum floatbias - + Sets the image bias. Bias should be scaled with 0 (no adjustment) to 1 (quantum value). - + @@ -29,9 +29,9 @@ bias - - - + + + @@ -39,9 +39,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/imagick/imagick/setimageblueprimary.xml b/reference/imagick/imagick/setimageblueprimary.xml index 1813fc603..42a1f9fc8 100644 --- a/reference/imagick/imagick/setimageblueprimary.xml +++ b/reference/imagick/imagick/setimageblueprimary.xml @@ -1,6 +1,6 @@ - + Imagick::setImageBluePrimary Sets the image chromaticity blue primary point @@ -13,9 +13,9 @@ floatx floaty - + Sets the image chromaticity blue primary point. - + @@ -25,15 +25,15 @@ x - - + + y - - + + @@ -42,16 +42,16 @@ &reftitle.returnvalues; - + &imagick.return.success; - + &reftitle.errors; - + &imagick.imagick.throws; - + diff --git a/reference/imagick/imagick/setimagebordercolor.xml b/reference/imagick/imagick/setimagebordercolor.xml index d9658b727..6a9cfee20 100644 --- a/reference/imagick/imagick/setimagebordercolor.xml +++ b/reference/imagick/imagick/setimagebordercolor.xml @@ -1,6 +1,6 @@ - + Imagick::setImageBorderColor Sets the image border color @@ -12,9 +12,9 @@ public boolImagick::setImageBorderColor mixedborder - + Sets the image border color. - + @@ -24,9 +24,9 @@ border - + The border color - + @@ -35,16 +35,16 @@ &reftitle.returnvalues; - + &imagick.return.success; - + &reftitle.errors; - + &imagick.imagick.throws; - + diff --git a/reference/imagick/imagick/setimagechanneldepth.xml b/reference/imagick/imagick/setimagechanneldepth.xml index f12aba4f1..fe461e4d3 100644 --- a/reference/imagick/imagick/setimagechanneldepth.xml +++ b/reference/imagick/imagick/setimagechanneldepth.xml @@ -1,6 +1,6 @@ - + Imagick::setImageChannelDepth Sets the depth of a particular image channel @@ -13,9 +13,9 @@ intchannel intdepth - + Sets the depth of a particular image channel. - + @@ -25,15 +25,15 @@ channel - - + + depth - - + + @@ -42,16 +42,16 @@ &reftitle.returnvalues; - + &imagick.return.success; - + &reftitle.errors; - + &imagick.imagick.throws; - + diff --git a/reference/imagick/imagick/setimageclipmask.xml b/reference/imagick/imagick/setimageclipmask.xml index bd6a53be4..da27030df 100644 --- a/reference/imagick/imagick/setimageclipmask.xml +++ b/reference/imagick/imagick/setimageclipmask.xml @@ -1,6 +1,6 @@ - + Imagick::setImageClipMask Sets image clip mask @@ -17,10 +17,10 @@ Imagickclip_mask - + Sets image clip mask from another Imagick object. &imagick.method.available.0x636; - + @@ -30,9 +30,9 @@ clip_mask - + The Imagick object containing the clip mask - + @@ -41,16 +41,16 @@ &reftitle.returnvalues; - + &imagick.return.success; - + &reftitle.errors; - + &imagick.imagick.throws; - + @@ -93,7 +93,7 @@ function setImageClipMask($imagePath) { header("Content-Type: image/png"); echo $imagick->getImagesBlob(); - + } ?> diff --git a/reference/imagick/imagick/setimagecolormapcolor.xml b/reference/imagick/imagick/setimagecolormapcolor.xml index e76b39bf8..ae51974df 100644 --- a/reference/imagick/imagick/setimagecolormapcolor.xml +++ b/reference/imagick/imagick/setimagecolormapcolor.xml @@ -1,6 +1,6 @@ - + Imagick::setImageColormapColor Sets the color of the specified colormap index @@ -13,9 +13,9 @@ intindex ImagickPixelcolor - + Sets the color of the specified colormap index. - + @@ -25,15 +25,15 @@ index - - + + color - - + + @@ -42,16 +42,16 @@ &reftitle.returnvalues; - + &imagick.return.success; - + &reftitle.errors; - + &imagick.imagick.throws; - + diff --git a/reference/imagick/imagick/setimagecolorspace.xml b/reference/imagick/imagick/setimagecolorspace.xml index ee5fc0cb5..061f60bdd 100644 --- a/reference/imagick/imagick/setimagecolorspace.xml +++ b/reference/imagick/imagick/setimagecolorspace.xml @@ -1,6 +1,6 @@ - + Imagick::setImageColorspace Sets the image colorspace @@ -12,9 +12,9 @@ public boolImagick::setImageColorspace intcolorspace - + Sets the image colorspace. This method should be used when creating new images. To change the colorspace of an existing image, you should use Imagick::transformImageColorspace. - + @@ -24,9 +24,9 @@ colorspace - + One of the COLORSPACE constants - + @@ -35,16 +35,16 @@ &reftitle.returnvalues; - + &imagick.return.success; - + &reftitle.errors; - + &imagick.imagick.throws; - + diff --git a/reference/imagick/imagick/setimagecompose.xml b/reference/imagick/imagick/setimagecompose.xml index 8cee11e63..c2976016a 100644 --- a/reference/imagick/imagick/setimagecompose.xml +++ b/reference/imagick/imagick/setimagecompose.xml @@ -1,6 +1,6 @@ - + Imagick::setImageCompose Sets the image composite operator @@ -12,11 +12,11 @@ public boolImagick::setImageCompose intcompose - + Sets the image composite operator, useful for specifying how to composite the image thumbnail when using the Imagick::montageImage() method. - + @@ -26,8 +26,8 @@ compose - - + + @@ -36,16 +36,16 @@ &reftitle.returnvalues; - + &imagick.return.success; - + &reftitle.errors; - + &imagick.imagick.throws; - + diff --git a/reference/imagick/imagick/setimagecompression.xml b/reference/imagick/imagick/setimagecompression.xml index 1d68c6376..710c8bafd 100644 --- a/reference/imagick/imagick/setimagecompression.xml +++ b/reference/imagick/imagick/setimagecompression.xml @@ -1,6 +1,6 @@ - + Imagick::setImageCompression Sets the image compression @@ -12,8 +12,8 @@ public boolImagick::setImageCompression intcompression - - + + @@ -23,9 +23,9 @@ compression - + One of the COMPRESSION constants - + @@ -34,16 +34,16 @@ &reftitle.returnvalues; - + &imagick.return.success; - + &reftitle.errors; - + &imagick.imagick.throws; - + diff --git a/reference/imagick/imagick/setimagecompressionquality.xml b/reference/imagick/imagick/setimagecompressionquality.xml index 36dc7d7ec..174ceb303 100644 --- a/reference/imagick/imagick/setimagecompressionquality.xml +++ b/reference/imagick/imagick/setimagecompressionquality.xml @@ -1,6 +1,6 @@ - + Imagick::setImageCompressionQuality Sets the image compression quality @@ -12,9 +12,9 @@ public boolImagick::setImageCompressionQuality intquality - + Sets the image compression quality. - + @@ -24,9 +24,9 @@ quality - + The image compression quality as an integer - + @@ -35,16 +35,16 @@ &reftitle.returnvalues; - + &imagick.return.success; - + &reftitle.errors; - + &imagick.imagick.throws; - + diff --git a/reference/imagick/imagick/setimagedelay.xml b/reference/imagick/imagick/setimagedelay.xml index 1e9bcbfc3..b46833716 100644 --- a/reference/imagick/imagick/setimagedelay.xml +++ b/reference/imagick/imagick/setimagedelay.xml @@ -1,6 +1,6 @@ - + Imagick::setImageDelay Sets the image delay @@ -12,14 +12,14 @@ public boolImagick::setImageDelay intdelay - + Sets the image delay. For an animated image this is the amount of time that this frame of the image should be displayed for, before displaying the next frame. - - + + The delay can be set individually for each frame in an image. - + @@ -29,11 +29,11 @@ delay - + The amount of time expressed in 'ticks' that the image should be displayed for. For animated GIFs there are 100 ticks per second, so a value of 20 would be 20/100 of a second aka 1/5th of a second. - + @@ -42,16 +42,16 @@ &reftitle.returnvalues; - + &imagick.return.success; - + &reftitle.errors; - + &imagick.imagick.throws; - + diff --git a/reference/imagick/imagick/setimagedepth.xml b/reference/imagick/imagick/setimagedepth.xml index 57ab22712..3268033a8 100644 --- a/reference/imagick/imagick/setimagedepth.xml +++ b/reference/imagick/imagick/setimagedepth.xml @@ -1,6 +1,6 @@ - + Imagick::setImageDepth Sets the image depth @@ -12,9 +12,9 @@ public boolImagick::setImageDepth intdepth - + Sets the image depth. - + @@ -24,8 +24,8 @@ depth - - + + @@ -34,16 +34,16 @@ &reftitle.returnvalues; - + &imagick.return.success; - + &reftitle.errors; - + &imagick.imagick.throws; - + diff --git a/reference/imagick/imagick/setimagedispose.xml b/reference/imagick/imagick/setimagedispose.xml index 5c710f93c..a29260dd7 100644 --- a/reference/imagick/imagick/setimagedispose.xml +++ b/reference/imagick/imagick/setimagedispose.xml @@ -1,6 +1,6 @@ - + Imagick::setImageDispose Sets the image disposal method @@ -12,9 +12,9 @@ public boolImagick::setImageDispose intdispose - + Sets the image disposal method. - + @@ -24,8 +24,8 @@ dispose - - + + @@ -34,16 +34,16 @@ &reftitle.returnvalues; - + &imagick.return.success; - + &reftitle.errors; - + &imagick.imagick.throws; - + diff --git a/reference/imagick/imagick/setimageextent.xml b/reference/imagick/imagick/setimageextent.xml index f43372754..23ab3089a 100644 --- a/reference/imagick/imagick/setimageextent.xml +++ b/reference/imagick/imagick/setimageextent.xml @@ -1,6 +1,6 @@ - + Imagick::setImageExtent Sets the image size @@ -13,9 +13,9 @@ intcolumns introws - + Sets the image size (i.e. columns & rows). - + @@ -25,15 +25,15 @@ columns - - + + rows - - + + @@ -42,16 +42,16 @@ &reftitle.returnvalues; - + &imagick.return.success; - + &reftitle.errors; - + &imagick.imagick.throws; - + diff --git a/reference/imagick/imagick/setimagefilename.xml b/reference/imagick/imagick/setimagefilename.xml index 1d03f228e..7a2aacabc 100644 --- a/reference/imagick/imagick/setimagefilename.xml +++ b/reference/imagick/imagick/setimagefilename.xml @@ -1,6 +1,6 @@ - + Imagick::setImageFilename Sets the filename of a particular image @@ -12,9 +12,9 @@ public boolImagick::setImageFilename stringfilename - + Sets the filename of a particular image in a sequence. - + @@ -24,8 +24,8 @@ filename - - + + @@ -34,16 +34,16 @@ &reftitle.returnvalues; - + &imagick.return.success; - + &reftitle.errors; - + &imagick.imagick.throws; - + diff --git a/reference/imagick/imagick/setimageformat.xml b/reference/imagick/imagick/setimageformat.xml index f5665ecf4..838f62935 100644 --- a/reference/imagick/imagick/setimageformat.xml +++ b/reference/imagick/imagick/setimageformat.xml @@ -1,6 +1,6 @@ - + Imagick::setImageFormat Sets the format of a particular image @@ -12,9 +12,9 @@ public boolImagick::setImageFormat stringformat - + Sets the format of a particular image in a sequence. - + @@ -24,10 +24,10 @@ format - + String presentation of the image format. Format support depends on the ImageMagick installation. - + @@ -36,9 +36,9 @@ &reftitle.returnvalues; - + &imagick.return.success; - + diff --git a/reference/imagick/imagick/setimagegamma.xml b/reference/imagick/imagick/setimagegamma.xml index 3a8f25962..3555d14aa 100644 --- a/reference/imagick/imagick/setimagegamma.xml +++ b/reference/imagick/imagick/setimagegamma.xml @@ -1,6 +1,6 @@ - + Imagick::setImageGamma Sets the image gamma @@ -12,9 +12,9 @@ public boolImagick::setImageGamma floatgamma - + Sets the image gamma. - + @@ -24,8 +24,8 @@ gamma - - + + @@ -34,16 +34,16 @@ &reftitle.returnvalues; - + &imagick.return.success; - + &reftitle.errors; - + &imagick.imagick.throws; - + diff --git a/reference/imagick/imagick/setimagegravity.xml b/reference/imagick/imagick/setimagegravity.xml index 321dca15e..3a187951d 100644 --- a/reference/imagick/imagick/setimagegravity.xml +++ b/reference/imagick/imagick/setimagegravity.xml @@ -1,6 +1,6 @@ - + Imagick::setImageGravity Sets the image gravity @@ -13,11 +13,11 @@ intgravity - - Sets the gravity property for the current image. This method can be used + + Sets the gravity property for the current image. This method can be used to set the gravity property for a single image sequence. &imagick.method.available.0x644; - + @@ -27,10 +27,10 @@ gravity - - The gravity property. Refer to the list of + + The gravity property. Refer to the list of gravity constants. - + @@ -39,9 +39,9 @@ &reftitle.returnvalues; - + &return.void; - + diff --git a/reference/imagick/imagick/setimagegreenprimary.xml b/reference/imagick/imagick/setimagegreenprimary.xml index e55eb2075..4d9476f0d 100644 --- a/reference/imagick/imagick/setimagegreenprimary.xml +++ b/reference/imagick/imagick/setimagegreenprimary.xml @@ -1,6 +1,6 @@ - + Imagick::setImageGreenPrimary Sets the image chromaticity green primary point @@ -13,9 +13,9 @@ floatx floaty - + Sets the image chromaticity green primary point. - + @@ -25,15 +25,15 @@ x - - + + y - - + + @@ -42,16 +42,16 @@ &reftitle.returnvalues; - + &imagick.return.success; - + &reftitle.errors; - + &imagick.imagick.throws; - + diff --git a/reference/imagick/imagick/setimageindex.xml b/reference/imagick/imagick/setimageindex.xml index 9e6e5e3cb..49bad6609 100644 --- a/reference/imagick/imagick/setimageindex.xml +++ b/reference/imagick/imagick/setimageindex.xml @@ -1,6 +1,6 @@ - + Imagick::setImageIndex Set the iterator position @@ -16,14 +16,14 @@ public boolImagick::setImageIndex intindex - + Set the iterator to the position in the image list specified with the index - parameter. - - + parameter. + + This method has been deprecated. See Imagick::setIteratorIndex. - + @@ -33,9 +33,9 @@ index - + The position to set the iterator to - + @@ -44,16 +44,16 @@ &reftitle.returnvalues; - + &imagick.return.success; - + &reftitle.errors; - + &imagick.imagick.throws; - + diff --git a/reference/imagick/imagick/setimageinterlacescheme.xml b/reference/imagick/imagick/setimageinterlacescheme.xml index c419c6deb..47c8c7b7a 100644 --- a/reference/imagick/imagick/setimageinterlacescheme.xml +++ b/reference/imagick/imagick/setimageinterlacescheme.xml @@ -1,6 +1,6 @@ - + Imagick::setImageInterlaceScheme Sets the image compression @@ -12,9 +12,9 @@ public boolImagick::setImageInterlaceScheme intinterlace_scheme - + Sets the image compression. - + @@ -24,8 +24,8 @@ interlace_scheme - - + + @@ -34,16 +34,16 @@ &reftitle.returnvalues; - + &imagick.return.success; - + &reftitle.errors; - + &imagick.imagick.throws; - + diff --git a/reference/imagick/imagick/setimageinterpolatemethod.xml b/reference/imagick/imagick/setimageinterpolatemethod.xml index babc90adb..1b1b4aee3 100644 --- a/reference/imagick/imagick/setimageinterpolatemethod.xml +++ b/reference/imagick/imagick/setimageinterpolatemethod.xml @@ -1,6 +1,6 @@ - + Imagick::setImageInterpolateMethod Sets the image interpolate pixel method @@ -12,9 +12,9 @@ public boolImagick::setImageInterpolateMethod intmethod - + Sets the image interpolate pixel method. - + @@ -24,9 +24,9 @@ method - + The method is one of the Imagick::INTERPOLATE_* constants - + @@ -35,9 +35,9 @@ &reftitle.returnvalues; - + &imagick.return.success; - + diff --git a/reference/imagick/imagick/setimageiterations.xml b/reference/imagick/imagick/setimageiterations.xml index ab5e62165..1163aaa55 100644 --- a/reference/imagick/imagick/setimageiterations.xml +++ b/reference/imagick/imagick/setimageiterations.xml @@ -1,6 +1,6 @@ - + Imagick::setImageIterations Sets the image iterations @@ -12,9 +12,9 @@ public boolImagick::setImageIterations intiterations - + Sets the number of iterations an animated image is repeated. - + @@ -24,10 +24,10 @@ iterations - + The number of iterations the image should loop over. Set to '0' to loop continuously. - + @@ -36,16 +36,16 @@ &reftitle.returnvalues; - + &imagick.return.success; - + &reftitle.errors; - + &imagick.imagick.throws; - + diff --git a/reference/imagick/imagick/setimagematte.xml b/reference/imagick/imagick/setimagematte.xml index 06e7fa9a8..26b94fbe9 100644 --- a/reference/imagick/imagick/setimagematte.xml +++ b/reference/imagick/imagick/setimagematte.xml @@ -1,6 +1,6 @@ - + Imagick::setImageMatte Sets the image matte channel @@ -13,10 +13,10 @@ boolmatte - - Sets the image matte channel. + + Sets the image matte channel. &imagick.method.available.0x629; - + @@ -26,9 +26,9 @@ matte - + True activates the matte channel and false disables it. - + @@ -37,9 +37,9 @@ &reftitle.returnvalues; - + &imagick.return.success; - + diff --git a/reference/imagick/imagick/setimagemattecolor.xml b/reference/imagick/imagick/setimagemattecolor.xml index e652b1a84..c2b6fee1a 100644 --- a/reference/imagick/imagick/setimagemattecolor.xml +++ b/reference/imagick/imagick/setimagemattecolor.xml @@ -1,6 +1,6 @@ - + Imagick::setImageMatteColor Sets the image matte color @@ -16,9 +16,9 @@ public boolImagick::setImageMatteColor mixedmatte - + Sets the image matte color. - + @@ -28,8 +28,8 @@ matte - - + + @@ -38,16 +38,16 @@ &reftitle.returnvalues; - + &imagick.return.success; - + &reftitle.errors; - + &imagick.imagick.throws; - + diff --git a/reference/imagick/imagick/setimageopacity.xml b/reference/imagick/imagick/setimageopacity.xml index 17c82dcc3..572ddabdd 100644 --- a/reference/imagick/imagick/setimageopacity.xml +++ b/reference/imagick/imagick/setimageopacity.xml @@ -1,6 +1,6 @@ - + Imagick::setImageOpacity Sets the image opacity level @@ -17,12 +17,12 @@ floatopacity - + Sets the image to the specified opacity level. &imagick.method.available.0x631; This method operates on all channels, which means that for example opacity value of 0.5 will set all transparent areas to partially opaque. To add transparency to areas that are not already transparent use Imagick::evaluateImage() - + @@ -32,10 +32,10 @@ opacity - + The level of transparency: 1.0 is fully opaque and 0.0 is fully transparent. - + @@ -44,9 +44,9 @@ &reftitle.returnvalues; - + &imagick.return.success; - + @@ -54,9 +54,9 @@ A <function>Imagick::setImageOpacity</function> example - + An example of using Imagick::setImageOpacity() - + - + Imagick::setImageOrientation Sets the image orientation @@ -13,9 +13,9 @@ intorientation - + Sets the image orientation. - + @@ -25,9 +25,9 @@ orientation - + One of the orientation constants - + @@ -36,9 +36,9 @@ &reftitle.returnvalues; - + &imagick.return.success; - + diff --git a/reference/imagick/imagick/setimagepage.xml b/reference/imagick/imagick/setimagepage.xml index 6c7d26789..6aba2b4e4 100644 --- a/reference/imagick/imagick/setimagepage.xml +++ b/reference/imagick/imagick/setimagepage.xml @@ -1,6 +1,6 @@ - + Imagick::setImagePage Sets the page geometry of the image @@ -15,9 +15,9 @@ intx inty - + Sets the page geometry of the image. - + @@ -27,29 +27,29 @@ width - - + + height - - + + x - - + + y - - + + @@ -58,16 +58,16 @@ &reftitle.returnvalues; - + &imagick.return.success; - + &reftitle.errors; - + &imagick.imagick.throws; - + diff --git a/reference/imagick/imagick/setimageprofile.xml b/reference/imagick/imagick/setimageprofile.xml index 45dd5b8b4..d091f267f 100644 --- a/reference/imagick/imagick/setimageprofile.xml +++ b/reference/imagick/imagick/setimageprofile.xml @@ -1,6 +1,6 @@ - + Imagick::setImageProfile Adds a named profile to the Imagick object @@ -13,12 +13,12 @@ stringname stringprofile - + Adds a named profile to the Imagick object. If a profile with the same name already exists, it is replaced. This method differs from the Imagick::ProfileImage() method in that it does not apply any CMS color profiles. - + @@ -28,15 +28,15 @@ name - - + + profile - - + + @@ -45,16 +45,16 @@ &reftitle.returnvalues; - + &imagick.return.success; - + &reftitle.errors; - + &imagick.imagick.throws; - + diff --git a/reference/imagick/imagick/setimageproperty.xml b/reference/imagick/imagick/setimageproperty.xml index 05f76539c..a6aed1b92 100644 --- a/reference/imagick/imagick/setimageproperty.xml +++ b/reference/imagick/imagick/setimageproperty.xml @@ -1,6 +1,6 @@ - + Imagick::setImageProperty Sets an image property @@ -14,9 +14,9 @@ stringvalue - + Sets a named property to the image. &imagick.method.available.0x632; - + @@ -26,15 +26,15 @@ name - - + + value - - + + @@ -43,9 +43,9 @@ &reftitle.returnvalues; - + &imagick.return.success; - + @@ -53,9 +53,9 @@ Using <function>Imagick::setImageProperty</function>: - + Setting and getting image properties - + - + Imagick::setImageRedPrimary Sets the image chromaticity red primary point @@ -13,9 +13,9 @@ floatx floaty - + Sets the image chromaticity red primary point. - + @@ -25,15 +25,15 @@ x - - + + y - - + + @@ -42,16 +42,16 @@ &reftitle.returnvalues; - + &imagick.return.success; - + &reftitle.errors; - + &imagick.imagick.throws; - + diff --git a/reference/imagick/imagick/setimagerenderingintent.xml b/reference/imagick/imagick/setimagerenderingintent.xml index c7bafb169..b59c28c64 100644 --- a/reference/imagick/imagick/setimagerenderingintent.xml +++ b/reference/imagick/imagick/setimagerenderingintent.xml @@ -1,6 +1,6 @@ - + Imagick::setImageRenderingIntent Sets the image rendering intent @@ -12,9 +12,9 @@ public boolImagick::setImageRenderingIntent intrendering_intent - + Sets the image rendering intent. - + @@ -24,8 +24,8 @@ rendering_intent - - + + @@ -34,16 +34,16 @@ &reftitle.returnvalues; - + &imagick.return.success; - + &reftitle.errors; - + &imagick.imagick.throws; - + diff --git a/reference/imagick/imagick/setimageresolution.xml b/reference/imagick/imagick/setimageresolution.xml index 5ff9c47ec..ca4bd1e4f 100644 --- a/reference/imagick/imagick/setimageresolution.xml +++ b/reference/imagick/imagick/setimageresolution.xml @@ -1,6 +1,6 @@ - + Imagick::setImageResolution Sets the image resolution @@ -13,9 +13,9 @@ floatx_resolution floaty_resolution - + Sets the image resolution. - + @@ -25,15 +25,15 @@ x_resolution - - + + y_resolution - - + + @@ -42,16 +42,16 @@ &reftitle.returnvalues; - + &imagick.return.success; - + &reftitle.errors; - + &imagick.imagick.throws; - + @@ -67,7 +67,7 @@ function setImageResolution($imagePath) { $imagick = new \Imagick(realpath($imagePath)); $imagick->setImageResolution(50, 50); - + header("Content-Type: image/jpg"); echo $imagick->getImageBlob(); } diff --git a/reference/imagick/imagick/setimagescene.xml b/reference/imagick/imagick/setimagescene.xml index 80f8af020..bc4ae0e13 100644 --- a/reference/imagick/imagick/setimagescene.xml +++ b/reference/imagick/imagick/setimagescene.xml @@ -1,6 +1,6 @@ - + Imagick::setImageScene Sets the image scene @@ -12,9 +12,9 @@ public boolImagick::setImageScene intscene - + Sets the image scene. - + @@ -24,8 +24,8 @@ scene - - + + @@ -34,16 +34,16 @@ &reftitle.returnvalues; - + &imagick.return.success; - + &reftitle.errors; - + &imagick.imagick.throws; - + diff --git a/reference/imagick/imagick/setimagetickspersecond.xml b/reference/imagick/imagick/setimagetickspersecond.xml index bee029842..653d719fb 100644 --- a/reference/imagick/imagick/setimagetickspersecond.xml +++ b/reference/imagick/imagick/setimagetickspersecond.xml @@ -1,6 +1,6 @@ - + Imagick::setImageTicksPerSecond Sets the image ticks-per-second @@ -12,23 +12,23 @@ public boolImagick::setImageTicksPerSecond intticks_per_second - + Adjust the amount of time that a frame of an animated image is displayed for. - + - + For animated GIFs, this function does not change the number of 'image ticks' per second, which is always defined as 100. Instead it adjusts the amount of time that the frame is displayed for to simulate the change in 'ticks per second'. - - + + For example, for an animated GIF where each frame is displayed for 20 ticks (1/5 of a second) when this method is called on each frame of that image with an argument of 50 the frames are adjusted to be displayed for 40 ticks (2/5 of a second) and the animation will play at half the original speed. - + @@ -39,10 +39,10 @@ ticks_per_second - + The duration for which an image should be displayed expressed in ticks per second. - + @@ -51,9 +51,9 @@ &reftitle.returnvalues; - + &imagick.return.success; - + @@ -78,7 +78,7 @@ $frameCount = 0; foreach ($imagick as $frame) { $imagick->setImageTicksPerSecond(50); - + if ($frameCount < ($totalFrames / 2)) { // Modify the frame to be displayed for twice as long as it currently is $imagick->setImageTicksPerSecond(50); diff --git a/reference/imagick/imagick/setimagetype.xml b/reference/imagick/imagick/setimagetype.xml index da7b99722..cae1f53dd 100644 --- a/reference/imagick/imagick/setimagetype.xml +++ b/reference/imagick/imagick/setimagetype.xml @@ -1,6 +1,6 @@ - + Imagick::setImageType Sets the image type @@ -12,9 +12,9 @@ public boolImagick::setImageType intimage_type - + Sets the image type. - + @@ -24,8 +24,8 @@ image_type - - + + @@ -34,9 +34,9 @@ &reftitle.returnvalues; - + &imagick.return.success; - + diff --git a/reference/imagick/imagick/setimageunits.xml b/reference/imagick/imagick/setimageunits.xml index 2d2608dd2..6e8aabd7c 100644 --- a/reference/imagick/imagick/setimageunits.xml +++ b/reference/imagick/imagick/setimageunits.xml @@ -1,6 +1,6 @@ - + Imagick::setImageUnits Sets the image units of resolution @@ -12,9 +12,9 @@ public boolImagick::setImageUnits intunits - + Sets the image units of resolution. - + @@ -24,8 +24,8 @@ units - - + + @@ -34,9 +34,9 @@ &reftitle.returnvalues; - + &imagick.return.success; - + diff --git a/reference/imagick/imagick/setimagevirtualpixelmethod.xml b/reference/imagick/imagick/setimagevirtualpixelmethod.xml index 8c2df9295..dd251140b 100644 --- a/reference/imagick/imagick/setimagevirtualpixelmethod.xml +++ b/reference/imagick/imagick/setimagevirtualpixelmethod.xml @@ -1,6 +1,6 @@ - + Imagick::setImageVirtualPixelMethod Sets the image virtual pixel method @@ -12,9 +12,9 @@ public boolImagick::setImageVirtualPixelMethod intmethod - + Sets the image virtual pixel method. - + @@ -24,8 +24,8 @@ method - - + + @@ -34,9 +34,9 @@ &reftitle.returnvalues; - + &imagick.return.success; - + diff --git a/reference/imagick/imagick/setimagewhitepoint.xml b/reference/imagick/imagick/setimagewhitepoint.xml index 51115d610..b28e3517c 100644 --- a/reference/imagick/imagick/setimagewhitepoint.xml +++ b/reference/imagick/imagick/setimagewhitepoint.xml @@ -1,6 +1,6 @@ - + Imagick::setImageWhitePoint Sets the image chromaticity white point @@ -13,9 +13,9 @@ floatx floaty - + Sets the image chromaticity white point. - + @@ -25,15 +25,15 @@ x - - + + y - - + + @@ -42,16 +42,16 @@ &reftitle.returnvalues; - + &imagick.return.success; - + &reftitle.errors; - + &imagick.imagick.throws; - + diff --git a/reference/imagick/imagick/setinterlacescheme.xml b/reference/imagick/imagick/setinterlacescheme.xml index 50a1149dd..7cc788302 100644 --- a/reference/imagick/imagick/setinterlacescheme.xml +++ b/reference/imagick/imagick/setinterlacescheme.xml @@ -1,6 +1,6 @@ - + Imagick::setInterlaceScheme Sets the image compression @@ -12,9 +12,9 @@ public boolImagick::setInterlaceScheme intinterlace_scheme - + Sets the image compression. - + @@ -24,8 +24,8 @@ interlace_scheme - - + + @@ -34,9 +34,9 @@ &reftitle.returnvalues; - + &imagick.return.success; - + diff --git a/reference/imagick/imagick/setiteratorindex.xml b/reference/imagick/imagick/setiteratorindex.xml index af214d61b..8425a4314 100644 --- a/reference/imagick/imagick/setiteratorindex.xml +++ b/reference/imagick/imagick/setiteratorindex.xml @@ -1,6 +1,6 @@ - + Imagick::setIteratorIndex Set the iterator position @@ -13,10 +13,10 @@ intindex - + Set the iterator to the position in the image list specified with the index parameter. &imagick.method.available.0x629; - + @@ -26,9 +26,9 @@ index - + The position to set the iterator to - + @@ -37,9 +37,9 @@ &reftitle.returnvalues; - + &imagick.return.success; - + @@ -47,9 +47,9 @@ Using <function>Imagick::setIteratorIndex</function>: - + Create images, set and get the iterator index - + - + Imagick::setLastIterator Sets the Imagick iterator to the last image @@ -12,9 +12,9 @@ public boolImagick::setLastIterator - + Sets the Imagick iterator to the last image. - + @@ -24,9 +24,9 @@ &reftitle.returnvalues; - + &imagick.return.success; - + diff --git a/reference/imagick/imagick/setoption.xml b/reference/imagick/imagick/setoption.xml index 458d482a4..fe4cca834 100644 --- a/reference/imagick/imagick/setoption.xml +++ b/reference/imagick/imagick/setoption.xml @@ -1,6 +1,6 @@ - + Imagick::setOption Set an option @@ -13,9 +13,9 @@ stringkey stringvalue - + Associates one or more options with the wand. - + @@ -25,15 +25,15 @@ key - - + + value - - + + @@ -42,9 +42,9 @@ &reftitle.returnvalues; - + &imagick.return.success; - + @@ -84,7 +84,7 @@ header("Content-Type: image/png"); echo $imagick->getImageBlob(); } - + //Save as 64bit PNG. renderPNG($imagePath, 'png64'); @@ -102,7 +102,7 @@ $imagePath = $this->control->getImagePath(); $imagick = new \Imagick(realpath($imagePath)); $imagick->setImageFormat('png'); - + $imagick->setOption('png:bit-depth', '16'); $imagick->setOption('png:color-type', 6); header("Content-Type: image/png"); diff --git a/reference/imagick/imagick/setpage.xml b/reference/imagick/imagick/setpage.xml index 25f31d4f7..b85d46489 100644 --- a/reference/imagick/imagick/setpage.xml +++ b/reference/imagick/imagick/setpage.xml @@ -1,6 +1,6 @@ - + Imagick::setPage Sets the page geometry of the Imagick object @@ -15,9 +15,9 @@ intx inty - + Sets the page geometry of the Imagick object. - + @@ -27,29 +27,29 @@ width - - + + height - - + + x - - + + y - - + + @@ -58,9 +58,9 @@ &reftitle.returnvalues; - + &imagick.return.success; - + diff --git a/reference/imagick/imagick/setpointsize.xml b/reference/imagick/imagick/setpointsize.xml index 962699d3c..5c1856245 100644 --- a/reference/imagick/imagick/setpointsize.xml +++ b/reference/imagick/imagick/setpointsize.xml @@ -1,6 +1,6 @@ - + Imagick::setPointSize Sets point size @@ -12,11 +12,11 @@ public boolImagick::setPointSize floatpoint_size - - Sets object's point size property. This method can be used for example to set font size for + + Sets object's point size property. This method can be used for example to set font size for caption: pseudo-format. &imagick.method.available.0x637; - + @@ -26,9 +26,9 @@ point_size - + Point size - + @@ -37,9 +37,9 @@ &reftitle.returnvalues; - + &imagick.return.success; - + @@ -47,9 +47,9 @@ A <function>Imagick::setPointSize</function> example - + Example of using Imagick::setPointSize - + newPseudoImage(100, 100, "caption:Hello"); - + - + Imagick::setResolution Sets the image resolution @@ -13,9 +13,9 @@ floatx_resolution floaty_resolution - + Sets the image resolution. - + @@ -25,17 +25,17 @@ x_resolution - + The horizontal resolution. - + y_resolution - + The vertical resolution. - + @@ -44,17 +44,17 @@ &reftitle.returnvalues; - + &imagick.return.success; - + - + &reftitle.notes; - + Imagick::setResolution must be called before loading or creating an image. - + @@ -64,8 +64,8 @@ Imagick::getImageResolution - - + + - + Imagick::setResourceLimit Sets the limit for a particular resource @@ -13,10 +13,10 @@ inttype intlimit - + This method is used to modify the resource limits of the underlying ImageMagick library. - + @@ -26,20 +26,20 @@ type - - Refer to the list of + Refer to the list of resourcetype constants. - + limit - - One of the + One of the resourcetype constants. The unit depends on the type of the resource being limited. - + @@ -48,9 +48,9 @@ &reftitle.returnvalues; - + &imagick.return.success; - + diff --git a/reference/imagick/imagick/setsamplingfactors.xml b/reference/imagick/imagick/setsamplingfactors.xml index 2a3685e4c..8894b4a4a 100644 --- a/reference/imagick/imagick/setsamplingfactors.xml +++ b/reference/imagick/imagick/setsamplingfactors.xml @@ -1,6 +1,6 @@ - + Imagick::setSamplingFactors Sets the image sampling factors @@ -12,9 +12,9 @@ public boolImagick::setSamplingFactors arrayfactors - + Sets the image sampling factors. - + @@ -24,8 +24,8 @@ factors - - + + @@ -34,9 +34,9 @@ &reftitle.returnvalues; - + &imagick.return.success; - + @@ -58,7 +58,7 @@ function setSamplingFactors($imagePath) { $compressed = $imagick->getImageBlob(); - + $reopen = new \Imagick(); $reopen->readImageBlob($compressed); @@ -68,7 +68,7 @@ function setSamplingFactors($imagePath) { \Imagick::FILTER_POINT, 1 ); - + header("Content-Type: image/jpg"); echo $reopen->getImageBlob(); } diff --git a/reference/imagick/imagick/setsize.xml b/reference/imagick/imagick/setsize.xml index 1eda83637..fcf9b293c 100644 --- a/reference/imagick/imagick/setsize.xml +++ b/reference/imagick/imagick/setsize.xml @@ -1,6 +1,6 @@ - + Imagick::setSize Sets the size of the Imagick object @@ -13,10 +13,10 @@ intcolumns introws - + Sets the size of the Imagick object. Set it before you read a raw image format such as RGB, GRAY, or CMYK. - + @@ -26,15 +26,15 @@ columns - - + + rows - - + + @@ -43,9 +43,9 @@ &reftitle.returnvalues; - + &imagick.return.success; - + diff --git a/reference/imagick/imagick/setsizeoffset.xml b/reference/imagick/imagick/setsizeoffset.xml index e071abd1d..9e33cccf2 100644 --- a/reference/imagick/imagick/setsizeoffset.xml +++ b/reference/imagick/imagick/setsizeoffset.xml @@ -1,6 +1,6 @@ - + Imagick::setSizeOffset Sets the size and offset of the Imagick object @@ -14,11 +14,11 @@ introws intoffset - + Sets the size and offset of the Imagick object. Set it before you read a raw image format such as RGB, GRAY, or CMYK. &imagick.method.available.0x629; - + @@ -28,25 +28,25 @@ columns - + The width in pixels. - + rows - + The height in pixels. - + offset - + The image offset. - + @@ -55,9 +55,9 @@ &reftitle.returnvalues; - + &imagick.return.success; - + diff --git a/reference/imagick/imagick/settype.xml b/reference/imagick/imagick/settype.xml index 96037abef..1d8849985 100644 --- a/reference/imagick/imagick/settype.xml +++ b/reference/imagick/imagick/settype.xml @@ -1,6 +1,6 @@ - + Imagick::setType Sets the image type attribute @@ -12,9 +12,9 @@ public boolImagick::setType intimage_type - + Sets the image type attribute. - + @@ -24,8 +24,8 @@ image_type - - + + @@ -34,9 +34,9 @@ &reftitle.returnvalues; - + &imagick.return.success; - + diff --git a/reference/imagick/imagick/shadeimage.xml b/reference/imagick/imagick/shadeimage.xml index 7e8edf7b6..d8228d485 100644 --- a/reference/imagick/imagick/shadeimage.xml +++ b/reference/imagick/imagick/shadeimage.xml @@ -1,6 +1,6 @@ - + Imagick::shadeImage Creates a 3D effect @@ -15,13 +15,13 @@ floatelevation - + Shines a distant light on an image to create a three-dimensional effect. You control the positioning of the light with azimuth and elevation; azimuth is measured in degrees off the x axis and elevation is measured in pixels above the Z axis. &imagick.method.available.0x629; - + @@ -31,25 +31,25 @@ gray - + A value other than zero shades the intensity of each pixel. - + azimuth - + Defines the light source direction. - + elevation - + Defines the light source direction. - + @@ -58,16 +58,16 @@ &reftitle.returnvalues; - + &imagick.return.success; - + - + &reftitle.errors; - + Throws ImagickException on failure. - + diff --git a/reference/imagick/imagick/shadowimage.xml b/reference/imagick/imagick/shadowimage.xml index db62847e0..39c7e570f 100644 --- a/reference/imagick/imagick/shadowimage.xml +++ b/reference/imagick/imagick/shadowimage.xml @@ -1,6 +1,6 @@ - + Imagick::shadowImage Simulates an image shadow @@ -15,9 +15,9 @@ intx inty - + Simulates an image shadow. - + @@ -27,29 +27,29 @@ opacity - - + + sigma - - + + x - - + + y - - + + @@ -58,9 +58,9 @@ &reftitle.returnvalues; - + &imagick.return.success; - + diff --git a/reference/imagick/imagick/sharpenimage.xml b/reference/imagick/imagick/sharpenimage.xml index c7180f3a4..143a4a2ae 100644 --- a/reference/imagick/imagick/sharpenimage.xml +++ b/reference/imagick/imagick/sharpenimage.xml @@ -1,6 +1,6 @@ - + Imagick::sharpenImage Sharpens an image @@ -14,13 +14,13 @@ floatsigma intchannelImagick::CHANNEL_DEFAULT - + Sharpens an image. We convolve the image with a Gaussian operator of the given radius and standard deviation (sigma). For reasonable results, the radius should be larger than sigma. Use a radius of 0 and Imagick::sharpenImage selects a suitable radius for you. - + @@ -30,22 +30,22 @@ radius - - + + sigma - - + + channel - - + + @@ -54,9 +54,9 @@ &reftitle.returnvalues; - + &imagick.return.success; - + diff --git a/reference/imagick/imagick/shaveimage.xml b/reference/imagick/imagick/shaveimage.xml index d73be1263..f5b4cc768 100644 --- a/reference/imagick/imagick/shaveimage.xml +++ b/reference/imagick/imagick/shaveimage.xml @@ -1,6 +1,6 @@ - + Imagick::shaveImage Shaves pixels from the image edges @@ -13,10 +13,10 @@ intcolumns introws - + Shaves pixels from the image edges. It allocates the memory necessary for the new Image structure and returns a pointer to the new image. - + @@ -26,15 +26,15 @@ columns - - + + rows - - + + @@ -43,9 +43,9 @@ &reftitle.returnvalues; - + &imagick.return.success; - + diff --git a/reference/imagick/imagick/shearimage.xml b/reference/imagick/imagick/shearimage.xml index 4a4a01136..c8e806d4b 100644 --- a/reference/imagick/imagick/shearimage.xml +++ b/reference/imagick/imagick/shearimage.xml @@ -1,6 +1,6 @@ - + Imagick::shearImage Creating a parallelogram @@ -14,7 +14,7 @@ floatx_shear floaty_shear - + Slides one edge of an image along the X or Y axis, creating a parallelogram. An X direction shear slides an edge along the X axis, while a Y direction shear slides an edge along the Y axis. The amount of the shear is controlled @@ -22,7 +22,7 @@ the Y axis, and similarly, for Y direction shears y_shear is measured relative to the X axis. Empty triangles left over from shearing the image are filled with the background color. - + @@ -32,25 +32,25 @@ background - + The background color - + x_shear - + The number of degrees to shear on the x axis - + y_shear - + The number of degrees to shear on the y axis - + @@ -59,9 +59,9 @@ &reftitle.returnvalues; - + &imagick.return.success; - + diff --git a/reference/imagick/imagick/sigmoidalcontrastimage.xml b/reference/imagick/imagick/sigmoidalcontrastimage.xml index 52c774b97..ceddb3388 100644 --- a/reference/imagick/imagick/sigmoidalcontrastimage.xml +++ b/reference/imagick/imagick/sigmoidalcontrastimage.xml @@ -77,16 +77,16 @@ &reftitle.returnvalues; - + &imagick.return.success; - + &reftitle.errors; - + &imagick.imagick.throws; - + diff --git a/reference/imagick/imagick/sketchimage.xml b/reference/imagick/imagick/sketchimage.xml index 5436470e9..8dcd98d7c 100644 --- a/reference/imagick/imagick/sketchimage.xml +++ b/reference/imagick/imagick/sketchimage.xml @@ -1,6 +1,6 @@ - + Imagick::sketchImage Simulates a pencil sketch @@ -15,14 +15,14 @@ floatangle - + Simulates a pencil sketch. We convolve the image with a Gaussian operator of the given radius and standard deviation (sigma). For reasonable results, radius should be larger than sigma. Use a radius of 0 and Imagick::sketchImage() selects a suitable radius for you. Angle gives the - angle of the blurring motion. + angle of the blurring motion. &imagick.method.available.0x629; - + @@ -32,25 +32,25 @@ radius - + The radius of the Gaussian, in pixels, not counting the center pixel - + sigma - + The standard deviation of the Gaussian, in pixels. - + angle - + Apply the effect along this angle. - + @@ -59,9 +59,9 @@ &reftitle.returnvalues; - + &imagick.return.success; - + diff --git a/reference/imagick/imagick/smushimages.xml b/reference/imagick/imagick/smushimages.xml index d8cda5e41..5c292206d 100644 --- a/reference/imagick/imagick/smushimages.xml +++ b/reference/imagick/imagick/smushimages.xml @@ -14,10 +14,10 @@ boolstack intoffset - + Takes all images from the current image pointer to the end of the image list and smushs them to each other top-to-bottom if the stack parameter is true, otherwise left-to-right. - + @@ -27,17 +27,17 @@ stack - - - + + + offset - - - + + + @@ -45,9 +45,9 @@ &reftitle.returnvalues; - + The new smushed image. - + diff --git a/reference/imagick/imagick/solarizeimage.xml b/reference/imagick/imagick/solarizeimage.xml index 127cae4ef..03a731cd2 100644 --- a/reference/imagick/imagick/solarizeimage.xml +++ b/reference/imagick/imagick/solarizeimage.xml @@ -1,6 +1,6 @@ - + Imagick::solarizeImage Applies a solarizing effect to the image @@ -12,12 +12,12 @@ public boolImagick::solarizeImage intthreshold - + Applies a special effect to the image, similar to the effect achieved in a photo darkroom by selectively exposing areas of photo sensitive paper to light. Threshold ranges from 0 to QuantumRange and is a measure of the extent of the solarization. - + @@ -27,8 +27,8 @@ threshold - - + + @@ -37,9 +37,9 @@ &reftitle.returnvalues; - + &imagick.return.success; - + diff --git a/reference/imagick/imagick/sparsecolorimage.xml b/reference/imagick/imagick/sparsecolorimage.xml index d25ed73f9..82aad9de7 100644 --- a/reference/imagick/imagick/sparsecolorimage.xml +++ b/reference/imagick/imagick/sparsecolorimage.xml @@ -15,11 +15,11 @@ arrayarguments intchannelImagick::CHANNEL_DEFAULT - + Given the arguments array containing numeric values this method interpolates the colors found at those coordinates across the whole image using sparse_method. &imagick.method.available.0x645; - + @@ -29,26 +29,26 @@ SPARSE_METHOD - + Refer to this list of sparse method constants - + arguments - - An array containing the coordinates. + + An array containing the coordinates. The array is in format array(1,1, 2,45) - + channel - + &imagick.parameter.channel; - + @@ -57,16 +57,16 @@ &reftitle.returnvalues; - + &imagick.return.success; - + &reftitle.errors; - + &imagick.imagick.throws; - + diff --git a/reference/imagick/imagick/spliceimage.xml b/reference/imagick/imagick/spliceimage.xml index 565de3192..9c8794941 100644 --- a/reference/imagick/imagick/spliceimage.xml +++ b/reference/imagick/imagick/spliceimage.xml @@ -1,6 +1,6 @@ - + Imagick::spliceImage Splices a solid color into the image @@ -15,9 +15,9 @@ intx inty - + Splices a solid color into the image. - + @@ -27,29 +27,29 @@ width - - + + height - - + + x - - + + y - - + + @@ -58,9 +58,9 @@ &reftitle.returnvalues; - + &imagick.return.success; - + diff --git a/reference/imagick/imagick/spreadimage.xml b/reference/imagick/imagick/spreadimage.xml index f67331481..a44ea4850 100644 --- a/reference/imagick/imagick/spreadimage.xml +++ b/reference/imagick/imagick/spreadimage.xml @@ -1,6 +1,6 @@ - + Imagick::spreadImage Randomly displaces each pixel in a block @@ -12,10 +12,10 @@ public boolImagick::spreadImage floatradius - + Special effects method that randomly displaces each pixel in a block defined by the radius parameter. - + @@ -25,8 +25,8 @@ radius - - + + @@ -35,16 +35,16 @@ &reftitle.returnvalues; - + &imagick.return.success; - + &reftitle.errors; - + &imagick.imagick.throws; - + diff --git a/reference/imagick/imagick/statisticimage.xml b/reference/imagick/imagick/statisticimage.xml index ac8312b53..f1284dad1 100644 --- a/reference/imagick/imagick/statisticimage.xml +++ b/reference/imagick/imagick/statisticimage.xml @@ -16,9 +16,9 @@ intheight intchannelImagick::CHANNEL_DEFAULT - + Replace each pixel with corresponding statistic from the neighborhood of the specified width and height. - + @@ -28,33 +28,33 @@ type - - - + + + width - - - + + + height - - - + + + channel - - - + + + @@ -62,9 +62,9 @@ &reftitle.returnvalues; - + &imagick.return.success; - + diff --git a/reference/imagick/imagick/steganoimage.xml b/reference/imagick/imagick/steganoimage.xml index 35adaa9fc..2d062f415 100644 --- a/reference/imagick/imagick/steganoimage.xml +++ b/reference/imagick/imagick/steganoimage.xml @@ -1,6 +1,6 @@ - + Imagick::steganoImage Hides a digital watermark within the image @@ -13,11 +13,11 @@ Imagickwatermark_wand intoffset - + Hides a digital watermark within the image. Recover the hidden watermark later to prove that the authenticity of an image. Offset defines the start position within the image to hide the watermark. - + @@ -27,15 +27,15 @@ watermark_wand - - + + offset - - + + @@ -44,9 +44,9 @@ &reftitle.returnvalues; - + &imagick.return.success; - + diff --git a/reference/imagick/imagick/stereoimage.xml b/reference/imagick/imagick/stereoimage.xml index 48817f7b0..7364ca463 100644 --- a/reference/imagick/imagick/stereoimage.xml +++ b/reference/imagick/imagick/stereoimage.xml @@ -1,6 +1,6 @@ - + Imagick::stereoImage Composites two images @@ -12,10 +12,10 @@ public boolImagick::stereoImage Imagickoffset_wand - + Composites two images and produces a single image that is the composite of a left and right image of a stereo pair. - + @@ -25,8 +25,8 @@ offset_wand - - + + @@ -35,16 +35,16 @@ &reftitle.returnvalues; - + &imagick.return.success; - + &reftitle.errors; - + &imagick.imagick.throws; - + diff --git a/reference/imagick/imagick/stripimage.xml b/reference/imagick/imagick/stripimage.xml index 4c2f34d9b..9e2f3d888 100644 --- a/reference/imagick/imagick/stripimage.xml +++ b/reference/imagick/imagick/stripimage.xml @@ -1,6 +1,6 @@ - + Imagick::stripImage Strips an image of all profiles and comments @@ -12,9 +12,9 @@ public boolImagick::stripImage - + Strips an image of all profiles and comments. - + @@ -24,16 +24,16 @@ &reftitle.returnvalues; - + &imagick.return.success; - + &reftitle.errors; - + &imagick.imagick.throws; - + diff --git a/reference/imagick/imagick/subimagematch.xml b/reference/imagick/imagick/subimagematch.xml index 460fb0c49..b10d78508 100644 --- a/reference/imagick/imagick/subimagematch.xml +++ b/reference/imagick/imagick/subimagematch.xml @@ -15,10 +15,10 @@ arrayoffset floatsimilarity - + Searches for a subimage in the current image and returns a similarity image such that an exact match location is completely white and if none of the pixels match, black, otherwise some gray level in-between. You can also pass in the optional parameters bestMatch and similarity. After calling the function similarity will be set to the 'score' of the similarity between the subimage and the matching position in the larger image, bestMatch will contain an associative array with elements x, y, width, height that describe the matching region. - + @@ -29,25 +29,25 @@ Imagick - - - + + + offset - - - + + + similarity - + A new image that displays the amount of similarity at each pixel. - + @@ -55,9 +55,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/imagick/imagick/swirlimage.xml b/reference/imagick/imagick/swirlimage.xml index e91eaa8f8..705548387 100644 --- a/reference/imagick/imagick/swirlimage.xml +++ b/reference/imagick/imagick/swirlimage.xml @@ -1,6 +1,6 @@ - + Imagick::swirlImage Swirls the pixels about the center of the image @@ -13,11 +13,11 @@ boolImagick::swirlImage floatdegrees - + Swirls the pixels about the center of the image, where degrees indicates the sweep of the arc through which each pixel is moved. You get a more dramatic effect as the degrees move from 1 to 360. - + @@ -27,8 +27,8 @@ degrees - - + + @@ -37,16 +37,16 @@ &reftitle.returnvalues; - + &imagick.return.success; - + &reftitle.errors; - + &imagick.imagick.throws; - + diff --git a/reference/imagick/imagick/textureimage.xml b/reference/imagick/imagick/textureimage.xml index a942e652b..e793d716d 100644 --- a/reference/imagick/imagick/textureimage.xml +++ b/reference/imagick/imagick/textureimage.xml @@ -1,6 +1,6 @@ - + Imagick::textureImage Repeatedly tiles the texture image @@ -13,9 +13,9 @@ ImagickImagick::textureImage Imagicktexture_wand - + Repeatedly tiles the texture image across and down the image canvas. - + @@ -25,9 +25,9 @@ texture_wand - + Imagick object to use as texture image - + @@ -36,16 +36,16 @@ &reftitle.returnvalues; - + Returns a new Imagick object that has the repeated texture applied. - + &reftitle.errors; - + &imagick.imagick.throws; - + diff --git a/reference/imagick/imagick/thresholdimage.xml b/reference/imagick/imagick/thresholdimage.xml index 1de2afd2a..7fc68ef8e 100644 --- a/reference/imagick/imagick/thresholdimage.xml +++ b/reference/imagick/imagick/thresholdimage.xml @@ -1,6 +1,6 @@ - + Imagick::thresholdImage Changes the value of individual pixels based on a threshold @@ -13,10 +13,10 @@ floatthreshold intchannelImagick::CHANNEL_DEFAULT - + Changes the value of individual pixels based on the intensity of each pixel compared to threshold. The result is a high-contrast, two color image. - + @@ -26,15 +26,15 @@ threshold - - + + channel - - + + @@ -43,9 +43,9 @@ &reftitle.returnvalues; - + &imagick.return.success; - + diff --git a/reference/imagick/imagick/thumbnailimage.xml b/reference/imagick/imagick/thumbnailimage.xml index 9e800de38..9e4684882 100644 --- a/reference/imagick/imagick/thumbnailimage.xml +++ b/reference/imagick/imagick/thumbnailimage.xml @@ -1,6 +1,6 @@ - + Imagick::thumbnailImage Changes the size of an image @@ -16,15 +16,15 @@ boolfill&false; boollegacy&false; - + Changes the size of an image to the given dimensions and removes any associated profiles. The goal is to produce small, low cost thumbnail - images suited for display on the Web. + images suited for display on the Web. If &true; is given as a third parameter then columns and rows parameters are used as maximums for each side. Both sides will be scaled down until they match or are smaller than the parameter given for the side. - + &imagick.bestfit.note; @@ -35,42 +35,42 @@ columns - + Image width - + rows - + Image height - + bestfit - + Whether to force maximum values - + fill - + If the image does not fill the box completely then the box is filled with image's background color. - + legacy - + Round the smaller dimension down instead to the closest integer. - + @@ -79,16 +79,16 @@ &reftitle.returnvalues; - + &imagick.return.success; - + &reftitle.errors; - + &imagick.imagick.throws; - + diff --git a/reference/imagick/imagick/tintimage.xml b/reference/imagick/imagick/tintimage.xml index 3a597b6ae..57bf3176a 100644 --- a/reference/imagick/imagick/tintimage.xml +++ b/reference/imagick/imagick/tintimage.xml @@ -1,6 +1,6 @@ - + Imagick::tintImage Applies a color vector to each pixel in the image @@ -14,11 +14,11 @@ mixedopacity boollegacy&false; - + Applies a color vector to each pixel in the image. The length of the vector is 0 for black and white and at its maximum for the midtones. The vector weighing function is f(x)=(1-(4.0*((x-0.5)*(x-0.5)))). - + @@ -28,15 +28,15 @@ tint - - + + opacity - - + + @@ -45,16 +45,16 @@ &reftitle.returnvalues; - + &imagick.return.success; - + &reftitle.errors; - + &imagick.imagick.throws; - + diff --git a/reference/imagick/imagick/toString.xml b/reference/imagick/imagick/toString.xml index 74f0b2e75..edd9ab6fe 100644 --- a/reference/imagick/imagick/toString.xml +++ b/reference/imagick/imagick/toString.xml @@ -6,39 +6,39 @@ Imagick::__toString Returns the image as a string - + &reftitle.description; public stringImagick::__toString - + Returns the current image as string. This will only return a single image; it should not be used for Imagick objects that contain multiple images e.g. an animated GIF or PDF with multiple pages. - + - + &reftitle.parameters; &no.function.parameters; - + &reftitle.returnvalues; - + Returns the string content on success or an empty string on failure. - + - - + + &reftitle.seealso; Imagick::getImageBlob - Imagick::getImagesBlob + Imagick::getImagesBlob - + - + Imagick::transformImage Convenience method for setting crop size and the image geometry @@ -18,10 +18,10 @@ stringgeometry - + A convenience method for setting crop size and the image geometry from strings. &imagick.method.available.0x629; - + @@ -31,17 +31,17 @@ crop - + A crop geometry string. This geometry defines a subregion of the image to crop. - + geometry - + An image geometry string. This geometry defines the final size of the image. - + @@ -50,9 +50,9 @@ &reftitle.returnvalues; - + Returns an Imagick object containing the transformed image. - + @@ -60,9 +60,9 @@ Using <function>Imagick::transformImage</function>: - + The example creates a 100x100 black image. - + public boolImagick::transformImageColorspace intcolorspace - + Transforms an image to a new colorspace. - + @@ -26,9 +26,9 @@ colorspace - + The colorspace the image should be transformed to, one of the COLORSPACE constants e.g. Imagick::COLORSPACE_CMYK. - + @@ -36,18 +36,18 @@ &reftitle.returnvalues; - + &imagick.return.success; - + &reftitle.examples; <methodname>Imagick::transformImageColorspace</methodname> example - + Transforms an image to a new colorspace, and then extracts a single channel so that the individual channel values can be viewed. - + transformimagecolorspace($colorSpace); - //channel should be one of the channel constants e.g. \Imagick::CHANNEL_BLUE + //channel should be one of the channel constants e.g. \Imagick::CHANNEL_BLUE $imagick->separateImageChannel($channel); header("Content-Type: image/jpg"); echo $imagick->getImageBlob(); diff --git a/reference/imagick/imagick/transparentpaintimage.xml b/reference/imagick/imagick/transparentpaintimage.xml index 138f1dba0..7d4271db2 100644 --- a/reference/imagick/imagick/transparentpaintimage.xml +++ b/reference/imagick/imagick/transparentpaintimage.xml @@ -1,6 +1,6 @@ - + Imagick::transparentPaintImage Paints pixels transparent @@ -16,10 +16,10 @@ boolinvert - + Paints pixels matching the target color transparent. &imagick.method.available.0x638; - + @@ -29,33 +29,33 @@ target - + The target color to paint - + alpha - + &imagick.parameter.alpha; - + fuzz - + &imagick.parameter.fuzz; - + invert - + If &true; paints any pixel that does not match the target color. - + @@ -64,9 +64,9 @@ &reftitle.returnvalues; - + &imagick.return.success; - + diff --git a/reference/imagick/imagick/transposeimage.xml b/reference/imagick/imagick/transposeimage.xml index 748a6d954..642d7999a 100644 --- a/reference/imagick/imagick/transposeimage.xml +++ b/reference/imagick/imagick/transposeimage.xml @@ -1,6 +1,6 @@ - + Imagick::transposeImage Creates a vertical mirror image @@ -13,11 +13,11 @@ - - Creates a vertical mirror image by reflecting the pixels + + Creates a vertical mirror image by reflecting the pixels around the central x-axis while rotating them 90-degrees. &imagick.method.available.0x629; - + @@ -27,9 +27,9 @@ &reftitle.returnvalues; - + &imagick.return.success; - + @@ -62,7 +62,7 @@ function transposeImage($imagePath) { - + - + Imagick::transverseImage Creates a horizontal mirror image @@ -13,11 +13,11 @@ - + Creates a horizontal mirror image by reflecting the pixels around the central y-axis while rotating them 270-degrees. &imagick.method.available.0x629; - + @@ -27,9 +27,9 @@ &reftitle.returnvalues; - + &imagick.return.success; - + diff --git a/reference/imagick/imagick/trimimage.xml b/reference/imagick/imagick/trimimage.xml index 94efd9752..e239d9bba 100644 --- a/reference/imagick/imagick/trimimage.xml +++ b/reference/imagick/imagick/trimimage.xml @@ -13,10 +13,10 @@ floatfuzz - - Remove edges that are the background color from the image. + + Remove edges that are the background color from the image. &imagick.method.available.0x629; - + @@ -26,13 +26,13 @@ fuzz - + By default target must match a particular pixel color exactly. However, in many cases two colors may differ by a small amount. The fuzz member of image defines how much tolerance is acceptable to consider two colors as the same. This parameter represents the variation on the quantum range. - + @@ -41,16 +41,16 @@ &reftitle.returnvalues; - + &imagick.return.success; - + &reftitle.errors; - + &imagick.imagick.throws; - + @@ -58,9 +58,9 @@ Using <function>Imagick::trimImage</function>: - + Trim an image, then display to the browser. - + - + Imagick::uniqueImageColors Discards all but one of any pixel color @@ -13,10 +13,10 @@ - - Discards all but one of any pixel color. + + Discards all but one of any pixel color. &imagick.method.available.0x629; - + @@ -26,9 +26,9 @@ &reftitle.returnvalues; - + &imagick.return.success; - + diff --git a/reference/imagick/imagick/unsharpmaskimage.xml b/reference/imagick/imagick/unsharpmaskimage.xml index 42ce66a4e..2488babcd 100644 --- a/reference/imagick/imagick/unsharpmaskimage.xml +++ b/reference/imagick/imagick/unsharpmaskimage.xml @@ -1,6 +1,6 @@ - + Imagick::unsharpMaskImage Sharpens an image @@ -16,12 +16,12 @@ floatthreshold intchannelImagick::CHANNEL_DEFAULT - + Sharpens an image. We convolve the image with a Gaussian operator of the given radius and standard deviation (sigma). For reasonable results, radius should be larger than sigma. Use a radius of 0 and Imagick::UnsharpMaskImage() selects a suitable radius for you. - + @@ -31,36 +31,36 @@ radius - - + + sigma - - + + amount - - + + threshold - - + + channel - - + + @@ -69,16 +69,16 @@ &reftitle.returnvalues; - + &imagick.return.success; - + &reftitle.errors; - + &imagick.imagick.throws; - + diff --git a/reference/imagick/imagick/valid.xml b/reference/imagick/imagick/valid.xml index 2a485d632..289068b86 100644 --- a/reference/imagick/imagick/valid.xml +++ b/reference/imagick/imagick/valid.xml @@ -1,6 +1,6 @@ - + Imagick::valid Checks if the current item is valid @@ -12,9 +12,9 @@ public boolImagick::valid - + Checks if the current item is valid. - + @@ -24,9 +24,9 @@ &reftitle.returnvalues; - + &imagick.return.success; - + diff --git a/reference/imagick/imagick/vignetteimage.xml b/reference/imagick/imagick/vignetteimage.xml index 2ed46a400..293602c79 100644 --- a/reference/imagick/imagick/vignetteimage.xml +++ b/reference/imagick/imagick/vignetteimage.xml @@ -1,6 +1,6 @@ - + Imagick::vignetteImage Adds vignette filter to the image @@ -16,10 +16,10 @@ inty - - Softens the edges of the image in vignette style. + + Softens the edges of the image in vignette style. &imagick.method.available.0x629; - + @@ -29,33 +29,33 @@ blackPoint - + The black point. - + whitePoint - + The white point - + x - + X offset of the ellipse - + y - + Y offset of the ellipse - + @@ -64,9 +64,9 @@ &reftitle.returnvalues; - + &imagick.return.success; - + @@ -100,7 +100,7 @@ function vignetteImage($imagePath, $blackPoint, $whitePoint, $x, $y) { - + - + Imagick::waveImage Applies wave filter to the image @@ -14,10 +14,10 @@ floatlength - - Applies a wave filter to the image. + + Applies a wave filter to the image. &imagick.method.available.0x629; - + @@ -27,17 +27,17 @@ amplitude - + The amplitude of the wave. - + length - + The length of the wave. - + @@ -46,16 +46,16 @@ &reftitle.returnvalues; - + &imagick.return.success; - + &reftitle.errors; - + &imagick.imagick.throws; - + diff --git a/reference/imagick/imagick/whitethresholdimage.xml b/reference/imagick/imagick/whitethresholdimage.xml index 1e6f6c6f7..aa63b0726 100644 --- a/reference/imagick/imagick/whitethresholdimage.xml +++ b/reference/imagick/imagick/whitethresholdimage.xml @@ -1,6 +1,6 @@ - + Imagick::whiteThresholdImage Force all pixels above the threshold into white @@ -12,10 +12,10 @@ public boolImagick::whiteThresholdImage mixedthreshold - + Is like Imagick::ThresholdImage() but force all pixels above the threshold into white while leaving all pixels below the threshold unchanged. - + @@ -25,8 +25,8 @@ threshold - - + + @@ -35,9 +35,9 @@ &reftitle.returnvalues; - + &imagick.return.success; - + diff --git a/reference/imagick/imagick/writeimage.xml b/reference/imagick/imagick/writeimage.xml index 8847e3f6c..c6688ec21 100644 --- a/reference/imagick/imagick/writeimage.xml +++ b/reference/imagick/imagick/writeimage.xml @@ -1,6 +1,6 @@ - + Imagick::writeImage Writes an image to the specified filename @@ -12,11 +12,11 @@ public boolImagick::writeImage stringfilenameNULL - + Writes an image to the specified filename. If the filename parameter is NULL, the image is written to the filename set by Imagick::readImage() or Imagick::setImageFilename(). - + @@ -26,12 +26,12 @@ filename - + Filename where to write the image. The extension of the filename - defines the type of the file. + defines the type of the file. Format can be forced regardless of file extension using format: prefix, for example "jpg:test.png". - + @@ -40,9 +40,9 @@ &reftitle.returnvalues; - + &imagick.return.success; - + diff --git a/reference/imagick/imagick/writeimagefile.xml b/reference/imagick/imagick/writeimagefile.xml index bd75da4f0..7cc3c898c 100644 --- a/reference/imagick/imagick/writeimagefile.xml +++ b/reference/imagick/imagick/writeimagefile.xml @@ -1,6 +1,6 @@ - + Imagick::writeImageFile Writes an image to a filehandle @@ -14,10 +14,10 @@ stringformat - + Writes the image sequence to an open filehandle. The handle must be opened with for example fopen. &imagick.method.available.0x636; - + @@ -27,19 +27,19 @@ filehandle - + Filehandle where to write the image. - + format - + The image format. The list of valid format specifiers depends on the compiled feature set of ImageMagick, and can be queried at runtime via Imagick::queryFormats. - + @@ -48,9 +48,9 @@ &reftitle.returnvalues; - + &imagick.return.success; - + diff --git a/reference/imagick/imagick/writeimages.xml b/reference/imagick/imagick/writeimages.xml index ab931e352..3e3d73752 100644 --- a/reference/imagick/imagick/writeimages.xml +++ b/reference/imagick/imagick/writeimages.xml @@ -1,6 +1,6 @@ - + Imagick::writeImages Writes an image or image sequence @@ -13,9 +13,9 @@ stringfilename booladjoin - + Writes an image or image sequence. - + @@ -25,15 +25,15 @@ filename - - + + adjoin - - + + @@ -42,9 +42,9 @@ &reftitle.returnvalues; - + &imagick.return.success; - + diff --git a/reference/imagick/imagick/writeimagesfile.xml b/reference/imagick/imagick/writeimagesfile.xml index 5145f3729..e453f740c 100644 --- a/reference/imagick/imagick/writeimagesfile.xml +++ b/reference/imagick/imagick/writeimagesfile.xml @@ -1,6 +1,6 @@ - + Imagick::writeImagesFile Writes frames to a filehandle @@ -14,11 +14,11 @@ stringformat - + Writes all image frames into an open filehandle. This method can be used to write animated gifs or other multiframe images into open filehandle. &imagick.method.available.0x636; - + @@ -28,19 +28,19 @@ filehandle - + Filehandle where to write the images. - + format - + The image format. The list of valid format specifiers depends on the compiled feature set of ImageMagick, and can be queried at runtime via Imagick::queryFormats. - + @@ -49,9 +49,9 @@ &reftitle.returnvalues; - + &imagick.return.success; - + diff --git a/reference/imagick/imagickdraw/affine.xml b/reference/imagick/imagickdraw/affine.xml index 459783554..238e22625 100644 --- a/reference/imagick/imagickdraw/affine.xml +++ b/reference/imagick/imagickdraw/affine.xml @@ -13,10 +13,10 @@ arrayaffine &warn.undocumented.func; - + Adjusts the current affine transformation matrix with the specified affine transformation matrix. - + @@ -26,9 +26,9 @@ affine - + Affine matrix parameters - + @@ -37,9 +37,9 @@ &reftitle.returnvalues; - + &return.void; - + @@ -101,7 +101,7 @@ function affine($strokeColor, $fillColor, $backgroundColor) { $image->newImage(500, 750, $backgroundColor); $image->setImageFormat("png"); - //Render the draw commands in the ImagickDraw object + //Render the draw commands in the ImagickDraw object //into the image. $image->drawImage($draw); diff --git a/reference/imagick/imagickdraw/annotation.xml b/reference/imagick/imagickdraw/annotation.xml index fb7cceabb..a55eb08e8 100644 --- a/reference/imagick/imagickdraw/annotation.xml +++ b/reference/imagick/imagickdraw/annotation.xml @@ -1,6 +1,6 @@ - + ImagickDraw::annotation Draws text on the image @@ -15,9 +15,9 @@ stringtext &warn.undocumented.func; - + Draws text on the image. - + @@ -27,25 +27,25 @@ x - + The x coordinate where text is drawn - + y - + The y coordinate where text is drawn - + text - + The text to draw on the image - + @@ -54,9 +54,9 @@ &reftitle.returnvalues; - + &return.void; - + diff --git a/reference/imagick/imagickdraw/arc.xml b/reference/imagick/imagickdraw/arc.xml index 09a2c4b0a..9aed91198 100644 --- a/reference/imagick/imagickdraw/arc.xml +++ b/reference/imagick/imagickdraw/arc.xml @@ -1,6 +1,6 @@ - + ImagickDraw::arc Draws an arc @@ -18,9 +18,9 @@ floatend_angle &warn.undocumented.func; - + Draws an arc falling within a specified bounding rectangle on the image. - + @@ -30,49 +30,49 @@ start_x - + Starting x ordinate of bounding rectangle - + start_y - + starting y ordinate of bounding rectangle - + end_x - + ending x ordinate of bounding rectangle - + end_y - + ending y ordinate of bounding rectangle - + start_angle - + starting degrees of rotation - + end_angle - + ending degrees of rotation - + @@ -81,9 +81,9 @@ &reftitle.returnvalues; - + &return.void; - + @@ -110,7 +110,7 @@ function arc($strokeColor, $fillColor, $backgroundColor, $startX, $startY, $endX $image->newImage(IMAGE_WIDTH, IMAGE_HEIGHT, $backgroundColor); $image->setImageFormat("png"); - //Render the draw commands in the ImagickDraw object + //Render the draw commands in the ImagickDraw object //into the image. $image->drawImage($draw); diff --git a/reference/imagick/imagickdraw/bezier.xml b/reference/imagick/imagickdraw/bezier.xml index 85731ffab..3c6c8fe18 100644 --- a/reference/imagick/imagickdraw/bezier.xml +++ b/reference/imagick/imagickdraw/bezier.xml @@ -1,6 +1,6 @@ - + ImagickDraw::bezier Draws a bezier curve @@ -13,9 +13,9 @@ arraycoordinates &warn.undocumented.func; - + Draws a bezier curve through a set of points on the image. - + @@ -25,10 +25,10 @@ coordinates - - Multidimensional array like array( array( 'x' => 1, 'y' => 2 ), + + Multidimensional array like array( array( 'x' => 1, 'y' => 2 ), array( 'x' => 3, 'y' => 4 ) ) - + @@ -37,9 +37,9 @@ &reftitle.returnvalues; - + &return.void; - + @@ -69,7 +69,7 @@ function bezier($strokeColor, $fillColor, $backgroundColor) { ['x' => 30.0 * 5, 'y' => 90.0 * 5], ['x' => 25.0 * 5, 'y' => 10.0 * 5], ['x' => 50.0 * 5, 'y' => 50.0 * 5], - ], + ], [ ['x' => 50.0 * 5, 'y' => 50.0 * 5], ['x' => 75.0 * 5, 'y' => 90.0 * 5], @@ -84,13 +84,13 @@ function bezier($strokeColor, $fillColor, $backgroundColor) { $disjointPoints = [ [ - ['x' => 10 * 5, 'y' => 10 * 5], - ['x' => 30 * 5, 'y' => 90 * 5], + ['x' => 10 * 5, 'y' => 10 * 5], + ['x' => 30 * 5, 'y' => 90 * 5], ['x' => 25 * 5, 'y' => 10 * 5], ['x' => 50 * 5, 'y' => 50 * 5], ], [ - ['x' => 50 * 5, 'y' => 50 * 5], + ['x' => 50 * 5, 'y' => 50 * 5], ['x' => 80 * 5, 'y' => 50 * 5], ['x' => 70 * 5, 'y' => 10 * 5], ['x' => 90 * 5, 'y' => 40 * 5], @@ -107,7 +107,7 @@ function bezier($strokeColor, $fillColor, $backgroundColor) { $imagick->newImage(500, 500, $backgroundColor); $imagick->setImageFormat("png"); - //Render the draw commands in the ImagickDraw object + //Render the draw commands in the ImagickDraw object //into the image. $imagick->drawImage($draw); diff --git a/reference/imagick/imagickdraw/circle.xml b/reference/imagick/imagickdraw/circle.xml index 7a4f92fec..16e0710b6 100644 --- a/reference/imagick/imagickdraw/circle.xml +++ b/reference/imagick/imagickdraw/circle.xml @@ -1,6 +1,6 @@ - + ImagickDraw::circle Draws a circle @@ -16,9 +16,9 @@ floatperimeter_y &warn.undocumented.func; - + Draws a circle on the image. - + @@ -28,33 +28,33 @@ origin_x - + origin x coordinate - + origin_y - + origin y coordinate - + perimeter_x - + perimeter x coordinate - + perimeter_y - + perimeter y coordinate - + @@ -63,9 +63,9 @@ &reftitle.returnvalues; - + &return.void; - + diff --git a/reference/imagick/imagickdraw/clear.xml b/reference/imagick/imagickdraw/clear.xml index d506ffcc0..b37c6c342 100644 --- a/reference/imagick/imagickdraw/clear.xml +++ b/reference/imagick/imagickdraw/clear.xml @@ -1,6 +1,6 @@ - + ImagickDraw::clear Clears the ImagickDraw @@ -13,17 +13,17 @@ &warn.undocumented.func; - + Clears the ImagickDraw object of any accumulated commands, and resets the settings it contains to their defaults. - + &reftitle.returnvalues; - + Returns an ImagickDraw object. - + diff --git a/reference/imagick/imagickdraw/clone.xml b/reference/imagick/imagickdraw/clone.xml index 3543304ef..ae4e2803c 100644 --- a/reference/imagick/imagickdraw/clone.xml +++ b/reference/imagick/imagickdraw/clone.xml @@ -1,6 +1,6 @@ - + ImagickDraw::clone Makes an exact copy of the specified ImagickDraw object @@ -13,16 +13,16 @@ &warn.undocumented.func; - + Makes an exact copy of the specified ImagickDraw object. - + &reftitle.returnvalues; - + returns an exact copy of the specified ImagickDraw object. - + diff --git a/reference/imagick/imagickdraw/color.xml b/reference/imagick/imagickdraw/color.xml index 72b78a734..6ba952500 100644 --- a/reference/imagick/imagickdraw/color.xml +++ b/reference/imagick/imagickdraw/color.xml @@ -1,6 +1,6 @@ - + ImagickDraw::color Draws color on image @@ -15,10 +15,10 @@ intpaint &warn.undocumented.func; - + Draws color on image using the current fill color, starting at specified position, and using specified paint method. - + @@ -28,26 +28,26 @@ x - + x coordinate of the paint - + y - + y coordinate of the paint - + paint - + One of the PAINT constant (imagick::PAINT_*). - + @@ -56,9 +56,9 @@ &reftitle.returnvalues; - + &return.void; - + diff --git a/reference/imagick/imagickdraw/comment.xml b/reference/imagick/imagickdraw/comment.xml index 258d79df2..68c3311d1 100644 --- a/reference/imagick/imagickdraw/comment.xml +++ b/reference/imagick/imagickdraw/comment.xml @@ -1,6 +1,6 @@ - + ImagickDraw::comment Adds a comment @@ -13,9 +13,9 @@ stringcomment &warn.undocumented.func; - + Adds a comment to a vector output stream. - + @@ -25,9 +25,9 @@ comment - + The comment string to add to vector output stream - + @@ -36,9 +36,9 @@ &reftitle.returnvalues; - + &return.void; - + diff --git a/reference/imagick/imagickdraw/composite.xml b/reference/imagick/imagickdraw/composite.xml index 5257e1c2a..4cef6ca0c 100644 --- a/reference/imagick/imagickdraw/composite.xml +++ b/reference/imagick/imagickdraw/composite.xml @@ -1,6 +1,6 @@ - + ImagickDraw::composite Composites an image onto the current image @@ -18,10 +18,10 @@ Imagickimage &warn.undocumented.func; - + Composites an image onto the current image, using the specified composition operator, specified position, and at the specified size. - + @@ -31,51 +31,51 @@ composite - + composition operator. One of the Composite Operator constant (imagick::COMPOSITE_*). - + x - + x coordinate of the top left corner. - + y - + y coordinate of the top left corner. - + width - + width of the composition image. - + height - + height of the composition image. - + image - + the Imagick object where composition image is taken from. - + @@ -84,9 +84,9 @@ &reftitle.returnvalues; - + &imagick.return.success; - + @@ -121,7 +121,7 @@ function composite($strokeColor, $fillColor, $backgroundColor) { $imagick->newImage(1000, 302, $backgroundColor); $imagick->setImageFormat("png"); - //Render the draw commands in the ImagickDraw object + //Render the draw commands in the ImagickDraw object //into the image. $imagick->drawImage($draw); diff --git a/reference/imagick/imagickdraw/construct.xml b/reference/imagick/imagickdraw/construct.xml index 25d8af7b2..1ab6a1f6e 100644 --- a/reference/imagick/imagickdraw/construct.xml +++ b/reference/imagick/imagickdraw/construct.xml @@ -1,6 +1,6 @@ - + ImagickDraw::__construct The ImagickDraw constructor @@ -13,16 +13,16 @@ &warn.undocumented.func; - + The ImagickDraw constructor. - + &reftitle.returnvalues; - + &return.void; - + diff --git a/reference/imagick/imagickdraw/destroy.xml b/reference/imagick/imagickdraw/destroy.xml index d0fb6d627..09def6aad 100644 --- a/reference/imagick/imagickdraw/destroy.xml +++ b/reference/imagick/imagickdraw/destroy.xml @@ -1,6 +1,6 @@ - + ImagickDraw::destroy Frees all associated resources @@ -13,16 +13,16 @@ &warn.undocumented.func; - + Frees all resources associated with the ImagickDraw object. - + &reftitle.returnvalues; - + &return.void; - + diff --git a/reference/imagick/imagickdraw/ellipse.xml b/reference/imagick/imagickdraw/ellipse.xml index 5f6dd3090..66c696574 100644 --- a/reference/imagick/imagickdraw/ellipse.xml +++ b/reference/imagick/imagickdraw/ellipse.xml @@ -1,6 +1,6 @@ - + ImagickDraw::ellipse Draws an ellipse on the image @@ -18,9 +18,9 @@ floatangle_end &warn.undocumented.func; - + Draws an ellipse on the image. - + @@ -30,43 +30,43 @@ origin_x - - + + origin_y - - + + radius_x - - + + radius_y - - + + angle_start - - + + angle_end - - + + @@ -75,9 +75,9 @@ &reftitle.returnvalues; - + &return.void; - + diff --git a/reference/imagick/imagickdraw/getclippath.xml b/reference/imagick/imagickdraw/getclippath.xml index 885fa4593..9e8081c1d 100644 --- a/reference/imagick/imagickdraw/getclippath.xml +++ b/reference/imagick/imagickdraw/getclippath.xml @@ -1,6 +1,6 @@ - + ImagickDraw::getClipPath Obtains the current clipping path ID @@ -13,16 +13,16 @@ &warn.undocumented.func; - + Obtains the current clipping path ID. - + &reftitle.returnvalues; - + Returns a string containing the clip path ID or false if no clip path exists. - + diff --git a/reference/imagick/imagickdraw/getcliprule.xml b/reference/imagick/imagickdraw/getcliprule.xml index 00fe8665e..5e10a0106 100644 --- a/reference/imagick/imagickdraw/getcliprule.xml +++ b/reference/imagick/imagickdraw/getcliprule.xml @@ -1,6 +1,6 @@ - + ImagickDraw::getClipRule Returns the current polygon fill rule @@ -13,17 +13,17 @@ &warn.undocumented.func; - + Returns the current polygon fill rule to be used by the clipping path. - + &reftitle.returnvalues; - + Returns a FILLRULE constant - (imagick::FILLRULE_*). - + (imagick::FILLRULE_*). + diff --git a/reference/imagick/imagickdraw/getclipunits.xml b/reference/imagick/imagickdraw/getclipunits.xml index 8c1074c7f..1f36989a7 100644 --- a/reference/imagick/imagickdraw/getclipunits.xml +++ b/reference/imagick/imagickdraw/getclipunits.xml @@ -1,6 +1,6 @@ - + ImagickDraw::getClipUnits Returns the interpretation of clip path units @@ -13,16 +13,16 @@ &warn.undocumented.func; - + Returns the interpretation of clip path units. - + &reftitle.returnvalues; - + Returns an &integer; on success. - + diff --git a/reference/imagick/imagickdraw/getfillcolor.xml b/reference/imagick/imagickdraw/getfillcolor.xml index 7dea0ec16..c2516e914 100644 --- a/reference/imagick/imagickdraw/getfillcolor.xml +++ b/reference/imagick/imagickdraw/getfillcolor.xml @@ -1,6 +1,6 @@ - + ImagickDraw::getFillColor Returns the fill color @@ -13,16 +13,16 @@ &warn.undocumented.func; - + Returns the fill color used for drawing filled objects. - + &reftitle.returnvalues; - + Returns an ImagickPixel object. - + diff --git a/reference/imagick/imagickdraw/getfillopacity.xml b/reference/imagick/imagickdraw/getfillopacity.xml index f8e0452b4..4cba90f5d 100644 --- a/reference/imagick/imagickdraw/getfillopacity.xml +++ b/reference/imagick/imagickdraw/getfillopacity.xml @@ -1,6 +1,6 @@ - + ImagickDraw::getFillOpacity Returns the opacity used when drawing @@ -13,17 +13,17 @@ &warn.undocumented.func; - + Returns the opacity used when drawing using the fill color or fill texture. Fully opaque is 1.0. - + &reftitle.returnvalues; - - The opacity. - + + The opacity. + diff --git a/reference/imagick/imagickdraw/getfillrule.xml b/reference/imagick/imagickdraw/getfillrule.xml index 2bafde31d..8a09f674e 100644 --- a/reference/imagick/imagickdraw/getfillrule.xml +++ b/reference/imagick/imagickdraw/getfillrule.xml @@ -1,11 +1,11 @@ - + ImagickDraw::getFillRule Returns the fill rule - + &reftitle.description; @@ -13,19 +13,19 @@ &warn.undocumented.func; - + Returns the fill rule used while drawing polygons. - + - + &reftitle.returnvalues; - + Returns a FILLRULE constant (imagick::FILLRULE_*). - + - + - + ImagickDraw::getFont Returns the font @@ -13,16 +13,16 @@ &warn.undocumented.func; - - Returns a string specifying the font used when annotating with text. - + + Returns a string specifying the font used when annotating with text. + &reftitle.returnvalues; - + Returns a string on success and false if no font is set. - + diff --git a/reference/imagick/imagickdraw/getfontfamily.xml b/reference/imagick/imagickdraw/getfontfamily.xml index 4f7830729..a9b416c11 100644 --- a/reference/imagick/imagickdraw/getfontfamily.xml +++ b/reference/imagick/imagickdraw/getfontfamily.xml @@ -1,6 +1,6 @@ - + ImagickDraw::getFontFamily Returns the font family @@ -13,16 +13,16 @@ &warn.undocumented.func; - + Returns the font family to use when annotating with text. - + &reftitle.returnvalues; - - Returns the font family currently selected or false if font family is not set. - + + Returns the font family currently selected or false if font family is not set. + diff --git a/reference/imagick/imagickdraw/getfontsize.xml b/reference/imagick/imagickdraw/getfontsize.xml index a8a76e306..489855fd3 100644 --- a/reference/imagick/imagickdraw/getfontsize.xml +++ b/reference/imagick/imagickdraw/getfontsize.xml @@ -1,6 +1,6 @@ - + ImagickDraw::getFontSize Returns the font pointsize @@ -13,16 +13,16 @@ &warn.undocumented.func; - + Returns the font pointsize used when annotating with text. - + &reftitle.returnvalues; - + Returns the font size associated with the current ImagickDraw object. - + diff --git a/reference/imagick/imagickdraw/getfontstretch.xml b/reference/imagick/imagickdraw/getfontstretch.xml index 856efd618..85c5d54bd 100644 --- a/reference/imagick/imagickdraw/getfontstretch.xml +++ b/reference/imagick/imagickdraw/getfontstretch.xml @@ -13,9 +13,9 @@ public intImagickDraw::getFontStretch - + Gets the font stretch to use when annotating with text. Returns a StretchType. - + @@ -26,9 +26,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/imagick/imagickdraw/getfontstyle.xml b/reference/imagick/imagickdraw/getfontstyle.xml index 456e47028..2162cae37 100644 --- a/reference/imagick/imagickdraw/getfontstyle.xml +++ b/reference/imagick/imagickdraw/getfontstyle.xml @@ -1,6 +1,6 @@ - + ImagickDraw::getFontStyle Returns the font style @@ -13,18 +13,18 @@ &warn.undocumented.func; - + Returns the font style used when annotating with text. - + &reftitle.returnvalues; - + Returns a STYLE constant - (imagick::STYLE_*) associated with the ImagickDraw object + (imagick::STYLE_*) associated with the ImagickDraw object or 0 if no style is set. - + diff --git a/reference/imagick/imagickdraw/getfontweight.xml b/reference/imagick/imagickdraw/getfontweight.xml index b4e1b6351..7ddf08a09 100644 --- a/reference/imagick/imagickdraw/getfontweight.xml +++ b/reference/imagick/imagickdraw/getfontweight.xml @@ -1,6 +1,6 @@ - + ImagickDraw::getFontWeight Returns the font weight @@ -13,16 +13,16 @@ &warn.undocumented.func; - + Returns the font weight used when annotating with text. - + &reftitle.returnvalues; - + Returns an &integer; on success and 0 if no weight is set. - + diff --git a/reference/imagick/imagickdraw/getgravity.xml b/reference/imagick/imagickdraw/getgravity.xml index 3ea5eeab3..905d9b18d 100644 --- a/reference/imagick/imagickdraw/getgravity.xml +++ b/reference/imagick/imagickdraw/getgravity.xml @@ -1,6 +1,6 @@ - + ImagickDraw::getGravity Returns the text placement gravity @@ -13,17 +13,17 @@ &warn.undocumented.func; - + Returns the text placement gravity used when annotating with text. - + &reftitle.returnvalues; - + Returns a GRAVITY constant (imagick::GRAVITY_*) on success and 0 if no gravity is set. - + diff --git a/reference/imagick/imagickdraw/getstrokeantialias.xml b/reference/imagick/imagickdraw/getstrokeantialias.xml index 1ebc04a0a..aa288a77d 100644 --- a/reference/imagick/imagickdraw/getstrokeantialias.xml +++ b/reference/imagick/imagickdraw/getstrokeantialias.xml @@ -1,6 +1,6 @@ - + ImagickDraw::getStrokeAntialias Returns the current stroke antialias setting @@ -13,19 +13,19 @@ &warn.undocumented.func; - + Returns the current stroke antialias setting. Stroked outlines are antialiased by default. When antialiasing is disabled stroked pixels are thresholded to determine if the stroke color or underlying canvas color should be used. - + &reftitle.returnvalues; - + Returns &true; if antialiasing is on and &false; if it is off. - + diff --git a/reference/imagick/imagickdraw/getstrokecolor.xml b/reference/imagick/imagickdraw/getstrokecolor.xml index e850b4960..fa264ea57 100644 --- a/reference/imagick/imagickdraw/getstrokecolor.xml +++ b/reference/imagick/imagickdraw/getstrokecolor.xml @@ -1,6 +1,6 @@ - + ImagickDraw::getStrokeColor Returns the color used for stroking object outlines @@ -13,9 +13,9 @@ &warn.undocumented.func; - + Returns the color used for stroking object outlines. - + @@ -25,8 +25,8 @@ stroke_color - - + + @@ -35,9 +35,9 @@ &reftitle.returnvalues; - + Returns an ImagickPixel object which describes the color. - + diff --git a/reference/imagick/imagickdraw/getstrokedasharray.xml b/reference/imagick/imagickdraw/getstrokedasharray.xml index 492155545..d3d020de6 100644 --- a/reference/imagick/imagickdraw/getstrokedasharray.xml +++ b/reference/imagick/imagickdraw/getstrokedasharray.xml @@ -1,6 +1,6 @@ - + ImagickDraw::getStrokeDashArray Returns an array representing the pattern of dashes and gaps used to stroke paths @@ -13,17 +13,17 @@ &warn.undocumented.func; - + Returns an array representing the pattern of dashes and gaps used to stroke paths. - + &reftitle.returnvalues; - + Returns an array on success and empty array if not set. - + diff --git a/reference/imagick/imagickdraw/getstrokedashoffset.xml b/reference/imagick/imagickdraw/getstrokedashoffset.xml index c325e2dc5..25d772673 100644 --- a/reference/imagick/imagickdraw/getstrokedashoffset.xml +++ b/reference/imagick/imagickdraw/getstrokedashoffset.xml @@ -1,6 +1,6 @@ - + ImagickDraw::getStrokeDashOffset Returns the offset into the dash pattern to start the dash @@ -13,16 +13,16 @@ &warn.undocumented.func; - + Returns the offset into the dash pattern to start the dash. - + &reftitle.returnvalues; - + Returns a float representing the offset and 0 if it's not set. - + diff --git a/reference/imagick/imagickdraw/getstrokelinecap.xml b/reference/imagick/imagickdraw/getstrokelinecap.xml index f02f3d963..583d67e4a 100644 --- a/reference/imagick/imagickdraw/getstrokelinecap.xml +++ b/reference/imagick/imagickdraw/getstrokelinecap.xml @@ -1,6 +1,6 @@ - + ImagickDraw::getStrokeLineCap Returns the shape to be used at the end of open subpaths when they are stroked @@ -13,18 +13,18 @@ &warn.undocumented.func; - + Returns the shape to be used at the end of open subpaths when they are stroked. - + &reftitle.returnvalues; - + Returns a LINECAP constant (imagick::LINECAP_*), or 0 if stroke linecap is not set. - + diff --git a/reference/imagick/imagickdraw/getstrokelinejoin.xml b/reference/imagick/imagickdraw/getstrokelinejoin.xml index 6533b30bf..1acc5981c 100644 --- a/reference/imagick/imagickdraw/getstrokelinejoin.xml +++ b/reference/imagick/imagickdraw/getstrokelinejoin.xml @@ -1,6 +1,6 @@ - + ImagickDraw::getStrokeLineJoin Returns the shape to be used at the corners of paths when they are stroked @@ -13,18 +13,18 @@ &warn.undocumented.func; - + Returns the shape to be used at the corners of paths (or other vector shapes) when they are stroked. - + &reftitle.returnvalues; - + Returns a LINEJOIN constant (imagick::LINEJOIN_*), or 0 if stroke line join is not set. - + diff --git a/reference/imagick/imagickdraw/getstrokemiterlimit.xml b/reference/imagick/imagickdraw/getstrokemiterlimit.xml index 981a87e20..6377d4fcc 100644 --- a/reference/imagick/imagickdraw/getstrokemiterlimit.xml +++ b/reference/imagick/imagickdraw/getstrokemiterlimit.xml @@ -1,6 +1,6 @@ - + ImagickDraw::getStrokeMiterLimit Returns the stroke miter limit @@ -13,21 +13,21 @@ &warn.undocumented.func; - + Returns the miter limit. When two line segments meet at a sharp angle and miter joins have been specified for 'lineJoin', it is possible for the miter to extend far beyond the thickness of the line stroking the path. The 'miterLimit' imposes a limit on the ratio of the miter length to the 'lineWidth'. - + &reftitle.returnvalues; - + Returns an int describing the miter limit and 0 if no miter limit is set. - + diff --git a/reference/imagick/imagickdraw/getstrokeopacity.xml b/reference/imagick/imagickdraw/getstrokeopacity.xml index 5a3be46fd..f418a0f47 100644 --- a/reference/imagick/imagickdraw/getstrokeopacity.xml +++ b/reference/imagick/imagickdraw/getstrokeopacity.xml @@ -1,6 +1,6 @@ - + ImagickDraw::getStrokeOpacity Returns the opacity of stroked object outlines @@ -13,16 +13,16 @@ &warn.undocumented.func; - + Returns the opacity of stroked object outlines. - + &reftitle.returnvalues; - + Returns a float describing the opacity. - + diff --git a/reference/imagick/imagickdraw/getstrokewidth.xml b/reference/imagick/imagickdraw/getstrokewidth.xml index 0bd80c71b..72a507e4d 100644 --- a/reference/imagick/imagickdraw/getstrokewidth.xml +++ b/reference/imagick/imagickdraw/getstrokewidth.xml @@ -1,6 +1,6 @@ - + ImagickDraw::getStrokeWidth Returns the width of the stroke used to draw object outlines @@ -13,16 +13,16 @@ &warn.undocumented.func; - + Returns the width of the stroke used to draw object outlines. - + &reftitle.returnvalues; - + Returns a float describing the stroke width. - + diff --git a/reference/imagick/imagickdraw/gettextalignment.xml b/reference/imagick/imagickdraw/gettextalignment.xml index 8010beb47..bf61833d5 100644 --- a/reference/imagick/imagickdraw/gettextalignment.xml +++ b/reference/imagick/imagickdraw/gettextalignment.xml @@ -1,6 +1,6 @@ - + ImagickDraw::getTextAlignment Returns the text alignment @@ -13,17 +13,17 @@ &warn.undocumented.func; - + Returns the alignment applied when annotating with text. - + &reftitle.returnvalues; - + Returns a ALIGN constant (imagick::ALIGN_*), and 0 if no align is set. - + diff --git a/reference/imagick/imagickdraw/gettextantialias.xml b/reference/imagick/imagickdraw/gettextantialias.xml index e20979e34..9db4298ff 100644 --- a/reference/imagick/imagickdraw/gettextantialias.xml +++ b/reference/imagick/imagickdraw/gettextantialias.xml @@ -1,6 +1,6 @@ - + ImagickDraw::getTextAntialias Returns the current text antialias setting @@ -13,17 +13,17 @@ &warn.undocumented.func; - + Returns the current text antialias setting, which determines whether text is antialiased. Text is antialiased by default. - + &reftitle.returnvalues; - + Returns &true; if text is antialiased and &false; if not. - + diff --git a/reference/imagick/imagickdraw/gettextdecoration.xml b/reference/imagick/imagickdraw/gettextdecoration.xml index a7fe9aea3..7c5e90074 100644 --- a/reference/imagick/imagickdraw/gettextdecoration.xml +++ b/reference/imagick/imagickdraw/gettextdecoration.xml @@ -1,6 +1,6 @@ - + ImagickDraw::getTextDecoration Returns the text decoration @@ -13,17 +13,17 @@ &warn.undocumented.func; - + Returns the decoration applied when annotating with text. - + &reftitle.returnvalues; - + Returns a DECORATION constant (imagick::DECORATION_*), and 0 if no decoration is set. - + diff --git a/reference/imagick/imagickdraw/gettextencoding.xml b/reference/imagick/imagickdraw/gettextencoding.xml index 8e66dfadd..1c542e887 100644 --- a/reference/imagick/imagickdraw/gettextencoding.xml +++ b/reference/imagick/imagickdraw/gettextencoding.xml @@ -1,6 +1,6 @@ - + ImagickDraw::getTextEncoding Returns the code set used for text annotations @@ -13,17 +13,17 @@ &warn.undocumented.func; - + Returns a string which specifies the code set used for text annotations. - + &reftitle.returnvalues; - + Returns a string specifying the code set or false if text encoding is not set. - + diff --git a/reference/imagick/imagickdraw/gettextinterlinespacing.xml b/reference/imagick/imagickdraw/gettextinterlinespacing.xml index 6a54ce83c..6ef905e10 100644 --- a/reference/imagick/imagickdraw/gettextinterlinespacing.xml +++ b/reference/imagick/imagickdraw/gettextinterlinespacing.xml @@ -13,9 +13,9 @@ public floatImagickDraw::getTextInterlineSpacing - + Gets the text interline spacing. - + @@ -25,9 +25,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/imagick/imagickdraw/gettextinterwordspacing.xml b/reference/imagick/imagickdraw/gettextinterwordspacing.xml index af8b6c0f2..9174ef7a2 100644 --- a/reference/imagick/imagickdraw/gettextinterwordspacing.xml +++ b/reference/imagick/imagickdraw/gettextinterwordspacing.xml @@ -13,9 +13,9 @@ public floatImagickDraw::getTextInterwordSpacing - + Gets the text interword spacing. - + @@ -27,9 +27,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/imagick/imagickdraw/gettextkerning.xml b/reference/imagick/imagickdraw/gettextkerning.xml index db5c2f92a..dda402e39 100644 --- a/reference/imagick/imagickdraw/gettextkerning.xml +++ b/reference/imagick/imagickdraw/gettextkerning.xml @@ -13,9 +13,9 @@ public floatImagickDraw::getTextKerning - + Gets the text kerning. - + @@ -26,9 +26,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/imagick/imagickdraw/gettextundercolor.xml b/reference/imagick/imagickdraw/gettextundercolor.xml index bb4950443..c3c620a7a 100644 --- a/reference/imagick/imagickdraw/gettextundercolor.xml +++ b/reference/imagick/imagickdraw/gettextundercolor.xml @@ -1,6 +1,6 @@ - + ImagickDraw::getTextUnderColor Returns the text under color @@ -13,16 +13,16 @@ &warn.undocumented.func; - + Returns the color of a background rectangle to place under text annotations. - + &reftitle.returnvalues; - + Returns an ImagickPixel object describing the color. - + diff --git a/reference/imagick/imagickdraw/getvectorgraphics.xml b/reference/imagick/imagickdraw/getvectorgraphics.xml index 86b06878c..1f2d6231e 100644 --- a/reference/imagick/imagickdraw/getvectorgraphics.xml +++ b/reference/imagick/imagickdraw/getvectorgraphics.xml @@ -1,6 +1,6 @@ - + ImagickDraw::getVectorGraphics Returns a string containing vector graphics @@ -13,17 +13,17 @@ &warn.undocumented.func; - + Returns a string which specifies the vector graphics generated by any - graphics calls made since the ImagickDraw object was instantiated. - + graphics calls made since the ImagickDraw object was instantiated. + &reftitle.returnvalues; - + Returns a string containing the vector graphics. - + diff --git a/reference/imagick/imagickdraw/line.xml b/reference/imagick/imagickdraw/line.xml index 5c7d669a6..ddd57979b 100644 --- a/reference/imagick/imagickdraw/line.xml +++ b/reference/imagick/imagickdraw/line.xml @@ -1,6 +1,6 @@ - + ImagickDraw::line Draws a line @@ -16,9 +16,9 @@ floatend_y &warn.undocumented.func; - + Draws a line on the image using the current stroke color, stroke opacity, and stroke width. - + @@ -28,33 +28,33 @@ start_x - + starting x coordinate - + start_y - + starting y coordinate - + end_x - + ending x coordinate - + end_y - + ending y coordinate - + @@ -63,9 +63,9 @@ &reftitle.returnvalues; - + &return.void; - + diff --git a/reference/imagick/imagickdraw/matte.xml b/reference/imagick/imagickdraw/matte.xml index 7b060a313..87b480baf 100644 --- a/reference/imagick/imagickdraw/matte.xml +++ b/reference/imagick/imagickdraw/matte.xml @@ -1,6 +1,6 @@ - + ImagickDraw::matte Paints on the image's opacity channel @@ -15,10 +15,10 @@ intpaint &warn.undocumented.func; - + Paints on the image's opacity channel in order to set effected pixels to transparent, to influence the opacity of pixels. - + @@ -28,26 +28,26 @@ x - + x coordinate of the matte - + y - + y coordinate of the matte - + paint - + One of the PAINT constant (imagick::PAINT_*). - + @@ -56,9 +56,9 @@ &reftitle.returnvalues; - + &return.success; - + @@ -78,7 +78,7 @@ function matte($strokeColor, $fillColor, $backgroundColor, $paintType) { $draw->setStrokeWidth(2); $draw->setFontSize(72); - $draw->matte(120, 120, $paintType); + $draw->matte(120, 120, $paintType); $draw->rectangle(100, 100, 300, 200); $imagick = new \Imagick(); diff --git a/reference/imagick/imagickdraw/pathclose.xml b/reference/imagick/imagickdraw/pathclose.xml index fa6de5c20..b588bbd08 100644 --- a/reference/imagick/imagickdraw/pathclose.xml +++ b/reference/imagick/imagickdraw/pathclose.xml @@ -1,6 +1,6 @@ - + ImagickDraw::pathClose Adds a path element to the current path @@ -13,18 +13,18 @@ &warn.undocumented.func; - + Adds a path element to the current path which closes the current subpath by drawing a straight line from the current point to the current subpath's most recent starting point (usually, the most recent moveto point). - + &reftitle.returnvalues; - + &return.void; - + diff --git a/reference/imagick/imagickdraw/pathcurvetoabsolute.xml b/reference/imagick/imagickdraw/pathcurvetoabsolute.xml index a1ccfe5be..34a5c36b9 100644 --- a/reference/imagick/imagickdraw/pathcurvetoabsolute.xml +++ b/reference/imagick/imagickdraw/pathcurvetoabsolute.xml @@ -1,6 +1,6 @@ - + ImagickDraw::pathCurveToAbsolute Draws a cubic Bezier curve @@ -18,13 +18,13 @@ floaty &warn.undocumented.func; - + Draws a cubic Bezier curve from the current point to (x,y) using (x1,y1) as the control point at the beginning of the curve and (x2,y2) as the control point at the end of the curve using absolute coordinates. At the end of the command, the new current point becomes the final (x,y) coordinate pair used in the polybezier. - + @@ -34,49 +34,49 @@ x1 - + x coordinate of the first control point - + y1 - + y coordinate of the first control point - + x2 - + x coordinate of the second control point - + y2 - + y coordinate of the first control point - + x - + x coordinate of the curve end - + y - + y coordinate of the curve end - + @@ -85,9 +85,9 @@ &reftitle.returnvalues; - + &return.void; - + diff --git a/reference/imagick/imagickdraw/pathcurvetoquadraticbezierabsolute.xml b/reference/imagick/imagickdraw/pathcurvetoquadraticbezierabsolute.xml index 632fdac2d..42aef56d6 100644 --- a/reference/imagick/imagickdraw/pathcurvetoquadraticbezierabsolute.xml +++ b/reference/imagick/imagickdraw/pathcurvetoquadraticbezierabsolute.xml @@ -1,6 +1,6 @@ - + ImagickDraw::pathCurveToQuadraticBezierAbsolute Draws a quadratic Bezier curve @@ -16,12 +16,12 @@ floaty &warn.undocumented.func; - + Draws a quadratic Bezier curve from the current point to (x,y) using (x1,y1) as the control point using absolute coordinates. At the end of the command, the new current point becomes the final (x,y) coordinate pair used in the polybezier. - + @@ -31,33 +31,33 @@ x1 - + x coordinate of the control point - + y1 - + y coordinate of the control point - + x_end - + x coordinate of the end point - + y - + y coordinate of the end point - + @@ -66,9 +66,9 @@ &reftitle.returnvalues; - + &return.void; - + @@ -96,7 +96,7 @@ function pathCurveToQuadraticBezierAbsolute($strokeColor, $fillColor, $backgroun // This specifies a quadratic bezier curve with the current position as the start // point, the control point is the first two params, and the end point is the last two params. $draw->pathCurveToQuadraticBezierAbsolute( - 150,50, + 150,50, 250,250 ); diff --git a/reference/imagick/imagickdraw/pathcurvetoquadraticbezierrelative.xml b/reference/imagick/imagickdraw/pathcurvetoquadraticbezierrelative.xml index 8373a2473..02b0ca593 100644 --- a/reference/imagick/imagickdraw/pathcurvetoquadraticbezierrelative.xml +++ b/reference/imagick/imagickdraw/pathcurvetoquadraticbezierrelative.xml @@ -1,6 +1,6 @@ - + ImagickDraw::pathCurveToQuadraticBezierRelative Draws a quadratic Bezier curve @@ -16,12 +16,12 @@ floaty &warn.undocumented.func; - + Draws a quadratic Bezier curve from the current point to (x,y) using (x1,y1) as the control point using relative coordinates. At the end of the command, the new current point becomes the final (x,y) coordinate pair used in the polybezier. - + @@ -31,33 +31,33 @@ x1 - + starting x coordinate - + y1 - + starting y coordinate - + x_end - + ending x coordinate - + y - + ending y coordinate - + @@ -66,9 +66,9 @@ &reftitle.returnvalues; - + &return.void; - + diff --git a/reference/imagick/imagickdraw/pathcurvetoquadraticbeziersmoothabsolute.xml b/reference/imagick/imagickdraw/pathcurvetoquadraticbeziersmoothabsolute.xml index da5f09f81..8bcb5281b 100644 --- a/reference/imagick/imagickdraw/pathcurvetoquadraticbeziersmoothabsolute.xml +++ b/reference/imagick/imagickdraw/pathcurvetoquadraticbeziersmoothabsolute.xml @@ -1,6 +1,6 @@ - + ImagickDraw::pathCurveToQuadraticBezierSmoothAbsolute Draws a quadratic Bezier curve @@ -13,8 +13,8 @@ floatx floaty - - + + Draws a quadratic Bezier curve (using absolute coordinates) from the current point to (x,y). The control point is assumed to be the reflection of the control point on the previous command relative to the current point. @@ -25,13 +25,13 @@ DrawPathCurveToQuadraticBezierSmoothRelative, assume the control point is coincident with the current point.). At the end of the command, the new current point becomes the final (x,y) coordinate pair used in the polybezier. - - - + + + This function cannot be used to continue a cubic Bezier curve smoothly. It can only continue from a quadratic curve smoothly. - + - + &reftitle.parameters; @@ -39,28 +39,28 @@ x - + ending x coordinate - + y - + ending y coordinate - + - + &reftitle.returnvalues; - + &return.void; - + @@ -88,7 +88,7 @@ $draw->pathMoveToAbsolute(50,250); // This specifies a quadratic bezier curve with the current position as the start // point, the control point is the first two params, and the end point is the last two params. $draw->pathCurveToQuadraticBezierAbsolute( - 150,50, + 150,50, 250,250 ); diff --git a/reference/imagick/imagickdraw/pathcurvetoquadraticbeziersmoothrelative.xml b/reference/imagick/imagickdraw/pathcurvetoquadraticbeziersmoothrelative.xml index 7e09e9665..128ad1b05 100644 --- a/reference/imagick/imagickdraw/pathcurvetoquadraticbeziersmoothrelative.xml +++ b/reference/imagick/imagickdraw/pathcurvetoquadraticbeziersmoothrelative.xml @@ -1,6 +1,6 @@ - + ImagickDraw::pathCurveToQuadraticBezierSmoothRelative Draws a quadratic Bezier curve @@ -14,23 +14,23 @@ floaty &warn.undocumented.func; - + Draws a quadratic Bezier curve (using relative coordinates) from the current point to (x, y). The control point is assumed to be the reflection of the control point on the previous command relative to the current point. (If there is no previous command or if the previous command was not a - DrawPathCurveToQuadraticBezierAbsolute, - DrawPathCurveToQuadraticBezierRelative, - DrawPathCurveToQuadraticBezierSmoothAbsolut or + DrawPathCurveToQuadraticBezierAbsolute, + DrawPathCurveToQuadraticBezierRelative, + DrawPathCurveToQuadraticBezierSmoothAbsolut or DrawPathCurveToQuadraticBezierSmoothRelative, assume the control point is coincident with the current point). At the end of the command, the new current point becomes the final (x, y) coordinate pair used in the polybezier. - - - + + + This function cannot be used to continue a cubic Bezier curve smoothly. It can only continue from a quadratic curve smoothly. - + @@ -40,17 +40,17 @@ x - + ending x coordinate - + y - + ending y coordinate - + @@ -59,9 +59,9 @@ &reftitle.returnvalues; - + &return.void; - + @@ -89,7 +89,7 @@ $draw->pathMoveToAbsolute(50,250); // This specifies a quadratic bezier curve with the current position as the start // point, the control point is the first two params, and the end point is the last two params. $draw->pathCurveToQuadraticBezierAbsolute( - 150,50, + 150,50, 250,250 ); diff --git a/reference/imagick/imagickdraw/pathcurvetorelative.xml b/reference/imagick/imagickdraw/pathcurvetorelative.xml index d9690d4f4..ddd1b4a5a 100644 --- a/reference/imagick/imagickdraw/pathcurvetorelative.xml +++ b/reference/imagick/imagickdraw/pathcurvetorelative.xml @@ -1,6 +1,6 @@ - + ImagickDraw::pathCurveToRelative Draws a cubic Bezier curve @@ -18,13 +18,13 @@ floaty &warn.undocumented.func; - + Draws a cubic Bezier curve from the current point to (x,y) using (x1,y1) as the control point at the beginning of the curve and (x2,y2) as the control point at the end of the curve using relative coordinates. At the - end of the command, the new current point becomes the final (x,y) + end of the command, the new current point becomes the final (x,y) coordinate pair used in the polybezier. - + @@ -34,49 +34,49 @@ x1 - + x coordinate of starting control point - + y1 - + y coordinate of starting control point - + x2 - + x coordinate of ending control point - + y2 - + y coordinate of ending control point - + x - + ending x coordinate - + y - + ending y coordinate - + @@ -85,9 +85,9 @@ &reftitle.returnvalues; - + &return.void; - + diff --git a/reference/imagick/imagickdraw/pathcurvetosmoothabsolute.xml b/reference/imagick/imagickdraw/pathcurvetosmoothabsolute.xml index 4240bbf8d..7de62814f 100644 --- a/reference/imagick/imagickdraw/pathcurvetosmoothabsolute.xml +++ b/reference/imagick/imagickdraw/pathcurvetosmoothabsolute.xml @@ -1,6 +1,6 @@ - + ImagickDraw::pathCurveToSmoothAbsolute Draws a cubic Bezier curve @@ -16,18 +16,18 @@ floaty &warn.undocumented.func; - + Draws a cubic Bezier curve from the current point to (x,y) using absolute coordinates. The first control point is assumed to be the reflection of the second control point on the previous command relative to the current point. - (If there is no previous command or if the previous command was not an - DrawPathCurveToAbsolute, DrawPathCurveToRelative, + (If there is no previous command or if the previous command was not an + DrawPathCurveToAbsolute, DrawPathCurveToRelative, DrawPathCurveToSmoothAbsolute or DrawPathCurveToSmoothRelative, assume the first control point is coincident with the current point.) (x2,y2) is the second control point (i.e., the control point at the end of the curve). At the end of the command, the new current point becomes the final (x,y) coordinate pair used in the polybezier. - + @@ -37,33 +37,33 @@ x2 - + x coordinate of the second control point - + y2 - + y coordinate of the second control point - + x - + x coordinate of the ending point - + y - + y coordinate of the ending point - + @@ -72,9 +72,9 @@ &reftitle.returnvalues; - + &return.void; - + diff --git a/reference/imagick/imagickdraw/pathcurvetosmoothrelative.xml b/reference/imagick/imagickdraw/pathcurvetosmoothrelative.xml index 40c75a0e2..fdb3e8b76 100644 --- a/reference/imagick/imagickdraw/pathcurvetosmoothrelative.xml +++ b/reference/imagick/imagickdraw/pathcurvetosmoothrelative.xml @@ -1,6 +1,6 @@ - + ImagickDraw::pathCurveToSmoothRelative Draws a cubic Bezier curve @@ -16,18 +16,18 @@ floaty &warn.undocumented.func; - + Draws a cubic Bezier curve from the current point to (x,y) using relative coordinates. The first control point is assumed to be the reflection of the second control point on the previous command relative to the current point. (If there is no previous command or if the previous command was not - an DrawPathCurveToAbsolute, DrawPathCurveToRelative, + an DrawPathCurveToAbsolute, DrawPathCurveToRelative, DrawPathCurveToSmoothAbsolute or DrawPathCurveToSmoothRelative, assume the first control point is coincident with the current point.) (x2,y2) is the second control point (i.e., the control point at the end of the curve). At the end of the command, the new current point becomes the final (x,y) coordinate pair used in the polybezier. - + @@ -37,33 +37,33 @@ x2 - + x coordinate of the second control point - + y2 - + y coordinate of the second control point - + x - + x coordinate of the ending point - + y - + y coordinate of the ending point - + @@ -72,9 +72,9 @@ &reftitle.returnvalues; - + &return.void; - + diff --git a/reference/imagick/imagickdraw/pathellipticarcabsolute.xml b/reference/imagick/imagickdraw/pathellipticarcabsolute.xml index 86e2c24a1..dde6e6dcc 100644 --- a/reference/imagick/imagickdraw/pathellipticarcabsolute.xml +++ b/reference/imagick/imagickdraw/pathellipticarcabsolute.xml @@ -1,6 +1,6 @@ - + ImagickDraw::pathEllipticArcAbsolute Draws an elliptical arc @@ -19,7 +19,7 @@ floaty &warn.undocumented.func; - + Draws an elliptical arc from the current point to (x, y) using absolute coordinates. The size and orientation of the ellipse are defined by two radii (rx, ry) and an xAxisRotation, which indicates how the ellipse as @@ -30,7 +30,7 @@ is drawn. If large_arc is &true; then draw the larger of the available arcs. If sweep is true, then draw the arc matching a clock-wise rotation. - + @@ -40,57 +40,57 @@ rx - + x radius - + ry - + y radius - + x_axis_rotation - + x axis rotation - + large_arc - + large arc flag - + sweep - + sweep flag - + x - + x coordinate - + y - + y coordinate - + @@ -99,9 +99,9 @@ &reftitle.returnvalues; - + &return.void; - + diff --git a/reference/imagick/imagickdraw/pathellipticarcrelative.xml b/reference/imagick/imagickdraw/pathellipticarcrelative.xml index 3a8769863..4a5a78d71 100644 --- a/reference/imagick/imagickdraw/pathellipticarcrelative.xml +++ b/reference/imagick/imagickdraw/pathellipticarcrelative.xml @@ -1,6 +1,6 @@ - + ImagickDraw::pathEllipticArcRelative Draws an elliptical arc @@ -19,7 +19,7 @@ floaty &warn.undocumented.func; - + Draws an elliptical arc from the current point to (x, y) using relative coordinates. The size and orientation of the ellipse are defined by two radii (rx, ry) and an xAxisRotation, which indicates how the ellipse as @@ -30,7 +30,7 @@ is drawn. If large_arc is &true; then draw the larger of the available arcs. If sweep is true, then draw the arc matching a clock-wise rotation. - + @@ -40,57 +40,57 @@ rx - + x radius - + ry - + y radius - + x_axis_rotation - + x axis rotation - + large_arc - + large arc flag - + sweep - + sweep flag - + x - + x coordinate - + y - + y coordinate - + @@ -99,9 +99,9 @@ &reftitle.returnvalues; - + &return.void; - + diff --git a/reference/imagick/imagickdraw/pathfinish.xml b/reference/imagick/imagickdraw/pathfinish.xml index 39a873f45..6273137bc 100644 --- a/reference/imagick/imagickdraw/pathfinish.xml +++ b/reference/imagick/imagickdraw/pathfinish.xml @@ -1,6 +1,6 @@ - + ImagickDraw::pathFinish Terminates the current path @@ -13,16 +13,16 @@ &warn.undocumented.func; - + Terminates the current path. - + &reftitle.returnvalues; - + &return.void; - + diff --git a/reference/imagick/imagickdraw/pathlinetoabsolute.xml b/reference/imagick/imagickdraw/pathlinetoabsolute.xml index 36365a0ad..6c27ed778 100644 --- a/reference/imagick/imagickdraw/pathlinetoabsolute.xml +++ b/reference/imagick/imagickdraw/pathlinetoabsolute.xml @@ -1,6 +1,6 @@ - + ImagickDraw::pathLineToAbsolute Draws a line path @@ -14,10 +14,10 @@ floaty &warn.undocumented.func; - + Draws a line path from the current point to the given coordinate using absolute coordinates. The coordinate then becomes the new current point. - + @@ -27,17 +27,17 @@ x - + starting x coordinate - + y - + ending x coordinate - + @@ -46,9 +46,9 @@ &reftitle.returnvalues; - + &return.void; - + diff --git a/reference/imagick/imagickdraw/pathlinetohorizontalabsolute.xml b/reference/imagick/imagickdraw/pathlinetohorizontalabsolute.xml index 003f1012c..b75af91c8 100644 --- a/reference/imagick/imagickdraw/pathlinetohorizontalabsolute.xml +++ b/reference/imagick/imagickdraw/pathlinetohorizontalabsolute.xml @@ -1,6 +1,6 @@ - + ImagickDraw::pathLineToHorizontalAbsolute Draws a horizontal line path @@ -13,11 +13,11 @@ floatx &warn.undocumented.func; - + Draws a horizontal line path from the current point to the target point using absolute coordinates. The target point then becomes the new current point. - + @@ -27,9 +27,9 @@ x - + x coordinate - + @@ -38,9 +38,9 @@ &reftitle.returnvalues; - + &return.void; - + diff --git a/reference/imagick/imagickdraw/pathlinetohorizontalrelative.xml b/reference/imagick/imagickdraw/pathlinetohorizontalrelative.xml index f23739af8..a5dcf00ae 100644 --- a/reference/imagick/imagickdraw/pathlinetohorizontalrelative.xml +++ b/reference/imagick/imagickdraw/pathlinetohorizontalrelative.xml @@ -1,6 +1,6 @@ - + ImagickDraw::pathLineToHorizontalRelative Draws a horizontal line @@ -13,11 +13,11 @@ floatx &warn.undocumented.func; - + Draws a horizontal line path from the current point to the target point using relative coordinates. The target point then becomes the new current point. - + @@ -27,9 +27,9 @@ x - + x coordinate - + @@ -38,9 +38,9 @@ &reftitle.returnvalues; - + &return.void; - + diff --git a/reference/imagick/imagickdraw/pathlinetorelative.xml b/reference/imagick/imagickdraw/pathlinetorelative.xml index 98cac1f63..ad1e35f96 100644 --- a/reference/imagick/imagickdraw/pathlinetorelative.xml +++ b/reference/imagick/imagickdraw/pathlinetorelative.xml @@ -1,6 +1,6 @@ - + ImagickDraw::pathLineToRelative Draws a line path @@ -14,10 +14,10 @@ floaty &warn.undocumented.func; - + Draws a line path from the current point to the given coordinate using relative coordinates. The coordinate then becomes the new current point. - + @@ -27,17 +27,17 @@ x - + starting x coordinate - + y - + starting y coordinate - + @@ -46,9 +46,9 @@ &reftitle.returnvalues; - + &return.void; - + diff --git a/reference/imagick/imagickdraw/pathlinetoverticalabsolute.xml b/reference/imagick/imagickdraw/pathlinetoverticalabsolute.xml index 07cdfcea7..ab60728dd 100644 --- a/reference/imagick/imagickdraw/pathlinetoverticalabsolute.xml +++ b/reference/imagick/imagickdraw/pathlinetoverticalabsolute.xml @@ -1,6 +1,6 @@ - + ImagickDraw::pathLineToVerticalAbsolute Draws a vertical line @@ -13,10 +13,10 @@ floaty &warn.undocumented.func; - + Draws a vertical line path from the current point to the target point using absolute coordinates. The target point then becomes the new current point. - + @@ -26,9 +26,9 @@ y - + y coordinate - + @@ -37,9 +37,9 @@ &reftitle.returnvalues; - + &return.void; - + diff --git a/reference/imagick/imagickdraw/pathlinetoverticalrelative.xml b/reference/imagick/imagickdraw/pathlinetoverticalrelative.xml index 8091d598d..030693bef 100644 --- a/reference/imagick/imagickdraw/pathlinetoverticalrelative.xml +++ b/reference/imagick/imagickdraw/pathlinetoverticalrelative.xml @@ -1,6 +1,6 @@ - + ImagickDraw::pathLineToVerticalRelative Draws a vertical line path @@ -13,10 +13,10 @@ floaty &warn.undocumented.func; - + Draws a vertical line path from the current point to the target point using relative coordinates. The target point then becomes the new current point. - + @@ -26,9 +26,9 @@ y - + y coordinate - + @@ -37,9 +37,9 @@ &reftitle.returnvalues; - + &return.void; - + diff --git a/reference/imagick/imagickdraw/pathmovetoabsolute.xml b/reference/imagick/imagickdraw/pathmovetoabsolute.xml index 4df099dcd..f1db4648d 100644 --- a/reference/imagick/imagickdraw/pathmovetoabsolute.xml +++ b/reference/imagick/imagickdraw/pathmovetoabsolute.xml @@ -1,6 +1,6 @@ - + ImagickDraw::pathMoveToAbsolute Starts a new sub-path @@ -14,10 +14,10 @@ floaty &warn.undocumented.func; - + Starts a new sub-path at the given coordinate using absolute coordinates. The current point then becomes the specified coordinate. - + @@ -27,17 +27,17 @@ x - + x coordinate of the starting point - + y - + y coordinate of the starting point - + @@ -46,9 +46,9 @@ &reftitle.returnvalues; - + &return.void; - + diff --git a/reference/imagick/imagickdraw/pathmovetorelative.xml b/reference/imagick/imagickdraw/pathmovetorelative.xml index cd0124430..8d2db4856 100644 --- a/reference/imagick/imagickdraw/pathmovetorelative.xml +++ b/reference/imagick/imagickdraw/pathmovetorelative.xml @@ -1,6 +1,6 @@ - + ImagickDraw::pathMoveToRelative Starts a new sub-path @@ -14,10 +14,10 @@ floaty &warn.undocumented.func; - + Starts a new sub-path at the given coordinate using relative coordinates. The current point then becomes the specified coordinate. - + @@ -27,17 +27,17 @@ x - + target x coordinate - + y - + target y coordinate - + @@ -46,9 +46,9 @@ &reftitle.returnvalues; - + &return.void; - + diff --git a/reference/imagick/imagickdraw/pathstart.xml b/reference/imagick/imagickdraw/pathstart.xml index 515ef5319..64a801299 100644 --- a/reference/imagick/imagickdraw/pathstart.xml +++ b/reference/imagick/imagickdraw/pathstart.xml @@ -1,6 +1,6 @@ - + ImagickDraw::pathStart Declares the start of a path drawing list @@ -13,19 +13,19 @@ &warn.undocumented.func; - + Declares the start of a path drawing list which is terminated by a matching DrawPathFinish() command. All other DrawPath commands must be enclosed between a and a DrawPathFinish() command. This is because path drawing commands are subordinate commands and they do not function by themselves. - + &reftitle.returnvalues; - + &return.void; - + diff --git a/reference/imagick/imagickdraw/point.xml b/reference/imagick/imagickdraw/point.xml index d5f1e040b..602fa7426 100644 --- a/reference/imagick/imagickdraw/point.xml +++ b/reference/imagick/imagickdraw/point.xml @@ -1,6 +1,6 @@ - + ImagickDraw::point Draws a point @@ -14,9 +14,9 @@ floaty &warn.undocumented.func; - + Draws a point using the current stroke color and stroke thickness at the specified coordinates. - + @@ -26,17 +26,17 @@ x - + point's x coordinate - + y - + point's y coordinate - + @@ -45,9 +45,9 @@ &reftitle.returnvalues; - + &return.void; - + diff --git a/reference/imagick/imagickdraw/polygon.xml b/reference/imagick/imagickdraw/polygon.xml index bf8e6837d..084952a02 100644 --- a/reference/imagick/imagickdraw/polygon.xml +++ b/reference/imagick/imagickdraw/polygon.xml @@ -1,6 +1,6 @@ - + ImagickDraw::polygon Draws a polygon @@ -13,10 +13,10 @@ arraycoordinates &warn.undocumented.func; - + Draws a polygon using the current stroke, stroke width, and fill color or texture, using the specified array of coordinates. - + @@ -26,9 +26,9 @@ coordinates - + multidimensional array like array( array( 'x' => 3, 'y' => 4 ), array( 'x' => 2, 'y' => 6 ) ); - + @@ -37,9 +37,9 @@ &reftitle.returnvalues; - + &imagick.return.success; - + @@ -62,8 +62,8 @@ function polygon($strokeColor, $fillColor, $backgroundColor) { $points = [ ['x' => 40 * 5, 'y' => 10 * 5], - ['x' => 20 * 5, 'y' => 20 * 5], - ['x' => 70 * 5, 'y' => 50 * 5], + ['x' => 20 * 5, 'y' => 20 * 5], + ['x' => 70 * 5, 'y' => 50 * 5], ['x' => 60 * 5, 'y' => 15 * 5], ]; diff --git a/reference/imagick/imagickdraw/polyline.xml b/reference/imagick/imagickdraw/polyline.xml index 453861019..c909c9f5a 100644 --- a/reference/imagick/imagickdraw/polyline.xml +++ b/reference/imagick/imagickdraw/polyline.xml @@ -1,6 +1,6 @@ - + ImagickDraw::polyline Draws a polyline @@ -13,10 +13,10 @@ arraycoordinates &warn.undocumented.func; - + Draws a polyline using the current stroke, stroke width, and fill color or texture, using the specified array of coordinates. - + @@ -26,9 +26,9 @@ coordinates - - array of x and y coordinates: array( array( 'x' => 4, 'y' => 6 ), array( 'x' => 8, 'y' => 10 ) ) - + + array of x and y coordinates: array( array( 'x' => 4, 'y' => 6 ), array( 'x' => 8, 'y' => 10 ) ) + @@ -37,9 +37,9 @@ &reftitle.returnvalues; - + &imagick.return.success; - + diff --git a/reference/imagick/imagickdraw/pop.xml b/reference/imagick/imagickdraw/pop.xml index e9ac41085..a64c01cde 100644 --- a/reference/imagick/imagickdraw/pop.xml +++ b/reference/imagick/imagickdraw/pop.xml @@ -1,6 +1,6 @@ - + ImagickDraw::pop Destroys the current ImagickDraw in the stack, and returns to the previously pushed ImagickDraw @@ -13,19 +13,19 @@ &warn.undocumented.func; - + Destroys the current ImagickDraw in the stack, and returns to the previously pushed ImagickDraw. Multiple ImagickDraws may exist. It is an error to attempt to pop more ImagickDraws than have been pushed, and it is proper form to pop all ImagickDraws which have been pushed. - + &reftitle.returnvalues; - + &return.success; - + diff --git a/reference/imagick/imagickdraw/popclippath.xml b/reference/imagick/imagickdraw/popclippath.xml index 592f56f5b..3f1ab34f6 100644 --- a/reference/imagick/imagickdraw/popclippath.xml +++ b/reference/imagick/imagickdraw/popclippath.xml @@ -1,6 +1,6 @@ - + ImagickDraw::popClipPath Terminates a clip path definition @@ -13,16 +13,16 @@ &warn.undocumented.func; - + Terminates a clip path definition. - + &reftitle.returnvalues; - + &return.void; - + diff --git a/reference/imagick/imagickdraw/popdefs.xml b/reference/imagick/imagickdraw/popdefs.xml index cdaeae9c8..6adca7511 100644 --- a/reference/imagick/imagickdraw/popdefs.xml +++ b/reference/imagick/imagickdraw/popdefs.xml @@ -1,6 +1,6 @@ - + ImagickDraw::popDefs Terminates a definition list @@ -13,16 +13,16 @@ &warn.undocumented.func; - + Terminates a definition list. - + &reftitle.returnvalues; - + &return.void; - + diff --git a/reference/imagick/imagickdraw/poppattern.xml b/reference/imagick/imagickdraw/poppattern.xml index 66a680817..e2688b12c 100644 --- a/reference/imagick/imagickdraw/poppattern.xml +++ b/reference/imagick/imagickdraw/poppattern.xml @@ -1,6 +1,6 @@ - + ImagickDraw::popPattern Terminates a pattern definition @@ -13,16 +13,16 @@ &warn.undocumented.func; - + Terminates a pattern definition. - + &reftitle.returnvalues; - + &return.success; - + diff --git a/reference/imagick/imagickdraw/push.xml b/reference/imagick/imagickdraw/push.xml index 1786c6177..20ecfc13e 100644 --- a/reference/imagick/imagickdraw/push.xml +++ b/reference/imagick/imagickdraw/push.xml @@ -1,6 +1,6 @@ - + ImagickDraw::push Clones the current ImagickDraw and pushes it to the stack @@ -13,20 +13,20 @@ &warn.undocumented.func; - + Clones the current ImagickDraw to create a new ImagickDraw, which is then added to the ImagickDraw stack. The original drawing ImagickDraw(s) may be returned to by invoking ImagickDraw::pop. The ImagickDraws are stored on a ImagickDraw stack. For every Pop there must have already been an equivalent Push. - + &reftitle.returnvalues; - + &return.success; - + diff --git a/reference/imagick/imagickdraw/pushclippath.xml b/reference/imagick/imagickdraw/pushclippath.xml index 5835f6226..367330a81 100644 --- a/reference/imagick/imagickdraw/pushclippath.xml +++ b/reference/imagick/imagickdraw/pushclippath.xml @@ -1,6 +1,6 @@ - + ImagickDraw::pushClipPath Starts a clip path definition @@ -13,10 +13,10 @@ stringclip_mask_id &warn.undocumented.func; - + Starts a clip path definition which is comprised of any number of drawing commands and terminated by a ImagickDraw::popClipPath command. - + @@ -26,9 +26,9 @@ clip_mask_id - + Clip mask Id - + @@ -37,9 +37,9 @@ &reftitle.returnvalues; - + &return.void; - + diff --git a/reference/imagick/imagickdraw/pushdefs.xml b/reference/imagick/imagickdraw/pushdefs.xml index 9313c8115..c0f62f5e7 100644 --- a/reference/imagick/imagickdraw/pushdefs.xml +++ b/reference/imagick/imagickdraw/pushdefs.xml @@ -1,6 +1,6 @@ - + ImagickDraw::pushDefs Indicates that following commands create named elements for early processing @@ -13,18 +13,18 @@ &warn.undocumented.func; - + Indicates that commands up to a terminating ImagickDraw::popDefs command create named elements (e.g. clip-paths, textures, etc.) which may safely be processed earlier for the sake of efficiency. - + &reftitle.returnvalues; - + &return.void; - + diff --git a/reference/imagick/imagickdraw/pushpattern.xml b/reference/imagick/imagickdraw/pushpattern.xml index ab45479b5..e222aa18d 100644 --- a/reference/imagick/imagickdraw/pushpattern.xml +++ b/reference/imagick/imagickdraw/pushpattern.xml @@ -1,6 +1,6 @@ - + ImagickDraw::pushPattern Indicates that subsequent commands up to a ImagickDraw::opPattern() command comprise the definition of a named pattern @@ -17,13 +17,13 @@ floatheight &warn.undocumented.func; - + Indicates that subsequent commands up to a DrawPopPattern() command comprise the definition of a named pattern. The pattern space is assigned top left corner coordinates, a width and height, and becomes its own drawing space. Anything which can be drawn may be used in a pattern definition. Named patterns may be used as stroke or brush definitions. - + @@ -33,41 +33,41 @@ pattern_id - + the pattern Id - + x - + x coordinate of the top-left corner - + y - + y coordinate of the top-left corner - + width - + width of the pattern - + height - + height of the pattern - + @@ -76,9 +76,9 @@ &reftitle.returnvalues; - + &return.success; - + diff --git a/reference/imagick/imagickdraw/rectangle.xml b/reference/imagick/imagickdraw/rectangle.xml index e63a8a47d..ed132ae69 100644 --- a/reference/imagick/imagickdraw/rectangle.xml +++ b/reference/imagick/imagickdraw/rectangle.xml @@ -1,6 +1,6 @@ - + ImagickDraw::rectangle Draws a rectangle @@ -16,10 +16,10 @@ floatbottom_right_y &warn.undocumented.func; - + Draws a rectangle given two coordinates and using the current stroke, stroke width, and fill settings. - + @@ -29,33 +29,33 @@ top_left_x - + x coordinate of the top left corner - + top_left_y - + y coordinate of the top left corner - + bottom_right_x - + x coordinate of the bottom right corner - + bottom_right_y - + y coordinate of the bottom right corner - + @@ -64,9 +64,9 @@ &reftitle.returnvalues; - + &return.void; - + diff --git a/reference/imagick/imagickdraw/render.xml b/reference/imagick/imagickdraw/render.xml index dec3498f6..e16acf682 100644 --- a/reference/imagick/imagickdraw/render.xml +++ b/reference/imagick/imagickdraw/render.xml @@ -1,6 +1,6 @@ - + ImagickDraw::render Renders all preceding drawing commands onto the image @@ -13,16 +13,16 @@ &warn.undocumented.func; - + Renders all preceding drawing commands onto the image. - + &reftitle.returnvalues; - + &return.success; - + diff --git a/reference/imagick/imagickdraw/resetvectorgraphics.xml b/reference/imagick/imagickdraw/resetvectorgraphics.xml index 540f5aeed..713b2e823 100644 --- a/reference/imagick/imagickdraw/resetvectorgraphics.xml +++ b/reference/imagick/imagickdraw/resetvectorgraphics.xml @@ -13,9 +13,9 @@ public boolImagickDraw::resetVectorGraphics - + Resets the vector graphics. - + @@ -26,9 +26,9 @@ &reftitle.returnvalues; - + &imagick.return.success; - + diff --git a/reference/imagick/imagickdraw/rotate.xml b/reference/imagick/imagickdraw/rotate.xml index 7ab60c73e..c82f9fba9 100644 --- a/reference/imagick/imagickdraw/rotate.xml +++ b/reference/imagick/imagickdraw/rotate.xml @@ -1,6 +1,6 @@ - + ImagickDraw::rotate Applies the specified rotation to the current coordinate space @@ -13,9 +13,9 @@ floatdegrees &warn.undocumented.func; - + Applies the specified rotation to the current coordinate space. - + @@ -25,9 +25,9 @@ degrees - + degrees to rotate. - + @@ -36,9 +36,9 @@ &reftitle.returnvalues; - + &return.void; - + diff --git a/reference/imagick/imagickdraw/roundrectangle.xml b/reference/imagick/imagickdraw/roundrectangle.xml index d113c20d1..1e905dd05 100644 --- a/reference/imagick/imagickdraw/roundrectangle.xml +++ b/reference/imagick/imagickdraw/roundrectangle.xml @@ -1,6 +1,6 @@ - + ImagickDraw::roundRectangle Draws a rounded rectangle @@ -18,10 +18,10 @@ floatrounding_y &warn.undocumented.func; - + Draws a rounded rectangle given two coordinates, x & y corner radiuses and using the current stroke, stroke width, and fill settings. - + @@ -31,49 +31,49 @@ top_left_x - + x coordinate of the top left corner - + top_left_y - + y coordinate of the top left corner - + bottom_right_x - - x coordinate of the bottom right - + + x coordinate of the bottom right + bottom_right_y - - y coordinate of the bottom right - + + y coordinate of the bottom right + rounding_x - + x rounding - + rounding_y - + y rounding - + @@ -82,9 +82,9 @@ &reftitle.returnvalues; - + &return.void; - + diff --git a/reference/imagick/imagickdraw/scale.xml b/reference/imagick/imagickdraw/scale.xml index a337dc9d8..5adf0fb36 100644 --- a/reference/imagick/imagickdraw/scale.xml +++ b/reference/imagick/imagickdraw/scale.xml @@ -1,6 +1,6 @@ - + ImagickDraw::scale Adjusts the scaling factor @@ -14,10 +14,10 @@ floaty &warn.undocumented.func; - + Adjusts the scaling factor to apply in the horizontal and vertical directions to the current coordinate space. - + @@ -27,17 +27,17 @@ x - + horizontal factor - + y - + vertical factor - + @@ -46,9 +46,9 @@ &reftitle.returnvalues; - + &return.void; - + diff --git a/reference/imagick/imagickdraw/setclippath.xml b/reference/imagick/imagickdraw/setclippath.xml index 0e441e71e..98950dc2b 100644 --- a/reference/imagick/imagickdraw/setclippath.xml +++ b/reference/imagick/imagickdraw/setclippath.xml @@ -1,6 +1,6 @@ - + ImagickDraw::setClipPath Associates a named clipping path with the image @@ -13,10 +13,10 @@ stringclip_mask &warn.undocumented.func; - + Associates a named clipping path with the image. Only the areas drawn on by the clipping path will be modified as long as it remains in effect. - + @@ -26,9 +26,9 @@ clip_mask - + the clipping path name - + @@ -37,9 +37,9 @@ &reftitle.returnvalues; - + &return.void; - + diff --git a/reference/imagick/imagickdraw/setcliprule.xml b/reference/imagick/imagickdraw/setcliprule.xml index edf001bfb..b70251232 100644 --- a/reference/imagick/imagickdraw/setcliprule.xml +++ b/reference/imagick/imagickdraw/setcliprule.xml @@ -1,6 +1,6 @@ - + ImagickDraw::setClipRule Set the polygon fill rule to be used by the clipping path @@ -13,9 +13,9 @@ intfillrule &warn.undocumented.func; - + Set the polygon fill rule to be used by the clipping path. - + @@ -25,10 +25,10 @@ fillrule - + One of the FILLRULE constant (imagick::FILLRULE_*). - + @@ -37,9 +37,9 @@ &reftitle.returnvalues; - + &return.void; - + diff --git a/reference/imagick/imagickdraw/setclipunits.xml b/reference/imagick/imagickdraw/setclipunits.xml index 1de7ed425..ce6d7aaee 100644 --- a/reference/imagick/imagickdraw/setclipunits.xml +++ b/reference/imagick/imagickdraw/setclipunits.xml @@ -1,6 +1,6 @@ - + ImagickDraw::setClipUnits Sets the interpretation of clip path units @@ -13,9 +13,9 @@ intpathunits &warn.undocumented.func; - + Sets the interpretation of clip path units. - + @@ -25,9 +25,9 @@ pathunits - + the number of clip units - + @@ -36,9 +36,9 @@ &reftitle.returnvalues; - + &return.void; - + diff --git a/reference/imagick/imagickdraw/setfillalpha.xml b/reference/imagick/imagickdraw/setfillalpha.xml index 840a9b605..c2a6b7267 100644 --- a/reference/imagick/imagickdraw/setfillalpha.xml +++ b/reference/imagick/imagickdraw/setfillalpha.xml @@ -1,6 +1,6 @@ - + ImagickDraw::setFillAlpha Sets the opacity to use when drawing using the fill color or fill texture @@ -13,10 +13,10 @@ floatalpha &warn.undocumented.func; - + Sets the opacity to use when drawing using the fill color or fill texture. Fully opaque is 1.0. - + @@ -26,9 +26,9 @@ alpha - + fill alpha - + @@ -37,9 +37,9 @@ &reftitle.returnvalues; - + &return.void; - + diff --git a/reference/imagick/imagickdraw/setfillcolor.xml b/reference/imagick/imagickdraw/setfillcolor.xml index a393ecee1..a95bfacce 100644 --- a/reference/imagick/imagickdraw/setfillcolor.xml +++ b/reference/imagick/imagickdraw/setfillcolor.xml @@ -1,6 +1,6 @@ - + ImagickDraw::setFillColor Sets the fill color to be used for drawing filled objects @@ -13,9 +13,9 @@ ImagickPixelstringfill_color &warn.undocumented.func; - + Sets the fill color to be used for drawing filled objects. - + @@ -25,9 +25,9 @@ fill_color - + ImagickPixel to use to set the color - + @@ -36,9 +36,9 @@ &reftitle.returnvalues; - + &return.void; - + diff --git a/reference/imagick/imagickdraw/setfillopacity.xml b/reference/imagick/imagickdraw/setfillopacity.xml index 7cd6dba58..27fc2e035 100644 --- a/reference/imagick/imagickdraw/setfillopacity.xml +++ b/reference/imagick/imagickdraw/setfillopacity.xml @@ -1,6 +1,6 @@ - + ImagickDraw::setFillOpacity Sets the opacity to use when drawing using the fill color or fill texture @@ -13,10 +13,10 @@ floatopacity &warn.undocumented.func; - + Sets the opacity to use when drawing using the fill color or fill texture. Fully opaque is 1.0. - + @@ -26,9 +26,9 @@ opacity - + the fill opacity - + @@ -37,9 +37,9 @@ &reftitle.returnvalues; - + &return.void; - + diff --git a/reference/imagick/imagickdraw/setfillpatternurl.xml b/reference/imagick/imagickdraw/setfillpatternurl.xml index ec37adff5..5075c2a02 100644 --- a/reference/imagick/imagickdraw/setfillpatternurl.xml +++ b/reference/imagick/imagickdraw/setfillpatternurl.xml @@ -1,6 +1,6 @@ - + ImagickDraw::setFillPatternURL Sets the URL to use as a fill pattern for filling objects @@ -13,11 +13,11 @@ stringfill_url &warn.undocumented.func; - + Sets the URL to use as a fill pattern for filling objects. Only local URLs ("#identifier") are supported at this time. These local URLs are normally created by defining a named fill pattern with DrawPushPattern/DrawPopPattern. - + @@ -27,9 +27,9 @@ fill_url - + URL to use to obtain fill pattern. - + @@ -38,9 +38,9 @@ &reftitle.returnvalues; - + &return.success; - + diff --git a/reference/imagick/imagickdraw/setfillrule.xml b/reference/imagick/imagickdraw/setfillrule.xml index 68b03784b..b9b1eb457 100644 --- a/reference/imagick/imagickdraw/setfillrule.xml +++ b/reference/imagick/imagickdraw/setfillrule.xml @@ -1,6 +1,6 @@ - + ImagickDraw::setFillRule Sets the fill rule to use while drawing polygons @@ -13,9 +13,9 @@ intfillrule &warn.undocumented.func; - + Sets the fill rule to use while drawing polygons. - + @@ -25,10 +25,10 @@ fillrule - + One of the FILLRULE constant (imagick::FILLRULE_*). - + @@ -37,9 +37,9 @@ &reftitle.returnvalues; - + &return.void; - + diff --git a/reference/imagick/imagickdraw/setfont.xml b/reference/imagick/imagickdraw/setfont.xml index a82646f7b..76ba9cbb4 100644 --- a/reference/imagick/imagickdraw/setfont.xml +++ b/reference/imagick/imagickdraw/setfont.xml @@ -1,6 +1,6 @@ - + ImagickDraw::setFont Sets the fully-specified font to use when annotating with text @@ -13,9 +13,9 @@ stringfont_name &warn.undocumented.func; - + Sets the fully-specified font to use when annotating with text. - + @@ -25,8 +25,8 @@ font_name - - + + @@ -35,9 +35,9 @@ &reftitle.returnvalues; - + &imagick.return.success; - + diff --git a/reference/imagick/imagickdraw/setfontfamily.xml b/reference/imagick/imagickdraw/setfontfamily.xml index 91b25312c..2d8c1cf17 100644 --- a/reference/imagick/imagickdraw/setfontfamily.xml +++ b/reference/imagick/imagickdraw/setfontfamily.xml @@ -1,6 +1,6 @@ - + ImagickDraw::setFontFamily Sets the font family to use when annotating with text @@ -13,9 +13,9 @@ stringfont_family &warn.undocumented.func; - + Sets the font family to use when annotating with text. - + @@ -25,9 +25,9 @@ font_family - + the font family - + @@ -36,9 +36,9 @@ &reftitle.returnvalues; - + &imagick.return.success; - + @@ -69,7 +69,7 @@ function setFontFamily($fillColor, $strokeColor, $backgroundColor) { $draw->setFontFamily("AvantGarde"); $draw->annotation(50, 100, "Lorem Ipsum!"); - $draw->setFontFamily("NewCenturySchlbk"); + $draw->setFontFamily("NewCenturySchlbk"); $draw->annotation(50, 150, "Lorem Ipsum!"); $draw->setFontFamily("Palatino"); diff --git a/reference/imagick/imagickdraw/setfontsize.xml b/reference/imagick/imagickdraw/setfontsize.xml index dd9af3e6f..187544a88 100644 --- a/reference/imagick/imagickdraw/setfontsize.xml +++ b/reference/imagick/imagickdraw/setfontsize.xml @@ -1,6 +1,6 @@ - + ImagickDraw::setFontSize Sets the font pointsize to use when annotating with text @@ -13,9 +13,9 @@ floatpoint_size &warn.undocumented.func; - + Sets the font pointsize to use when annotating with text. - + @@ -25,9 +25,9 @@ point_size - + the point size - + @@ -36,9 +36,9 @@ &reftitle.returnvalues; - + &return.void; - + diff --git a/reference/imagick/imagickdraw/setfontstretch.xml b/reference/imagick/imagickdraw/setfontstretch.xml index cf330f7c6..656731857 100644 --- a/reference/imagick/imagickdraw/setfontstretch.xml +++ b/reference/imagick/imagickdraw/setfontstretch.xml @@ -1,6 +1,6 @@ - + ImagickDraw::setFontStretch Sets the font stretch to use when annotating with text @@ -13,10 +13,10 @@ intstretch &warn.undocumented.func; - + Sets the font stretch to use when annotating with text. The AnyStretch enumeration acts as a wild-card "don't care" option. - + @@ -26,10 +26,10 @@ stretch - + One of the STRETCH constant (imagick::STRETCH_*). - + @@ -38,9 +38,9 @@ &reftitle.returnvalues; - + &return.void; - + @@ -61,13 +61,13 @@ function setFontStretch($fillColor, $strokeColor, $backgroundColor) { $draw->setFontSize(36); $fontStretchTypes = [ - \Imagick::STRETCH_ULTRACONDENSED, - \Imagick::STRETCH_CONDENSED, - \Imagick::STRETCH_SEMICONDENSED, - \Imagick::STRETCH_SEMIEXPANDED, - \Imagick::STRETCH_EXPANDED, - \Imagick::STRETCH_EXTRAEXPANDED, - \Imagick::STRETCH_ULTRAEXPANDED, + \Imagick::STRETCH_ULTRACONDENSED, + \Imagick::STRETCH_CONDENSED, + \Imagick::STRETCH_SEMICONDENSED, + \Imagick::STRETCH_SEMIEXPANDED, + \Imagick::STRETCH_EXPANDED, + \Imagick::STRETCH_EXTRAEXPANDED, + \Imagick::STRETCH_ULTRAEXPANDED, \Imagick::STRETCH_ANY ]; diff --git a/reference/imagick/imagickdraw/setfontstyle.xml b/reference/imagick/imagickdraw/setfontstyle.xml index 99e01df9e..0314e0448 100644 --- a/reference/imagick/imagickdraw/setfontstyle.xml +++ b/reference/imagick/imagickdraw/setfontstyle.xml @@ -1,6 +1,6 @@ - + ImagickDraw::setFontStyle Sets the font style to use when annotating with text @@ -13,10 +13,10 @@ intstyle &warn.undocumented.func; - + Sets the font style to use when annotating with text. The AnyStyle enumeration acts as a wild-card "don't care" option. - + @@ -26,10 +26,10 @@ style - + One of the STYLE constant (imagick::STYLE_*). - + @@ -38,9 +38,9 @@ &reftitle.returnvalues; - + &return.void; - + diff --git a/reference/imagick/imagickdraw/setfontweight.xml b/reference/imagick/imagickdraw/setfontweight.xml index 185a2f738..626754be2 100644 --- a/reference/imagick/imagickdraw/setfontweight.xml +++ b/reference/imagick/imagickdraw/setfontweight.xml @@ -1,6 +1,6 @@ - + ImagickDraw::setFontWeight Sets the font weight @@ -13,9 +13,9 @@ intweight &warn.undocumented.func; - + Sets the font weight to use when annotating with text. - + @@ -25,8 +25,8 @@ weight - - + + @@ -35,8 +35,8 @@ &reftitle.returnvalues; - - + + diff --git a/reference/imagick/imagickdraw/setgravity.xml b/reference/imagick/imagickdraw/setgravity.xml index 1f0e62536..c08c8ffbe 100644 --- a/reference/imagick/imagickdraw/setgravity.xml +++ b/reference/imagick/imagickdraw/setgravity.xml @@ -1,6 +1,6 @@ - + ImagickDraw::setGravity Sets the text placement gravity @@ -13,9 +13,9 @@ intgravity &warn.undocumented.func; - + Sets the text placement gravity to use when annotating with text. - + @@ -25,10 +25,10 @@ gravity - + One of the GRAVITY constant (imagick::GRAVITY_*). - + @@ -37,9 +37,9 @@ &reftitle.returnvalues; - + &return.void; - + diff --git a/reference/imagick/imagickdraw/setresolution.xml b/reference/imagick/imagickdraw/setresolution.xml index 3c2cc7316..8124206f8 100644 --- a/reference/imagick/imagickdraw/setresolution.xml +++ b/reference/imagick/imagickdraw/setresolution.xml @@ -14,9 +14,9 @@ floatresolution_x floatresolution_y - + Sets the resolution. - + @@ -26,17 +26,17 @@ resolution_x - - - + + + resolution_y - - - + + + @@ -44,9 +44,9 @@ &reftitle.returnvalues; - + &imagick.return.success; - + diff --git a/reference/imagick/imagickdraw/setstrokealpha.xml b/reference/imagick/imagickdraw/setstrokealpha.xml index d6b8c4922..4aa940347 100644 --- a/reference/imagick/imagickdraw/setstrokealpha.xml +++ b/reference/imagick/imagickdraw/setstrokealpha.xml @@ -1,6 +1,6 @@ - + ImagickDraw::setStrokeAlpha Specifies the opacity of stroked object outlines @@ -13,9 +13,9 @@ floatalpha &warn.undocumented.func; - + Specifies the opacity of stroked object outlines. - + @@ -25,9 +25,9 @@ alpha - + opacity - + @@ -36,9 +36,9 @@ &reftitle.returnvalues; - + &return.void; - + diff --git a/reference/imagick/imagickdraw/setstrokeantialias.xml b/reference/imagick/imagickdraw/setstrokeantialias.xml index d2828bb87..7c28b1e67 100644 --- a/reference/imagick/imagickdraw/setstrokeantialias.xml +++ b/reference/imagick/imagickdraw/setstrokeantialias.xml @@ -1,6 +1,6 @@ - + ImagickDraw::setStrokeAntialias Controls whether stroked outlines are antialiased @@ -13,12 +13,12 @@ boolenabled &warn.undocumented.func; - + Controls whether stroked outlines are antialiased. Stroked outlines are antialiased by default. When antialiasing is disabled stroked pixels are thresholded to determine if the stroke color or underlying canvas color should be used. - + @@ -28,9 +28,9 @@ enabled - + the antialias setting - + @@ -39,9 +39,9 @@ &reftitle.returnvalues; - + &return.void; - + diff --git a/reference/imagick/imagickdraw/setstrokecolor.xml b/reference/imagick/imagickdraw/setstrokecolor.xml index 161149d4c..9162aa2b8 100644 --- a/reference/imagick/imagickdraw/setstrokecolor.xml +++ b/reference/imagick/imagickdraw/setstrokecolor.xml @@ -1,6 +1,6 @@ - + ImagickDraw::setStrokeColor Sets the color used for stroking object outlines @@ -13,9 +13,9 @@ ImagickPixelstringcolor &warn.undocumented.func; - + Sets the color used for stroking object outlines. - + @@ -25,9 +25,9 @@ color - + the stroke color - + @@ -36,9 +36,9 @@ &reftitle.returnvalues; - + &return.void; - + diff --git a/reference/imagick/imagickdraw/setstrokedasharray.xml b/reference/imagick/imagickdraw/setstrokedasharray.xml index e443b96df..109833702 100644 --- a/reference/imagick/imagickdraw/setstrokedasharray.xml +++ b/reference/imagick/imagickdraw/setstrokedasharray.xml @@ -1,6 +1,6 @@ - + ImagickDraw::setStrokeDashArray Specifies the pattern of dashes and gaps used to stroke paths @@ -13,7 +13,7 @@ arraynulldashes &warn.undocumented.func; - + Specifies the pattern of dashes and gaps used to stroke paths. The strokeDashArray represents an array of numbers that specify the lengths of alternating dashes and gaps in pixels. If an odd number of values is @@ -21,7 +21,7 @@ values. To remove an existing dash array, pass a zero number_elements argument and null dash_array. A typical strokeDashArray_ array might contain the members 5 3 2. - + @@ -31,9 +31,9 @@ dashes - + array of floats - + @@ -42,9 +42,9 @@ &reftitle.returnvalues; - + &imagick.return.success; - + diff --git a/reference/imagick/imagickdraw/setstrokedashoffset.xml b/reference/imagick/imagickdraw/setstrokedashoffset.xml index ce76725c7..2d1479cc1 100644 --- a/reference/imagick/imagickdraw/setstrokedashoffset.xml +++ b/reference/imagick/imagickdraw/setstrokedashoffset.xml @@ -1,6 +1,6 @@ - + ImagickDraw::setStrokeDashOffset Specifies the offset into the dash pattern to start the dash @@ -13,9 +13,9 @@ floatdash_offset &warn.undocumented.func; - + Specifies the offset into the dash pattern to start the dash. - + @@ -25,9 +25,9 @@ dash_offset - + dash offset - + @@ -36,9 +36,9 @@ &reftitle.returnvalues; - + &return.void; - + diff --git a/reference/imagick/imagickdraw/setstrokelinecap.xml b/reference/imagick/imagickdraw/setstrokelinecap.xml index 88d9a4cab..9328aa075 100644 --- a/reference/imagick/imagickdraw/setstrokelinecap.xml +++ b/reference/imagick/imagickdraw/setstrokelinecap.xml @@ -1,6 +1,6 @@ - + ImagickDraw::setStrokeLineCap Specifies the shape to be used at the end of open subpaths when they are stroked @@ -13,10 +13,10 @@ intlinecap &warn.undocumented.func; - + Specifies the shape to be used at the end of open subpaths when they are stroked. - + @@ -26,10 +26,10 @@ linecap - + One of the LINECAP constant (imagick::LINECAP_*). - + @@ -38,9 +38,9 @@ &reftitle.returnvalues; - + &return.void; - + diff --git a/reference/imagick/imagickdraw/setstrokelinejoin.xml b/reference/imagick/imagickdraw/setstrokelinejoin.xml index edb5260c4..8d2257e1c 100644 --- a/reference/imagick/imagickdraw/setstrokelinejoin.xml +++ b/reference/imagick/imagickdraw/setstrokelinejoin.xml @@ -1,6 +1,6 @@ - + ImagickDraw::setStrokeLineJoin Specifies the shape to be used at the corners of paths when they are stroked @@ -13,10 +13,10 @@ intlinejoin &warn.undocumented.func; - - Specifies the shape to be used at the corners of paths (or other vector + + Specifies the shape to be used at the corners of paths (or other vector shapes) when they are stroked. - + @@ -26,10 +26,10 @@ linejoin - + One of the LINEJOIN constant (imagick::LINEJOIN_*). - + @@ -38,9 +38,9 @@ &reftitle.returnvalues; - + &return.void; - + diff --git a/reference/imagick/imagickdraw/setstrokemiterlimit.xml b/reference/imagick/imagickdraw/setstrokemiterlimit.xml index cf6f15d2b..bb0e64c5b 100644 --- a/reference/imagick/imagickdraw/setstrokemiterlimit.xml +++ b/reference/imagick/imagickdraw/setstrokemiterlimit.xml @@ -1,6 +1,6 @@ - + ImagickDraw::setStrokeMiterLimit Specifies the miter limit @@ -13,13 +13,13 @@ intmiterlimit &warn.undocumented.func; - + Specifies the miter limit. When two line segments meet at a sharp angle and miter joins have been specified for 'lineJoin', it is possible for - the miter to extend far beyond the thickness of the line stroking the + the miter to extend far beyond the thickness of the line stroking the path. The miterLimit' imposes a limit on the ratio of the miter length to the 'lineWidth'. - + @@ -29,9 +29,9 @@ miterlimit - + the miter limit - + @@ -40,9 +40,9 @@ &reftitle.returnvalues; - + &return.void; - + diff --git a/reference/imagick/imagickdraw/setstrokeopacity.xml b/reference/imagick/imagickdraw/setstrokeopacity.xml index e77a866e2..1022ea2f3 100644 --- a/reference/imagick/imagickdraw/setstrokeopacity.xml +++ b/reference/imagick/imagickdraw/setstrokeopacity.xml @@ -1,6 +1,6 @@ - + ImagickDraw::setStrokeOpacity Specifies the opacity of stroked object outlines @@ -13,9 +13,9 @@ floatopacity &warn.undocumented.func; - + Specifies the opacity of stroked object outlines. - + @@ -25,9 +25,9 @@ opacity - + stroke opacity. 1.0 is fully opaque - + @@ -36,9 +36,9 @@ &reftitle.returnvalues; - + &return.void; - + diff --git a/reference/imagick/imagickdraw/setstrokepatternurl.xml b/reference/imagick/imagickdraw/setstrokepatternurl.xml index e88602b8a..04b34ecf7 100644 --- a/reference/imagick/imagickdraw/setstrokepatternurl.xml +++ b/reference/imagick/imagickdraw/setstrokepatternurl.xml @@ -1,6 +1,6 @@ - + ImagickDraw::setStrokePatternURL Sets the pattern used for stroking object outlines @@ -13,9 +13,9 @@ stringstroke_url &warn.undocumented.func; - + Sets the pattern used for stroking object outlines. - + @@ -25,9 +25,9 @@ stroke_url - + stroke URL - + @@ -36,9 +36,9 @@ &reftitle.returnvalues; - + &imagick.return.success; - + diff --git a/reference/imagick/imagickdraw/setstrokewidth.xml b/reference/imagick/imagickdraw/setstrokewidth.xml index bb275a7e4..f1ed12cb9 100644 --- a/reference/imagick/imagickdraw/setstrokewidth.xml +++ b/reference/imagick/imagickdraw/setstrokewidth.xml @@ -1,6 +1,6 @@ - + ImagickDraw::setStrokeWidth Sets the width of the stroke used to draw object outlines @@ -13,9 +13,9 @@ floatwidth &warn.undocumented.func; - + Sets the width of the stroke used to draw object outlines. - + @@ -25,9 +25,9 @@ width - + stroke width - + @@ -36,9 +36,9 @@ &reftitle.returnvalues; - + &return.void; - + diff --git a/reference/imagick/imagickdraw/settextalignment.xml b/reference/imagick/imagickdraw/settextalignment.xml index c738b13b9..f607ad1a3 100644 --- a/reference/imagick/imagickdraw/settextalignment.xml +++ b/reference/imagick/imagickdraw/settextalignment.xml @@ -1,6 +1,6 @@ - + ImagickDraw::setTextAlignment Specifies a text alignment @@ -13,9 +13,9 @@ intalign &warn.undocumented.func; - + Specifies a text alignment to be applied when annotating with text. - + @@ -25,10 +25,10 @@ align - + One of the ALIGN constant (imagick::ALIGN_*). - + @@ -37,9 +37,9 @@ &reftitle.returnvalues; - + &return.void; - + diff --git a/reference/imagick/imagickdraw/settextantialias.xml b/reference/imagick/imagickdraw/settextantialias.xml index 3ba3469a4..dff65fde3 100644 --- a/reference/imagick/imagickdraw/settextantialias.xml +++ b/reference/imagick/imagickdraw/settextantialias.xml @@ -1,6 +1,6 @@ - + ImagickDraw::setTextAntialias Controls whether text is antialiased @@ -13,9 +13,9 @@ boolantialias &warn.undocumented.func; - + Controls whether text is antialiased. Text is antialiased by default. - + @@ -25,19 +25,19 @@ antialias - - + + - + &reftitle.returnvalues; - + &return.void; - + diff --git a/reference/imagick/imagickdraw/settextdecoration.xml b/reference/imagick/imagickdraw/settextdecoration.xml index 629bbe013..40667dc38 100644 --- a/reference/imagick/imagickdraw/settextdecoration.xml +++ b/reference/imagick/imagickdraw/settextdecoration.xml @@ -1,6 +1,6 @@ - + ImagickDraw::setTextDecoration Specifies a decoration @@ -13,9 +13,9 @@ intdecoration &warn.undocumented.func; - + Specifies a decoration to be applied when annotating with text. - + @@ -25,10 +25,10 @@ decoration - + One of the DECORATION constant (imagick::DECORATION_*). - + @@ -37,9 +37,9 @@ &reftitle.returnvalues; - + &return.void; - + diff --git a/reference/imagick/imagickdraw/settextencoding.xml b/reference/imagick/imagickdraw/settextencoding.xml index 29e3666d4..219b1c73c 100644 --- a/reference/imagick/imagickdraw/settextencoding.xml +++ b/reference/imagick/imagickdraw/settextencoding.xml @@ -1,6 +1,6 @@ - + ImagickDraw::setTextEncoding Specifies the text code set @@ -13,13 +13,13 @@ stringencoding &warn.undocumented.func; - + Specifies the code set to use for text annotations. The only character encoding which may be specified at this time is "UTF-8" for representing Unicode as a sequence of bytes. Specify an empty string to set text encoding to the system's default. Successful text annotation using Unicode may require fonts designed to support Unicode. - + @@ -29,9 +29,9 @@ encoding - + the encoding name - + @@ -40,9 +40,9 @@ &reftitle.returnvalues; - + &return.void; - + diff --git a/reference/imagick/imagickdraw/settextinterlinespacing.xml b/reference/imagick/imagickdraw/settextinterlinespacing.xml index f3fdda22a..a6782c9cf 100644 --- a/reference/imagick/imagickdraw/settextinterlinespacing.xml +++ b/reference/imagick/imagickdraw/settextinterlinespacing.xml @@ -13,9 +13,9 @@ public boolImagickDraw::setTextInterlineSpacing floatspacing - + Sets the text interline spacing. - + &warn.undocumented.func; @@ -27,9 +27,9 @@ spacing - - - + + + @@ -37,9 +37,9 @@ &reftitle.returnvalues; - + &imagick.return.success; - + diff --git a/reference/imagick/imagickdraw/settextinterwordspacing.xml b/reference/imagick/imagickdraw/settextinterwordspacing.xml index ebb1137f4..fdbc0a92f 100644 --- a/reference/imagick/imagickdraw/settextinterwordspacing.xml +++ b/reference/imagick/imagickdraw/settextinterwordspacing.xml @@ -13,9 +13,9 @@ public boolImagickDraw::setTextInterwordSpacing floatspacing - + Sets the text interword spacing. - + @@ -25,9 +25,9 @@ spacing - - - + + + @@ -35,9 +35,9 @@ &reftitle.returnvalues; - + &imagick.return.success; - + diff --git a/reference/imagick/imagickdraw/settextkerning.xml b/reference/imagick/imagickdraw/settextkerning.xml index 808e385f2..daefb2590 100644 --- a/reference/imagick/imagickdraw/settextkerning.xml +++ b/reference/imagick/imagickdraw/settextkerning.xml @@ -13,9 +13,9 @@ public boolImagickDraw::setTextKerning floatkerning - + Sets the text kerning - + &warn.undocumented.func; @@ -27,9 +27,9 @@ kerning - - - + + + @@ -37,9 +37,9 @@ &reftitle.returnvalues; - + &imagick.return.success; - + diff --git a/reference/imagick/imagickdraw/settextundercolor.xml b/reference/imagick/imagickdraw/settextundercolor.xml index 9ffa21f85..06307487b 100644 --- a/reference/imagick/imagickdraw/settextundercolor.xml +++ b/reference/imagick/imagickdraw/settextundercolor.xml @@ -1,6 +1,6 @@ - + ImagickDraw::setTextUnderColor Specifies the color of a background rectangle @@ -13,9 +13,9 @@ ImagickPixelstringunder_color &warn.undocumented.func; - + Specifies the color of a background rectangle to place under text annotations. - + @@ -25,9 +25,9 @@ under_color - + the under color - + @@ -36,9 +36,9 @@ &reftitle.returnvalues; - + &return.void; - + diff --git a/reference/imagick/imagickdraw/setvectorgraphics.xml b/reference/imagick/imagickdraw/setvectorgraphics.xml index a322a17de..fa437e804 100644 --- a/reference/imagick/imagickdraw/setvectorgraphics.xml +++ b/reference/imagick/imagickdraw/setvectorgraphics.xml @@ -1,6 +1,6 @@ - + ImagickDraw::setVectorGraphics Sets the vector graphics @@ -13,11 +13,11 @@ stringxml &warn.undocumented.func; - + Sets the vector graphics associated with the specified ImagickDraw object. Use this method with ImagickDraw::getVectorGraphics as a method to persist the vector graphics state. - + @@ -27,9 +27,9 @@ xml - + xml containing the vector graphics - + @@ -38,9 +38,9 @@ &reftitle.returnvalues; - + &return.success; - + @@ -62,12 +62,12 @@ function setVectorGraphics() { //Get the drawing as a string $SVG = $draw->getVectorGraphics(); - + //$svg is a string, and could be saved anywhere a string can be saved //Use the saved drawing to generate a new draw object $draw2 = new \ImagickDraw(); - //Apparently the SVG text is missing the root element. + //Apparently the SVG text is missing the root element. $draw2->setVectorGraphics("".$SVG.""); $imagick = new \Imagick(); diff --git a/reference/imagick/imagickdraw/setviewbox.xml b/reference/imagick/imagickdraw/setviewbox.xml index c4a7633a8..691a590ab 100644 --- a/reference/imagick/imagickdraw/setviewbox.xml +++ b/reference/imagick/imagickdraw/setviewbox.xml @@ -16,13 +16,13 @@ intbottom_y &warn.undocumented.func; - + Sets the overall canvas size to be recorded with the drawing vector data. Usually this will be specified using the same size as the canvas image. When the vector data is saved to SVG or MVG formats, the viewbox is use to specify the size of the canvas image that a viewer will render the vector data on. - + @@ -32,33 +32,33 @@ left_x - + left x coordinate - + top_y - + left y coordinate - + right_x - + right x coordinate - + bottom_y - + right y coordinate - + @@ -67,9 +67,9 @@ &reftitle.returnvalues; - + &return.void; - + @@ -90,9 +90,9 @@ function setViewBox($strokeColor, $fillColor, $backgroundColor) { $draw->setFontSize(72); /* - + Sets the overall canvas size to be recorded with the drawing vector data. Usually this will be specified using the same size as the canvas image. When the vector data is saved to SVG or MVG formats, the viewbox is use to specify the size of the canvas image that a viewer will render the vector data on. - + */ $draw->circle(250, 250, 250, 0); diff --git a/reference/imagick/imagickdraw/skewx.xml b/reference/imagick/imagickdraw/skewx.xml index 8aaf64231..aeca0fa88 100644 --- a/reference/imagick/imagickdraw/skewx.xml +++ b/reference/imagick/imagickdraw/skewx.xml @@ -1,6 +1,6 @@ - + ImagickDraw::skewX Skews the current coordinate system in the horizontal direction @@ -13,9 +13,9 @@ floatdegrees &warn.undocumented.func; - + Skews the current coordinate system in the horizontal direction. - + @@ -25,9 +25,9 @@ degrees - + degrees to skew - + @@ -36,9 +36,9 @@ &reftitle.returnvalues; - + &return.void; - + @@ -49,7 +49,7 @@ - + ImagickDraw::skewY Skews the current coordinate system in the vertical direction @@ -13,9 +13,9 @@ floatdegrees &warn.undocumented.func; - + Skews the current coordinate system in the vertical direction. - + @@ -25,9 +25,9 @@ degrees - + degrees to skew - + @@ -36,9 +36,9 @@ &reftitle.returnvalues; - + &return.void; - + @@ -49,7 +49,7 @@ - + ImagickDraw::translate Applies a translation to the current coordinate system @@ -14,10 +14,10 @@ floaty &warn.undocumented.func; - + Applies a translation to the current coordinate system which moves the coordinate system origin to the specified coordinate. - + @@ -27,17 +27,17 @@ x - + horizontal translation - + y - + vertical translation - + @@ -46,9 +46,9 @@ &reftitle.returnvalues; - + &return.void; - + @@ -59,7 +59,7 @@
    &reftitle.intro; - + - +
    @@ -31,7 +31,7 @@ - + &Methods; diff --git a/reference/imagick/imagickkernel/addkernel.xml b/reference/imagick/imagickkernel/addkernel.xml index edeeac550..ebf9e9535 100644 --- a/reference/imagick/imagickkernel/addkernel.xml +++ b/reference/imagick/imagickkernel/addkernel.xml @@ -13,9 +13,9 @@ public voidImagickKernel::addKernel ImagickKernelImagickKernel - + Attach another kernel to this kernel to allow them to both be applied in a single morphology or filter function. Returns the new combined kernel. - +     @@ -25,9 +25,9 @@ ImagickKernel - - - + + + @@ -35,9 +35,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/imagick/imagickkernel/addunitykernel.xml b/reference/imagick/imagickkernel/addunitykernel.xml index 67ba07c8d..69338a96a 100644 --- a/reference/imagick/imagickkernel/addunitykernel.xml +++ b/reference/imagick/imagickkernel/addunitykernel.xml @@ -13,12 +13,12 @@ public voidImagickKernel::addUnityKernel floatscale - + Adds a given amount of the 'Unity' Convolution Kernel to the given pre-scaled and normalized Kernel. This in effect adds that amount of the original image into the resulting convolution kernel. The resulting effect is to convert the defined kernels into blended soft-blurs, unsharp kernels or into sharpening kernels. - + @@ -29,9 +29,9 @@ &reftitle.returnvalues; - - - + + + @@ -50,7 +50,7 @@ function renderKernelTable($matrix) { $output = "
    "; - + foreach ($matrix as $row) { $output .= ""; foreach ($row as $cell) { @@ -65,9 +65,9 @@ } $output .= ""; } - + $output .= "
    "; - + return $output; } @@ -84,8 +84,8 @@ $kernel->addUnityKernel(0.5); $output .= "After adding unity kernel:
    "; $output .= renderKernelTable($kernel->getMatrix()); - - + + $kernel->scale(1, \Imagick::NORMALIZE_KERNEL_VALUE); $output .= "After renormalizing kernel:
    "; $output .= renderKernelTable($kernel->getMatrix()); diff --git a/reference/imagick/imagickkernel/frombuiltin.xml b/reference/imagick/imagickkernel/frombuiltin.xml index f5eae3ec7..7dea5b53e 100644 --- a/reference/imagick/imagickkernel/frombuiltin.xml +++ b/reference/imagick/imagickkernel/frombuiltin.xml @@ -14,10 +14,10 @@ intkernelType stringkernelString - + Create a kernel from a builtin in kernel. See http://www.imagemagick.org/Usage/morphology/#kernel for examples. Currently the 'rotation' symbols are not supported. Example: $diamondKernel = ImagickKernel::fromBuiltIn(\Imagick::KERNEL_DIAMOND, "2"); - + @@ -27,17 +27,17 @@ kerneltype - + The type of kernel to build e.g. \Imagick::KERNEL_DIAMOND - + kernelString - + A string that describes the parameters e.g. "4,2.5" - + @@ -45,9 +45,9 @@ &reftitle.returnvalues; - - - + + + @@ -65,9 +65,9 @@ function renderKernel(ImagickKernel $imagickKernel) { $matrix = $imagickKernel->getMatrix(); - + $imageMargin = 20; - + $tileSize = 20; $tileSpace = 4; $shadowSigma = 4; @@ -75,20 +75,20 @@ function renderKernel(ImagickKernel $imagickKernel) { $shadowDropY = 0; $radius = ($tileSize / 2) * 0.9; - + $rows = count($matrix); $columns = count($matrix[0]); - + $imagickDraw = new \ImagickDraw(); $imagickDraw->setFillColor('#afafaf'); $imagickDraw->setStrokeColor('none'); - + $imagickDraw->translate($imageMargin, $imageMargin); $imagickDraw->push(); ksort($matrix); - + foreach ($matrix as $row) { ksort($row); $imagickDraw->push(); @@ -119,7 +119,7 @@ function renderKernel(ImagickKernel $imagickKernel) { $imagickDraw->circle(0, 0, $radius, 0); $imagickDraw->pop(); - $canvasWidth = $width + (2 * $imageMargin); + $canvasWidth = $width + (2 * $imageMargin); $canvasHeight = $height + (2 * $imageMargin); $kernel = new \Imagick(); @@ -131,7 +131,7 @@ function renderKernel(ImagickKernel $imagickKernel) { $kernel->setImageFormat('png'); $kernel->drawImage($imagickDraw); - + /* create drop shadow on it's own layer */ $canvas = $kernel->clone(); $canvas->setImageBackgroundColor(new \ImagickPixel('rgb(0, 0, 0)')); @@ -139,7 +139,7 @@ function renderKernel(ImagickKernel $imagickKernel) { $canvas->setImagePage($canvasWidth, $canvasHeight, -5, -5); $canvas->cropImage($canvasWidth, $canvasHeight, 0, 0); - + /* composite original text_layer onto shadow_layer */ $canvas->compositeImage($kernel, \Imagick::COMPOSITE_OVER, 0, 0); $canvas->setImageFormat('png'); @@ -169,7 +169,7 @@ function createFromBuiltin($kernelType, $kernelFirstTerm, $kernelSecondTerm, $ke return $kernel; } - + function fromBuiltin($kernelType, $kernelFirstTerm, $kernelSecondTerm, $kernelThirdTerm) { $diamondKernel = createFromBuiltin($kernelType, $kernelFirstTerm, $kernelSecondTerm, $kernelThirdTerm); $imagick = renderKernel($diamondKernel); diff --git a/reference/imagick/imagickkernel/frommatrix.xml b/reference/imagick/imagickkernel/frommatrix.xml index b9b1af695..585bf8d88 100644 --- a/reference/imagick/imagickkernel/frommatrix.xml +++ b/reference/imagick/imagickkernel/frommatrix.xml @@ -14,12 +14,12 @@ arraymatrix arrayorigin - + Create a kernel from an 2d matrix of values. Each value should either be a float (if the element should be used) or 'false' if the element should be skipped. For matrices that are odd sizes in both dimensions the origin pixel will default to the centre of the kernel. For all other kernel sizes the origin pixel must be specified. - + @@ -29,17 +29,17 @@ array - + A matrix (i.e. 2d array) of values that define the kernel. Each element should be either a float value, or FALSE if that element shouldn't be used by the kernel. - + array - + Which element of the kernel should be used as the origin pixel. e.g. For a 3x3 matrix specifying the origin as [2, 2] would specify that the bottom right element should be the origin pixel. - + @@ -47,9 +47,9 @@ &reftitle.returnvalues; - + The generated ImagickKernel. - + @@ -66,9 +66,9 @@ function renderKernel(ImagickKernel $imagickKernel) { $matrix = $imagickKernel->getMatrix(); - + $imageMargin = 20; - + $tileSize = 20; $tileSpace = 4; $shadowSigma = 4; @@ -76,20 +76,20 @@ function renderKernel(ImagickKernel $imagickKernel) { $shadowDropY = 0; $radius = ($tileSize / 2) * 0.9; - + $rows = count($matrix); $columns = count($matrix[0]); - + $imagickDraw = new \ImagickDraw(); $imagickDraw->setFillColor('#afafaf'); $imagickDraw->setStrokeColor('none'); - + $imagickDraw->translate($imageMargin, $imageMargin); $imagickDraw->push(); ksort($matrix); - + foreach ($matrix as $row) { ksort($row); $imagickDraw->push(); @@ -120,7 +120,7 @@ function renderKernel(ImagickKernel $imagickKernel) { $imagickDraw->circle(0, 0, $radius, 0); $imagickDraw->pop(); - $canvasWidth = $width + (2 * $imageMargin); + $canvasWidth = $width + (2 * $imageMargin); $canvasHeight = $height + (2 * $imageMargin); $kernel = new \Imagick(); @@ -132,7 +132,7 @@ function renderKernel(ImagickKernel $imagickKernel) { $kernel->setImageFormat('png'); $kernel->drawImage($imagickDraw); - + /* create drop shadow on it's own layer */ $canvas = $kernel->clone(); $canvas->setImageBackgroundColor(new \ImagickPixel('rgb(0, 0, 0)')); @@ -140,7 +140,7 @@ function renderKernel(ImagickKernel $imagickKernel) { $canvas->setImagePage($canvasWidth, $canvasHeight, -5, -5); $canvas->cropImage($canvasWidth, $canvasHeight, 0, 0); - + /* composite original text_layer onto shadow_layer */ $canvas->compositeImage($kernel, \Imagick::COMPOSITE_OVER, 0, 0); $canvas->setImageFormat('png'); @@ -159,7 +159,7 @@ function createFromMatrix() { return $kernel; } - + function fromMatrix() { $kernel = createFromMatrix(); $imagick = renderKernel($kernel); diff --git a/reference/imagick/imagickkernel/getmatrix.xml b/reference/imagick/imagickkernel/getmatrix.xml index 574c498d3..c5e1abe72 100644 --- a/reference/imagick/imagickkernel/getmatrix.xml +++ b/reference/imagick/imagickkernel/getmatrix.xml @@ -13,10 +13,10 @@ public arrayImagickKernel::getMatrix - + Get the 2d matrix of values used in this kernel. The elements are either float for elements that are used or 'false' if the element should be skipped. - + @@ -27,9 +27,9 @@ &reftitle.returnvalues; - + A matrix (2d array) of the values that represent the kernel. - + diff --git a/reference/imagick/imagickkernel/scale.xml b/reference/imagick/imagickkernel/scale.xml index 41ab37f0c..764c822fd 100644 --- a/reference/imagick/imagickkernel/scale.xml +++ b/reference/imagick/imagickkernel/scale.xml @@ -14,13 +14,13 @@ floatscale intnormalizeFlag - + Scales the given kernel list by the given amount, with or without normalization of the sum of the kernel values (as per given flags). The exact behaviour of this function depends on the normalization type being used please see http://www.imagemagick.org/api/morphology.php#ScaleKernelInfo for details. - + @@ -32,9 +32,9 @@ scale - + - + @@ -56,9 +56,9 @@ &reftitle.returnvalues; - - - + + + @@ -76,7 +76,7 @@ function renderKernelTable($matrix) { $output = ""; - + foreach ($matrix as $row) { $output .= ""; foreach ($row as $cell) { @@ -91,15 +91,15 @@ } $output .= ""; } - + $output .= "
    "; - + return $output; } $output = ""; - + $matrix = [ [-1, 0, -1], [ 0, 4, 0], @@ -111,8 +111,8 @@ $output .= "Start kernel
    "; $output .= renderKernelTable($kernel->getMatrix()); - - + + $output .= "Scaling with NORMALIZE_KERNEL_VALUE. The
    "; $kernel->scale(2, \Imagick::NORMALIZE_KERNEL_VALUE); $output .= renderKernelTable($kernel->getMatrix()); @@ -122,19 +122,19 @@ $output .= "Scaling by percent
    "; $kernel->scale(2, \Imagick::NORMALIZE_KERNEL_PERCENT); $output .= renderKernelTable($kernel->getMatrix()); - + $matrix2 = [ [-1, -1, 1], [ -1, false, 1], [1, 1, 1], ]; - + $kernel = \ImagickKernel::fromMatrix($matrix2); $output .= "Scaling by correlate
    "; $kernel->scale(1, \Imagick::NORMALIZE_KERNEL_CORRELATE); $output .= renderKernelTable($kernel->getMatrix()); - return $output; + return $output; ?> ]]> diff --git a/reference/imagick/imagickkernel/separate.xml b/reference/imagick/imagickkernel/separate.xml index 40fe0beb0..c9e0208d1 100644 --- a/reference/imagick/imagickkernel/separate.xml +++ b/reference/imagick/imagickkernel/separate.xml @@ -13,9 +13,9 @@ public arrayImagickKernel::separate - + Separates a linked set of kernels and returns an array of ImagickKernels. - + @@ -26,9 +26,9 @@ &reftitle.returnvalues; - - - + + + @@ -44,7 +44,7 @@ "; @@ -62,9 +62,9 @@ } $output .= ""; } - + $output .= ""; - + return $output; } @@ -83,9 +83,9 @@ ); $kernel->addKernel($diamondKernel); - + $kernelList = $kernel->separate(); - + $output = ''; $count = 0; foreach ($kernelList as $kernel) { diff --git a/reference/imagick/imagickkernelexception.xml b/reference/imagick/imagickkernelexception.xml index 712bf1e9e..0ebfd03c9 100644 --- a/reference/imagick/imagickkernelexception.xml +++ b/reference/imagick/imagickkernelexception.xml @@ -11,9 +11,9 @@
    &reftitle.intro; - + - +
    diff --git a/reference/imagick/imagickpixel/clear.xml b/reference/imagick/imagickpixel/clear.xml index 6257adef1..121116b4a 100644 --- a/reference/imagick/imagickpixel/clear.xml +++ b/reference/imagick/imagickpixel/clear.xml @@ -1,6 +1,6 @@ - + ImagickPixel::clear Clears resources associated with this object @@ -13,17 +13,17 @@ &warn.undocumented.func; - + Clears the ImagickPixel object, leaving it in a fresh state. This also unsets any color associated with the object. - + &reftitle.returnvalues; - + &imagick.return.success; - + diff --git a/reference/imagick/imagickpixel/construct.xml b/reference/imagick/imagickpixel/construct.xml index 59e249d52..ac9d7850e 100644 --- a/reference/imagick/imagickpixel/construct.xml +++ b/reference/imagick/imagickpixel/construct.xml @@ -1,6 +1,6 @@ - + ImagickPixel::__construct The ImagickPixel constructor @@ -13,10 +13,10 @@ stringcolor &warn.undocumented.func; - + Constructs an ImagickPixel object. If a color is specified, the object is constructed and then initialised with that color before being returned. - + @@ -26,9 +26,9 @@ color - + The optional color string to use as the initial value of this object. - + @@ -37,10 +37,10 @@ &reftitle.returnvalues; - + Returns an ImagickPixel object on success, throwing ImagickPixelException on failure. - + @@ -56,7 +56,7 @@ function construct() { $columns = 4; - + $exampleColors = array( "rgba(100%, 0%, 0%, 0.5)", "hsb(33.3333%, 100%, 75%)", // medium green diff --git a/reference/imagick/imagickpixel/destroy.xml b/reference/imagick/imagickpixel/destroy.xml index 1a45dae91..688db029c 100644 --- a/reference/imagick/imagickpixel/destroy.xml +++ b/reference/imagick/imagickpixel/destroy.xml @@ -1,6 +1,6 @@ - + ImagickPixel::destroy Deallocates resources associated with this object @@ -13,18 +13,18 @@ &warn.undocumented.func; - + Deallocates any resources used by the ImagickPixel object, and unsets any associated color. The object should not be used after the destroy function has been called. - + &reftitle.returnvalues; - + &imagick.return.success; - + diff --git a/reference/imagick/imagickpixel/getcolor.xml b/reference/imagick/imagickpixel/getcolor.xml index 7bd38098f..64ce7dbb8 100644 --- a/reference/imagick/imagickpixel/getcolor.xml +++ b/reference/imagick/imagickpixel/getcolor.xml @@ -1,6 +1,6 @@ - + ImagickPixel::getColor Returns the color @@ -12,10 +12,10 @@ public arrayImagickPixel::getColor intnormalized0 - + Returns the color described by the ImagickPixel object, as an array. If the color has an opacity channel set, this is provided as a fourth value in the list. - + @@ -25,10 +25,10 @@ normalized - + Normalize the color values. Possible values are 0, 1 or 2. - + @@ -82,9 +82,9 @@ <refsect1 role="returnvalues"> &reftitle.returnvalues; - <para> + <simpara> An array of channel values. Throws ImagickPixelException on error. - </para> + </simpara> </refsect1> <refsect1 role="examples"> diff --git a/reference/imagick/imagickpixel/getcolorasstring.xml b/reference/imagick/imagickpixel/getcolorasstring.xml index d8ebf44c1..00e995345 100644 --- a/reference/imagick/imagickpixel/getcolorasstring.xml +++ b/reference/imagick/imagickpixel/getcolorasstring.xml @@ -1,6 +1,6 @@ <?xml version="1.0" encoding="utf-8"?> <!-- $Revision$ --> -<refentry xmlns="http://docbook.org/ns/docbook" xml:id="imagickpixel.getcolorasstring"> +<refentry xml:id="imagickpixel.getcolorasstring" xmlns="http://docbook.org/ns/docbook"> <refnamediv> <refname>ImagickPixel::getColorAsString</refname> <refpurpose>Returns the color as a string</refpurpose> @@ -12,9 +12,9 @@ <modifier>public</modifier> <type>string</type><methodname>ImagickPixel::getColorAsString</methodname> <void/> </methodsynopsis> - <para> + <simpara> Returns the color of the ImagickPixel object as a string. - </para> + </simpara> </refsect1> <refsect1 role="parameters"> @@ -24,9 +24,9 @@ <refsect1 role="returnvalues"> &reftitle.returnvalues; - <para> + <simpara> Returns the color of the ImagickPixel object as a string. - </para> + </simpara> </refsect1> <refsect1 role="examples"> @@ -63,9 +63,9 @@ rgb(165,42,42) &reftitle.notes; <note> <title>Alpha not returned - + This function does not return the alpha value of the color in the string. - + diff --git a/reference/imagick/imagickpixel/getcolorcount.xml b/reference/imagick/imagickpixel/getcolorcount.xml index 8c091ec43..94c91034c 100644 --- a/reference/imagick/imagickpixel/getcolorcount.xml +++ b/reference/imagick/imagickpixel/getcolorcount.xml @@ -1,6 +1,6 @@ - + ImagickPixel::getColorCount Returns the color count associated with this color @@ -12,14 +12,14 @@ public intImagickPixel::getColorCount - + Returns the color count associated with this color. - - The color count is the number of pixels in the image that have the same color as this ImagickPixel. - - + + The color count is the number of pixels in the image that have the same color as this ImagickPixel. + + ImagickPixel::getColorCount appears to only work for ImagickPixel objects created through Imagick::getImageHistogram() - + @@ -29,10 +29,10 @@ &reftitle.returnvalues; - + Returns the color count as an integer on success, throws ImagickPixelException on failure. - + &reftitle.examples; @@ -50,9 +50,9 @@ ?> ]]> - + The output for this will be similar to: - + public arrayImagickPixel::getColorQuantum - + Returns the color of the pixel in an array as Quantum values. If ImageMagick was compiled as HDRI these will be floats, otherwise they will be integers. - + &warn.undocumented.func; @@ -29,10 +29,10 @@ &reftitle.returnvalues; - + Returns an array with keys "r", "g", "b", "a". - + diff --git a/reference/imagick/imagickpixel/getcolorvalue.xml b/reference/imagick/imagickpixel/getcolorvalue.xml index e47179bda..73fe9e976 100644 --- a/reference/imagick/imagickpixel/getcolorvalue.xml +++ b/reference/imagick/imagickpixel/getcolorvalue.xml @@ -1,6 +1,6 @@ - + ImagickPixel::getColorValue Gets the normalized value of the provided color channel @@ -12,10 +12,10 @@ public floatImagickPixel::getColorValue intcolor - + Retrieves the value of the color channel specified, as a floating-point number between 0 and 1. - + @@ -25,11 +25,11 @@ color - + The color to get the value of, specified as one of the Imagick color constants. This can be one of the RGB colors, CMYK colors, alpha and opacity e.g (Imagick::COLOR_BLUE, Imagick::COLOR_MAGENTA). - + @@ -38,10 +38,10 @@ &reftitle.returnvalues; - + The value of the channel, as a normalized floating-point number, throwing ImagickPixelException on error. - + @@ -52,7 +52,7 @@ getColorValue(Imagick::COLOR_ALPHA).PHP_EOL; diff --git a/reference/imagick/imagickpixel/getcolorvaluequantum.xml b/reference/imagick/imagickpixel/getcolorvaluequantum.xml index bee7eb3cb..b96bbf1bf 100644 --- a/reference/imagick/imagickpixel/getcolorvaluequantum.xml +++ b/reference/imagick/imagickpixel/getcolorvaluequantum.xml @@ -13,9 +13,9 @@ public intfloatImagickPixel::getColorValueQuantum intcolor - + Gets the quantum value of a color in the ImagickPixel. Return value is a float if ImageMagick was compiled with HDRI, otherwise an integer. - + @@ -26,9 +26,9 @@ &reftitle.returnvalues; - + The quantum value of the color element. Float if ImageMagick was compiled with HDRI, otherwise an int. - + diff --git a/reference/imagick/imagickpixel/gethsl.xml b/reference/imagick/imagickpixel/gethsl.xml index 48fff13df..479fffaec 100644 --- a/reference/imagick/imagickpixel/gethsl.xml +++ b/reference/imagick/imagickpixel/gethsl.xml @@ -1,6 +1,6 @@ - + ImagickPixel::getHSL Returns the normalized HSL color of the ImagickPixel object @@ -12,11 +12,11 @@ public arrayImagickPixel::getHSL - + Returns the normalized HSL color described by the ImagickPixel object, with each of the three values as floating point numbers between 0.0 and 1.0. - + @@ -26,10 +26,10 @@ &reftitle.returnvalues; - + Returns the HSL value in an array with the keys "hue", "saturation", and "luminosity". Throws ImagickPixelException on failure. - + @@ -68,9 +68,9 @@ Array &reftitle.notes; - + Available with ImageMagick library version 6.2.9 and higher. - + diff --git a/reference/imagick/imagickpixel/getindex.xml b/reference/imagick/imagickpixel/getindex.xml index 73eeacb25..807c6309a 100644 --- a/reference/imagick/imagickpixel/getindex.xml +++ b/reference/imagick/imagickpixel/getindex.xml @@ -13,9 +13,9 @@ public intImagickPixel::getIndex - + Gets the colormap index of the pixel wand. - + @@ -26,9 +26,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/imagick/imagickpixel/ispixelsimilar.xml b/reference/imagick/imagickpixel/ispixelsimilar.xml index bffea0051..e35e0bdce 100644 --- a/reference/imagick/imagickpixel/ispixelsimilar.xml +++ b/reference/imagick/imagickpixel/ispixelsimilar.xml @@ -1,6 +1,6 @@ - + ImagickPixel::isPixelSimilar Check the distance between this color and another @@ -13,14 +13,14 @@ ImagickPixelcolor floatfuzz - + Checks the distance between the color described by this ImagickPixel object and that of the provided object, by plotting their RGB values on the color cube. If the distance between the two points is less than the fuzz value given, the colors are similar. This method replaces ImagickPixel::isSimilar() and correctly normalises the fuzz value to ImageMagick QuantumRange. - + @@ -30,19 +30,19 @@ color - + The ImagickPixel object to compare this object against. - + fuzz - + The maximum distance within which to consider these colors as similar. The theoretical maximum for this value is the square root of three (1.732). - + @@ -51,9 +51,9 @@ &reftitle.returnvalues; - + &imagick.return.success; - + diff --git a/reference/imagick/imagickpixel/ispixelsimilarquantum.xml b/reference/imagick/imagickpixel/ispixelsimilarquantum.xml index a7938489c..e82b8603a 100644 --- a/reference/imagick/imagickpixel/ispixelsimilarquantum.xml +++ b/reference/imagick/imagickpixel/ispixelsimilarquantum.xml @@ -14,12 +14,12 @@ stringcolor stringfuzz - + Returns true if the distance between two colors is less than the specified distance. The fuzz value should be in the range 0-QuantumRange. The maximum value represents the longest possible distance in the colorspace. e.g. from RGB(0, 0, 0) to RGB(255, 255, 255) for the RGB colorspace - + @@ -29,17 +29,17 @@ color - - - + + + fuzz - - - + + + @@ -47,9 +47,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/imagick/imagickpixel/issimilar.xml b/reference/imagick/imagickpixel/issimilar.xml index 9d553ccf0..3be8ece17 100644 --- a/reference/imagick/imagickpixel/issimilar.xml +++ b/reference/imagick/imagickpixel/issimilar.xml @@ -1,6 +1,6 @@ - + ImagickPixel::isSimilar Check the distance between this color and another @@ -14,13 +14,13 @@ floatfuzz &warn.undocumented.func; - + Checks the distance between the color described by this ImagickPixel object and that of the provided object, by plotting their RGB values on the color cube. If the distance between the two points is less than the fuzz value given, the colors are similar. Deprecated in favour of ImagickPixel::isPixelSimilar(). - + @@ -30,19 +30,19 @@ color - + The ImagickPixel object to compare this object against. - + fuzz - + The maximum distance within which to consider these colors as similar. The theoretical maximum for this value is the square root of three (1.732). - + @@ -51,9 +51,9 @@ &reftitle.returnvalues; - + &imagick.return.success; - + @@ -129,7 +129,7 @@ "; - + $output .= sprintf( $layout, $color1, @@ -140,7 +140,7 @@ } $output .= "
    %s %s
    "; - + return $output; ?> diff --git a/reference/imagick/imagickpixel/setcolor.xml b/reference/imagick/imagickpixel/setcolor.xml index 2bc18b3e4..28ceffdf3 100644 --- a/reference/imagick/imagickpixel/setcolor.xml +++ b/reference/imagick/imagickpixel/setcolor.xml @@ -1,6 +1,6 @@ - + ImagickPixel::setColor Sets the color @@ -13,10 +13,10 @@ stringcolor &warn.undocumented.func; - + Sets the color described by the ImagickPixel object, with a string (e.g. "blue", "#0000ff", "rgb(0,0,255)", "cmyk(100,100,100,10)", etc.). - +     @@ -26,10 +26,10 @@ color - + The color definition to use in order to initialise the ImagickPixel object. - + @@ -38,9 +38,9 @@ &reftitle.returnvalues; - + Returns &true; if the specified color was set, &false; otherwise. - + diff --git a/reference/imagick/imagickpixel/setcolorcount.xml b/reference/imagick/imagickpixel/setcolorcount.xml index 6c32bfac6..d0322f12a 100644 --- a/reference/imagick/imagickpixel/setcolorcount.xml +++ b/reference/imagick/imagickpixel/setcolorcount.xml @@ -13,9 +13,9 @@ public boolImagickPixel::setcolorcount intcolorCount - + Sets the color count associated with this color. - + @@ -25,9 +25,9 @@ colorCount - - - + + + @@ -35,9 +35,9 @@ &reftitle.returnvalues; - + &imagick.return.success; - + diff --git a/reference/imagick/imagickpixel/setcolorvalue.xml b/reference/imagick/imagickpixel/setcolorvalue.xml index d28d35cf3..a7119de36 100644 --- a/reference/imagick/imagickpixel/setcolorvalue.xml +++ b/reference/imagick/imagickpixel/setcolorvalue.xml @@ -1,6 +1,6 @@ - + ImagickPixel::setColorValue Sets the normalized value of one of the channels @@ -13,11 +13,11 @@ intcolor floatvalue - + Sets the value of the specified channel of this object to the provided value, which should be between 0 and 1. This function can be used to provide an opacity channel to an ImagickPixel object. - + @@ -27,17 +27,17 @@ color - + One of the Imagick color constants e.g. \Imagick::COLOR_GREEN or \Imagick::COLOR_ALPHA. - + value - + The value to set this channel to, ranging from 0 to 1. - + @@ -46,9 +46,9 @@ &reftitle.returnvalues; - + &imagick.return.success; - + diff --git a/reference/imagick/imagickpixel/setcolorvaluequantum.xml b/reference/imagick/imagickpixel/setcolorvaluequantum.xml index c70c3adee..55a7db097 100644 --- a/reference/imagick/imagickpixel/setcolorvaluequantum.xml +++ b/reference/imagick/imagickpixel/setcolorvaluequantum.xml @@ -14,9 +14,9 @@ intcolor intfloatvalue - + Sets the quantum value of a color element of the ImagickPixel. - + &warn.undocumented.func; @@ -28,9 +28,9 @@ color - + Which color element to set e.g. \Imagick::COLOR_GREEN. - + @@ -38,20 +38,20 @@ value - + The quantum value to set the color element to. This should be a float if ImageMagick was compiled with HDRI otherwise an int in the range 0 to Imagick::getQuantum(). - + - + &reftitle.returnvalues; - + &imagick.return.success; - + diff --git a/reference/imagick/imagickpixel/sethsl.xml b/reference/imagick/imagickpixel/sethsl.xml index 492b10cd0..5030c4195 100644 --- a/reference/imagick/imagickpixel/sethsl.xml +++ b/reference/imagick/imagickpixel/sethsl.xml @@ -1,6 +1,6 @@ - + ImagickPixel::setHSL Sets the normalized HSL color @@ -14,10 +14,10 @@ floatsaturation floatluminosity - + Sets the color described by the ImagickPixel object using normalized values for hue, saturation and luminosity. - + @@ -27,28 +27,28 @@ hue - + The normalized value for hue, described as a fractional arc (between 0 and 1) of the hue circle, where the zero value is red. - + saturation - + The normalized value for saturation, with 1 as full saturation. - + luminosity - + The normalized value for luminosity, on a scale from black at 0 to white at 1, with the full HS value at 0.5 luminosity. - + @@ -57,9 +57,9 @@ &reftitle.returnvalues; - + &imagick.return.success; - + @@ -112,9 +112,9 @@ Array &reftitle.notes; - + Available with ImageMagick library version 6.2.9 and higher. - + diff --git a/reference/imagick/imagickpixel/setindex.xml b/reference/imagick/imagickpixel/setindex.xml index 0a2dec909..ec56027fe 100644 --- a/reference/imagick/imagickpixel/setindex.xml +++ b/reference/imagick/imagickpixel/setindex.xml @@ -13,9 +13,9 @@ public boolImagickPixel::setIndex intindex - + Sets the colormap index of the pixel wand. - + @@ -25,9 +25,9 @@ index - - - + + + @@ -35,9 +35,9 @@ &reftitle.returnvalues; - + &imagick.return.success; - + diff --git a/reference/imagick/imagickpixeliterator/clear.xml b/reference/imagick/imagickpixeliterator/clear.xml index 49a29b06d..f52b5743a 100644 --- a/reference/imagick/imagickpixeliterator/clear.xml +++ b/reference/imagick/imagickpixeliterator/clear.xml @@ -1,6 +1,6 @@ - + ImagickPixelIterator::clear Clear resources associated with a PixelIterator @@ -13,16 +13,16 @@ &warn.undocumented.func; - + Clear resources associated with a PixelIterator. - + &reftitle.returnvalues; - + &imagick.return.success; - + @@ -41,13 +41,13 @@ function clear($imagePath) { $imageIterator = $imagick->getPixelRegionIterator(100, 100, 250, 200); /* Loop through pixel rows */ - foreach ($imageIterator as $pixels) { + foreach ($imageIterator as $pixels) { /** @var $pixel \ImagickPixel */ /* Loop through the pixels in the row (columns) */ - foreach ($pixels as $column => $pixel) { + foreach ($pixels as $column => $pixel) { if ($column % 2) { /* Paint every second pixel black*/ - $pixel->setColor("rgba(0, 0, 0, 0)"); + $pixel->setColor("rgba(0, 0, 0, 0)"); } } /* Sync the iterator, this is important to do on each iteration */ diff --git a/reference/imagick/imagickpixeliterator/construct.xml b/reference/imagick/imagickpixeliterator/construct.xml index 5044d7fee..065b55cc6 100644 --- a/reference/imagick/imagickpixeliterator/construct.xml +++ b/reference/imagick/imagickpixeliterator/construct.xml @@ -1,6 +1,6 @@ - + ImagickPixelIterator::__construct The ImagickPixelIterator constructor @@ -13,16 +13,16 @@ Imagickwand &warn.undocumented.func; - + The ImagickPixelIterator constructor - + &reftitle.returnvalues; - + &imagick.return.success; - + @@ -40,9 +40,9 @@ function construct($imagePath) { $imageIterator = new \ImagickPixelIterator($imagick); /* Loop through pixel rows */ - foreach ($imageIterator as $pixels) { + foreach ($imageIterator as $pixels) { /* Loop through the pixels in the row (columns) */ - foreach ($pixels as $column => $pixel) { + foreach ($pixels as $column => $pixel) { /** @var $pixel \ImagickPixel */ if ($column % 2) { /* Paint every second pixel black*/ diff --git a/reference/imagick/imagickpixeliterator/destroy.xml b/reference/imagick/imagickpixeliterator/destroy.xml index c8ca29ce0..8345134af 100644 --- a/reference/imagick/imagickpixeliterator/destroy.xml +++ b/reference/imagick/imagickpixeliterator/destroy.xml @@ -1,6 +1,6 @@ - + ImagickPixelIterator::destroy Deallocates resources associated with a PixelIterator @@ -13,16 +13,16 @@ &warn.undocumented.func; - + Deallocates resources associated with a PixelIterator. - + &reftitle.returnvalues; - + &imagick.return.success; - + diff --git a/reference/imagick/imagickpixeliterator/getcurrentiteratorrow.xml b/reference/imagick/imagickpixeliterator/getcurrentiteratorrow.xml index dab069089..d3f4a34b7 100644 --- a/reference/imagick/imagickpixeliterator/getcurrentiteratorrow.xml +++ b/reference/imagick/imagickpixeliterator/getcurrentiteratorrow.xml @@ -1,6 +1,6 @@ - + ImagickPixelIterator::getCurrentIteratorRow Returns the current row of ImagickPixel objects @@ -13,16 +13,16 @@ &warn.undocumented.func; - + Returns the current row as an array of ImagickPixel objects from the pixel iterator. - + &reftitle.returnvalues; - + Returns a row as an array of ImagickPixel objects that can themselves be iterated. - + diff --git a/reference/imagick/imagickpixeliterator/getiteratorrow.xml b/reference/imagick/imagickpixeliterator/getiteratorrow.xml index 0c69227ca..64dd70619 100644 --- a/reference/imagick/imagickpixeliterator/getiteratorrow.xml +++ b/reference/imagick/imagickpixeliterator/getiteratorrow.xml @@ -1,6 +1,6 @@ - + ImagickPixelIterator::getIteratorRow Returns the current pixel iterator row @@ -13,17 +13,17 @@ &warn.undocumented.func; - + Returns the current pixel iterator row. - + &reftitle.returnvalues; - + Returns the integer offset of the row, throwing ImagickPixelIteratorException on error. - + diff --git a/reference/imagick/imagickpixeliterator/getnextiteratorrow.xml b/reference/imagick/imagickpixeliterator/getnextiteratorrow.xml index a5bfbdb72..62907582f 100644 --- a/reference/imagick/imagickpixeliterator/getnextiteratorrow.xml +++ b/reference/imagick/imagickpixeliterator/getnextiteratorrow.xml @@ -1,6 +1,6 @@ - + ImagickPixelIterator::getNextIteratorRow Returns the next row of the pixel iterator @@ -13,17 +13,17 @@ &warn.undocumented.func; - + Returns the next row as an array of pixel wands from the pixel iterator. - + &reftitle.returnvalues; - + Returns the next row as an array of ImagickPixel objects, throwing ImagickPixelIteratorException on error. - + @@ -44,7 +44,7 @@ function getNextIteratorRow($imagePath) { while ($pixels = $imageIterator->getNextIteratorRow()) { if (($count % 3) == 0) { /* Loop through the pixels in the row (columns) */ - foreach ($pixels as $column => $pixel) { + foreach ($pixels as $column => $pixel) { /** @var $pixel \ImagickPixel */ if ($column % 2) { /* Paint every second pixel black*/ @@ -52,7 +52,7 @@ function getNextIteratorRow($imagePath) { } } /* Sync the iterator, this is important to do on each iteration */ - $imageIterator->syncIterator(); + $imageIterator->syncIterator(); } $count += 1; diff --git a/reference/imagick/imagickpixeliterator/getpreviousiteratorrow.xml b/reference/imagick/imagickpixeliterator/getpreviousiteratorrow.xml index a976c6f14..145151612 100644 --- a/reference/imagick/imagickpixeliterator/getpreviousiteratorrow.xml +++ b/reference/imagick/imagickpixeliterator/getpreviousiteratorrow.xml @@ -1,6 +1,6 @@ - + ImagickPixelIterator::getPreviousIteratorRow Returns the previous row @@ -13,17 +13,17 @@ &warn.undocumented.func; - + Returns the previous row as an array of pixel wands from the pixel iterator. - + &reftitle.returnvalues; - + Returns the previous row as an array of ImagickPixelWand objects from the ImagickPixelIterator, throwing ImagickPixelIteratorException on error. - + diff --git a/reference/imagick/imagickpixeliterator/newpixeliterator.xml b/reference/imagick/imagickpixeliterator/newpixeliterator.xml index d32e9b165..cfd7ec777 100644 --- a/reference/imagick/imagickpixeliterator/newpixeliterator.xml +++ b/reference/imagick/imagickpixeliterator/newpixeliterator.xml @@ -1,6 +1,6 @@ - + ImagickPixelIterator::newPixelIterator Returns a new pixel iterator @@ -13,16 +13,16 @@ Imagickwand &warn.undocumented.func; - + Returns a new pixel iterator. - + &reftitle.returnvalues; - + &imagick.return.success; Throwing ImagickPixelIteratorException. - + diff --git a/reference/imagick/imagickpixeliterator/newpixelregioniterator.xml b/reference/imagick/imagickpixeliterator/newpixelregioniterator.xml index b7ed0771f..08a81990a 100644 --- a/reference/imagick/imagickpixeliterator/newpixelregioniterator.xml +++ b/reference/imagick/imagickpixeliterator/newpixelregioniterator.xml @@ -1,6 +1,6 @@ - + ImagickPixelIterator::newPixelRegionIterator Returns a new pixel iterator @@ -17,9 +17,9 @@ introws &warn.undocumented.func; - + Returns a new pixel iterator. - + @@ -29,36 +29,36 @@ wand - - + + x - - + + y - - + + columns - - + + rows - - + + @@ -67,10 +67,10 @@ &reftitle.returnvalues; - + Returns a new ImagickPixelIterator on success; on failure, throws ImagickPixelIteratorException. - + diff --git a/reference/imagick/imagickpixeliterator/resetiterator.xml b/reference/imagick/imagickpixeliterator/resetiterator.xml index 2ac2f65e3..820133f33 100644 --- a/reference/imagick/imagickpixeliterator/resetiterator.xml +++ b/reference/imagick/imagickpixeliterator/resetiterator.xml @@ -13,18 +13,18 @@ &warn.undocumented.func; - + Resets the pixel iterator. Use it in conjunction with ImagickPixelIterator::getNextIteratorRow() to iterate over all the pixels in a pixel container. - + &reftitle.returnvalues; - + &imagick.return.success; - + @@ -51,7 +51,7 @@ function resetIterator($imagePath) { if ($column % 2) { /* Make every second pixel 25% red*/ - $pixel->setColorValue(\Imagick::COLOR_RED, 64); + $pixel->setColorValue(\Imagick::COLOR_RED, 64); } } /* Sync the iterator, this is important to do on each iteration */ diff --git a/reference/imagick/imagickpixeliterator/setiteratorfirstrow.xml b/reference/imagick/imagickpixeliterator/setiteratorfirstrow.xml index 0a4451426..7f7c08931 100644 --- a/reference/imagick/imagickpixeliterator/setiteratorfirstrow.xml +++ b/reference/imagick/imagickpixeliterator/setiteratorfirstrow.xml @@ -1,6 +1,6 @@ - + ImagickPixelIterator::setIteratorFirstRow Sets the pixel iterator to the first pixel row @@ -13,16 +13,16 @@ &warn.undocumented.func; - + Sets the pixel iterator to the first pixel row. - + &reftitle.returnvalues; - + &imagick.return.success; - + diff --git a/reference/imagick/imagickpixeliterator/setiteratorlastrow.xml b/reference/imagick/imagickpixeliterator/setiteratorlastrow.xml index bfe368a4d..8013d2f47 100644 --- a/reference/imagick/imagickpixeliterator/setiteratorlastrow.xml +++ b/reference/imagick/imagickpixeliterator/setiteratorlastrow.xml @@ -1,6 +1,6 @@ - + ImagickPixelIterator::setIteratorLastRow Sets the pixel iterator to the last pixel row @@ -13,16 +13,16 @@ &warn.undocumented.func; - + Sets the pixel iterator to the last pixel row. - + &reftitle.returnvalues; - + &imagick.return.success; - + diff --git a/reference/imagick/imagickpixeliterator/setiteratorrow.xml b/reference/imagick/imagickpixeliterator/setiteratorrow.xml index 5198a8483..249f8612f 100644 --- a/reference/imagick/imagickpixeliterator/setiteratorrow.xml +++ b/reference/imagick/imagickpixeliterator/setiteratorrow.xml @@ -1,6 +1,6 @@ - + ImagickPixelIterator::setIteratorRow Set the pixel iterator row @@ -13,9 +13,9 @@ introw &warn.undocumented.func; - + Set the pixel iterator row. - + @@ -25,8 +25,8 @@ row - - + + @@ -35,9 +35,9 @@ &reftitle.returnvalues; - + &imagick.return.success; - + @@ -54,14 +54,14 @@ function setIteratorRow($imagePath) { $imagick = new \Imagick(realpath($imagePath)); $imageIterator = $imagick->getPixelRegionIterator(200, 100, 200, 200); - for ($x = 0; $x < 20; $x++) { + for ($x = 0; $x < 20; $x++) { $imageIterator->setIteratorRow($x * 5); $pixels = $imageIterator->getCurrentIteratorRow(); /* Loop through the pixels in the row (columns) */ foreach ($pixels as $pixel) { /** @var $pixel \ImagickPixel */ /* Paint every second pixel black*/ - $pixel->setColor("rgba(0, 0, 0, 0)"); + $pixel->setColor("rgba(0, 0, 0, 0)"); } /* Sync the iterator, this is important to do on each iteration */ diff --git a/reference/imagick/imagickpixeliterator/synciterator.xml b/reference/imagick/imagickpixeliterator/synciterator.xml index 780bc01ca..6e22ecced 100644 --- a/reference/imagick/imagickpixeliterator/synciterator.xml +++ b/reference/imagick/imagickpixeliterator/synciterator.xml @@ -1,6 +1,6 @@ - + ImagickPixelIterator::syncIterator Syncs the pixel iterator @@ -13,16 +13,16 @@ &warn.undocumented.func; - + Syncs the pixel iterator. - + &reftitle.returnvalues; - + &imagick.return.success; - + diff --git a/reference/imagick/ini.xml b/reference/imagick/ini.xml index 1bdabf490..5bed0031d 100644 --- a/reference/imagick/ini.xml +++ b/reference/imagick/ini.xml @@ -33,15 +33,15 @@ &false; INI_SYSTEM Available since Imagick 3.3.0 - + &ini.php.constants; - + &ini.descriptions.title; - + @@ -50,10 +50,10 @@ bool - + Fixes a drawing bug with locales that use ',' as float separators. - + @@ -63,10 +63,10 @@ bool - + Used to enable the image progress monitor. - +     @@ -76,11 +76,11 @@ bool - + When Imagick is loaded, it checks the version number of ImageMagick that it was compiled against, with the version number that is currently being used and will give a warning if they don't match. This warning can be suppressed by enabling this ini setting. - - Using a version of Imagick that was compiled against a different version of ImageMagick than the one being used is not recommended. Although it may appear to work, it can lead to random crashes or other undefined behaviour. - + + Using a version of Imagick that was compiled against a different version of ImageMagick than the one being used is not recommended. Although it may appear to work, it can lead to random crashes or other undefined behaviour. + diff --git a/reference/imagick/setup.xml b/reference/imagick/setup.xml index 7ef358227..d64d67fc2 100644 --- a/reference/imagick/setup.xml +++ b/reference/imagick/setup.xml @@ -9,12 +9,12 @@ &reftitle.required;
    Installation requirements on non-Windows platforms - + ImageMagick >= 6.2.4 is required. The amount of file formats supported by Imagick depends entirely upon the amount of formats supported by your ImageMagick installation. For example, Imagemagick requires ghostscript to conduct PDF operations. - +
    @@ -22,17 +22,17 @@
    &reftitle.install; - + &pecl.moved; - - + + &pecl.info; &url.pecl.package;imagick. - + The official name of this extension is imagick. - + Windows users can download prebuilt DLL from the PECL website. These packages already contain the extension DLL (php_imagick.dll) which needs to be put into the extension_dir. @@ -42,7 +42,7 @@ or alternatively in the path given by the environment variable MAGICK_CONFIGURE_PATH. Refer to the ImageMagick configuration files documentation for further details. - +
    diff --git a/reference/inotify/book.xml b/reference/inotify/book.xml index 61d71ba98..f9cd9d7d8 100644 --- a/reference/inotify/book.xml +++ b/reference/inotify/book.xml @@ -1,6 +1,6 @@ - + Inotify diff --git a/reference/inotify/functions/inotify-add-watch.xml b/reference/inotify/functions/inotify-add-watch.xml index 2516456c8..9cef2c3d6 100644 --- a/reference/inotify/functions/inotify-add-watch.xml +++ b/reference/inotify/functions/inotify-add-watch.xml @@ -1,6 +1,6 @@ - + inotify_add_watch Add a watch to an initialized inotify instance diff --git a/reference/inotify/functions/inotify-init.xml b/reference/inotify/functions/inotify-init.xml index bd1043e5c..9c2639596 100644 --- a/reference/inotify/functions/inotify-init.xml +++ b/reference/inotify/functions/inotify-init.xml @@ -1,6 +1,6 @@ - + inotify_init Initialize an inotify instance diff --git a/reference/inotify/functions/inotify-queue-len.xml b/reference/inotify/functions/inotify-queue-len.xml index 713b4c49f..b7102742a 100644 --- a/reference/inotify/functions/inotify-queue-len.xml +++ b/reference/inotify/functions/inotify-queue-len.xml @@ -1,6 +1,6 @@ - + inotify_queue_len Return a number upper than zero if there are pending events diff --git a/reference/inotify/functions/inotify-read.xml b/reference/inotify/functions/inotify-read.xml index ad3515f46..f70546f5f 100644 --- a/reference/inotify/functions/inotify-read.xml +++ b/reference/inotify/functions/inotify-read.xml @@ -1,6 +1,6 @@ - + inotify_read Read events from an inotify instance diff --git a/reference/inotify/functions/inotify-rm-watch.xml b/reference/inotify/functions/inotify-rm-watch.xml index 04dd25905..812b722c1 100644 --- a/reference/inotify/functions/inotify-rm-watch.xml +++ b/reference/inotify/functions/inotify-rm-watch.xml @@ -1,6 +1,6 @@ - + inotify_rm_watch Remove an existing watch from an inotify instance diff --git a/reference/inotify/setup.xml b/reference/inotify/setup.xml index 747befe74..7e955f1e5 100644 --- a/reference/inotify/setup.xml +++ b/reference/inotify/setup.xml @@ -1,6 +1,6 @@ - + &reftitle.setup; diff --git a/reference/lua/book.xml b/reference/lua/book.xml index 6c4a36c15..e95c37a38 100644 --- a/reference/lua/book.xml +++ b/reference/lua/book.xml @@ -1,6 +1,6 @@ - + Lua Lua diff --git a/reference/lua/configure.xml b/reference/lua/configure.xml index 65fd36c3c..4bb5beb79 100644 --- a/reference/lua/configure.xml +++ b/reference/lua/configure.xml @@ -1,6 +1,6 @@ -
    +
    &reftitle.install; diff --git a/reference/lua/lua.xml b/reference/lua/lua.xml index 73cdbb42f..2c1b2d2d1 100644 --- a/reference/lua/lua.xml +++ b/reference/lua/lua.xml @@ -1,6 +1,6 @@ - + The Lua class Lua diff --git a/reference/lua/lua/assign.xml b/reference/lua/lua/assign.xml index 4b474fc50..646f455ad 100644 --- a/reference/lua/lua/assign.xml +++ b/reference/lua/lua/assign.xml @@ -1,6 +1,6 @@ - + Lua::assign Assign a PHP variable to Lua diff --git a/reference/lua/lua/call.xml b/reference/lua/lua/call.xml index 01be73cae..a78c7dea8 100644 --- a/reference/lua/lua/call.xml +++ b/reference/lua/lua/call.xml @@ -1,6 +1,6 @@ - + Lua::call Lua::__call diff --git a/reference/lua/lua/construct.xml b/reference/lua/lua/construct.xml index 5e43fd610..7d037ffa0 100644 --- a/reference/lua/lua/construct.xml +++ b/reference/lua/lua/construct.xml @@ -1,6 +1,6 @@ - + Lua::__construct Lua constructor diff --git a/reference/lua/lua/eval.xml b/reference/lua/lua/eval.xml index 2e8c7581f..8884390b6 100644 --- a/reference/lua/lua/eval.xml +++ b/reference/lua/lua/eval.xml @@ -1,6 +1,6 @@ - + Lua::eval Evaluate a string as Lua code diff --git a/reference/lua/lua/getversion.xml b/reference/lua/lua/getversion.xml index 2b376965e..4857e29fd 100644 --- a/reference/lua/lua/getversion.xml +++ b/reference/lua/lua/getversion.xml @@ -1,6 +1,6 @@ - + Lua::getVersion The getversion purpose diff --git a/reference/lua/lua/include.xml b/reference/lua/lua/include.xml index 8444b0b13..0f51d9e58 100644 --- a/reference/lua/lua/include.xml +++ b/reference/lua/lua/include.xml @@ -1,6 +1,6 @@ - + Lua::include Parse a Lua script file diff --git a/reference/lua/lua/registercallback.xml b/reference/lua/lua/registercallback.xml index 29a527bf7..13a2aa447 100644 --- a/reference/lua/lua/registercallback.xml +++ b/reference/lua/lua/registercallback.xml @@ -1,6 +1,6 @@ - + Lua::registerCallback Register a PHP function to Lua diff --git a/reference/lua/luaclosure.xml b/reference/lua/luaclosure.xml index 6b6e14f7a..f9a3519b6 100644 --- a/reference/lua/luaclosure.xml +++ b/reference/lua/luaclosure.xml @@ -1,6 +1,6 @@ - + The LuaClosure class LuaClosure diff --git a/reference/lua/luaclosure/invoke.xml b/reference/lua/luaclosure/invoke.xml index 7251581e3..7447f646e 100644 --- a/reference/lua/luaclosure/invoke.xml +++ b/reference/lua/luaclosure/invoke.xml @@ -1,6 +1,6 @@ - + LuaClosure::__invoke Invoke luaclosure diff --git a/reference/lua/luaexception.xml b/reference/lua/luaexception.xml index 9547be226..9cc92c980 100644 --- a/reference/lua/luaexception.xml +++ b/reference/lua/luaexception.xml @@ -1,6 +1,6 @@ - + The LuaException class LuaException diff --git a/reference/lua/setup.xml b/reference/lua/setup.xml index 6b80c9a83..eef5a5743 100644 --- a/reference/lua/setup.xml +++ b/reference/lua/setup.xml @@ -1,6 +1,6 @@ - + &reftitle.setup;
    diff --git a/reference/luasandbox/book.xml b/reference/luasandbox/book.xml index 80a38d33d..caa15a2d5 100644 --- a/reference/luasandbox/book.xml +++ b/reference/luasandbox/book.xml @@ -1,6 +1,6 @@ - + LuaSandbox LuaSandbox diff --git a/reference/luasandbox/configure.xml b/reference/luasandbox/configure.xml index eb561590f..4b64b0326 100644 --- a/reference/luasandbox/configure.xml +++ b/reference/luasandbox/configure.xml @@ -1,6 +1,6 @@ -
    +
    &reftitle.install; diff --git a/reference/luasandbox/differences.xml b/reference/luasandbox/differences.xml index be344b1a8..2a3bae73c 100644 --- a/reference/luasandbox/differences.xml +++ b/reference/luasandbox/differences.xml @@ -1,6 +1,6 @@ - + Differences from Standard Lua diff --git a/reference/luasandbox/examples.xml b/reference/luasandbox/examples.xml index 6dbe9380e..f3d378386 100644 --- a/reference/luasandbox/examples.xml +++ b/reference/luasandbox/examples.xml @@ -1,6 +1,6 @@ - + &reftitle.examples; diff --git a/reference/luasandbox/luasandbox.xml b/reference/luasandbox/luasandbox.xml index a9abd647d..df6d5ac37 100644 --- a/reference/luasandbox/luasandbox.xml +++ b/reference/luasandbox/luasandbox.xml @@ -1,6 +1,6 @@ - + The LuaSandbox class LuaSandbox diff --git a/reference/luasandbox/luasandbox/callfunction.xml b/reference/luasandbox/luasandbox/callfunction.xml index 1e96f4863..f08ee230c 100644 --- a/reference/luasandbox/luasandbox/callfunction.xml +++ b/reference/luasandbox/luasandbox/callfunction.xml @@ -1,6 +1,6 @@ - + LuaSandbox::callFunction Call a function in a Lua global variable diff --git a/reference/luasandbox/luasandbox/disableprofiler.xml b/reference/luasandbox/luasandbox/disableprofiler.xml index 7df8d3af8..c31a2dce3 100644 --- a/reference/luasandbox/luasandbox/disableprofiler.xml +++ b/reference/luasandbox/luasandbox/disableprofiler.xml @@ -1,6 +1,6 @@ - + LuaSandbox::disableProfiler Disable the profiler diff --git a/reference/luasandbox/luasandbox/enableprofiler.xml b/reference/luasandbox/luasandbox/enableprofiler.xml index cc920f65b..c7ef700c9 100644 --- a/reference/luasandbox/luasandbox/enableprofiler.xml +++ b/reference/luasandbox/luasandbox/enableprofiler.xml @@ -1,6 +1,6 @@ - + LuaSandbox::enableProfiler Enable the profiler. diff --git a/reference/luasandbox/luasandbox/getcpuusage.xml b/reference/luasandbox/luasandbox/getcpuusage.xml index 39282100a..105dc6b75 100644 --- a/reference/luasandbox/luasandbox/getcpuusage.xml +++ b/reference/luasandbox/luasandbox/getcpuusage.xml @@ -1,6 +1,6 @@ - + LuaSandbox::getCPUUsage Fetch the current CPU time usage of the Lua environment diff --git a/reference/luasandbox/luasandbox/getmemoryusage.xml b/reference/luasandbox/luasandbox/getmemoryusage.xml index 1a59767ba..b1c170a86 100644 --- a/reference/luasandbox/luasandbox/getmemoryusage.xml +++ b/reference/luasandbox/luasandbox/getmemoryusage.xml @@ -1,6 +1,6 @@ - + LuaSandbox::getMemoryUsage Fetch the current memory usage of the Lua environment diff --git a/reference/luasandbox/luasandbox/getpeakmemoryusage.xml b/reference/luasandbox/luasandbox/getpeakmemoryusage.xml index f152100c8..9c0a8ff1b 100644 --- a/reference/luasandbox/luasandbox/getpeakmemoryusage.xml +++ b/reference/luasandbox/luasandbox/getpeakmemoryusage.xml @@ -1,6 +1,6 @@ - + LuaSandbox::getPeakMemoryUsage Fetch the peak memory usage of the Lua environment diff --git a/reference/luasandbox/luasandbox/getprofilerfunctionreport.xml b/reference/luasandbox/luasandbox/getprofilerfunctionreport.xml index 6301d38a9..bf8c2c29d 100644 --- a/reference/luasandbox/luasandbox/getprofilerfunctionreport.xml +++ b/reference/luasandbox/luasandbox/getprofilerfunctionreport.xml @@ -1,6 +1,6 @@ - + LuaSandbox::getProfilerFunctionReport Fetch profiler data diff --git a/reference/luasandbox/luasandbox/getversioninfo.xml b/reference/luasandbox/luasandbox/getversioninfo.xml index 69d1b7d5e..1f1512127 100644 --- a/reference/luasandbox/luasandbox/getversioninfo.xml +++ b/reference/luasandbox/luasandbox/getversioninfo.xml @@ -1,6 +1,6 @@ - + LuaSandbox::getVersionInfo Return the versions of LuaSandbox and Lua diff --git a/reference/luasandbox/luasandbox/loadbinary.xml b/reference/luasandbox/luasandbox/loadbinary.xml index 3be70973a..681752d78 100644 --- a/reference/luasandbox/luasandbox/loadbinary.xml +++ b/reference/luasandbox/luasandbox/loadbinary.xml @@ -1,6 +1,6 @@ - + LuaSandbox::loadBinary Load a precompiled binary chunk into the Lua environment diff --git a/reference/luasandbox/luasandbox/loadstring.xml b/reference/luasandbox/luasandbox/loadstring.xml index ed71a7fd8..0e9660cbf 100644 --- a/reference/luasandbox/luasandbox/loadstring.xml +++ b/reference/luasandbox/luasandbox/loadstring.xml @@ -1,6 +1,6 @@ - + LuaSandbox::loadString Load Lua code into the Lua environment diff --git a/reference/luasandbox/luasandbox/pauseusagetimer.xml b/reference/luasandbox/luasandbox/pauseusagetimer.xml index 8bf4d7b0f..180d65751 100644 --- a/reference/luasandbox/luasandbox/pauseusagetimer.xml +++ b/reference/luasandbox/luasandbox/pauseusagetimer.xml @@ -1,6 +1,6 @@ - + LuaSandbox::pauseUsageTimer Pause the CPU usage timer diff --git a/reference/luasandbox/luasandbox/registerlibrary.xml b/reference/luasandbox/luasandbox/registerlibrary.xml index 0e19cfbca..cc70bde6e 100644 --- a/reference/luasandbox/luasandbox/registerlibrary.xml +++ b/reference/luasandbox/luasandbox/registerlibrary.xml @@ -1,6 +1,6 @@ - + LuaSandbox::registerLibrary Register a set of PHP functions as a Lua library diff --git a/reference/luasandbox/luasandbox/setcpulimit.xml b/reference/luasandbox/luasandbox/setcpulimit.xml index cb8ff4e2c..39cdfdc6e 100644 --- a/reference/luasandbox/luasandbox/setcpulimit.xml +++ b/reference/luasandbox/luasandbox/setcpulimit.xml @@ -1,6 +1,6 @@ - + LuaSandbox::setCPULimit Set the CPU time limit for the Lua environment @@ -17,7 +17,7 @@ If the total user and system time used by the environment after the call - to this method exceeds this limit, a LuaSandboxTimeoutError + to this method exceeds this limit, a LuaSandboxTimeoutError exception is thrown. diff --git a/reference/luasandbox/luasandbox/setmemorylimit.xml b/reference/luasandbox/luasandbox/setmemorylimit.xml index 4a64f3784..e4f4b99aa 100644 --- a/reference/luasandbox/luasandbox/setmemorylimit.xml +++ b/reference/luasandbox/luasandbox/setmemorylimit.xml @@ -1,6 +1,6 @@ - + LuaSandbox::setMemoryLimit Set the memory limit for the Lua environment @@ -16,7 +16,7 @@ Sets the memory limit for the Lua environment. - If this limit is exceeded, a LuaSandboxMemoryError + If this limit is exceeded, a LuaSandboxMemoryError exception is thrown. diff --git a/reference/luasandbox/luasandbox/unpauseusagetimer.xml b/reference/luasandbox/luasandbox/unpauseusagetimer.xml index 37127b11d..d2d8ac76b 100644 --- a/reference/luasandbox/luasandbox/unpauseusagetimer.xml +++ b/reference/luasandbox/luasandbox/unpauseusagetimer.xml @@ -1,6 +1,6 @@ - + LuaSandbox::unpauseUsageTimer Unpause the timer paused by LuaSandbox::pauseUsageTimer diff --git a/reference/luasandbox/luasandbox/wrapphpfunction.xml b/reference/luasandbox/luasandbox/wrapphpfunction.xml index 079360c68..21cbe83a7 100644 --- a/reference/luasandbox/luasandbox/wrapphpfunction.xml +++ b/reference/luasandbox/luasandbox/wrapphpfunction.xml @@ -1,6 +1,6 @@ - + LuaSandbox::wrapPhpFunction Wrap a PHP callable in a LuaSandboxFunction @@ -22,7 +22,7 @@ Exceptions will be raised as errors in Lua, however only - LuaSandboxRuntimeError exceptions may be caught + LuaSandboxRuntimeError exceptions may be caught inside Lua with pcall() or xpcall(). diff --git a/reference/luasandbox/luasandboxerror.xml b/reference/luasandbox/luasandboxerror.xml index f653f279f..96668c856 100644 --- a/reference/luasandbox/luasandboxerror.xml +++ b/reference/luasandbox/luasandboxerror.xml @@ -1,6 +1,6 @@ - + The LuaSandboxError class LuaSandboxError diff --git a/reference/luasandbox/luasandboxerrorerror.xml b/reference/luasandbox/luasandboxerrorerror.xml index 95f7f5dbe..270bcecdf 100644 --- a/reference/luasandbox/luasandboxerrorerror.xml +++ b/reference/luasandbox/luasandboxerrorerror.xml @@ -1,6 +1,6 @@ - + The LuaSandboxErrorError class LuaSandboxErrorError diff --git a/reference/luasandbox/luasandboxfatalerror.xml b/reference/luasandbox/luasandboxfatalerror.xml index ae9f25353..0252e38a1 100644 --- a/reference/luasandbox/luasandboxfatalerror.xml +++ b/reference/luasandbox/luasandboxfatalerror.xml @@ -1,6 +1,6 @@ - + The LuaSandboxFatalError class LuaSandboxFatalError diff --git a/reference/luasandbox/luasandboxfunction.xml b/reference/luasandbox/luasandboxfunction.xml index a967c4be5..32fd70d62 100644 --- a/reference/luasandbox/luasandboxfunction.xml +++ b/reference/luasandbox/luasandboxfunction.xml @@ -1,6 +1,6 @@ - + The LuaSandboxFunction class LuaSandboxFunction diff --git a/reference/luasandbox/luasandboxfunction/call.xml b/reference/luasandbox/luasandboxfunction/call.xml index c0536015e..622de5cfb 100644 --- a/reference/luasandbox/luasandboxfunction/call.xml +++ b/reference/luasandbox/luasandboxfunction/call.xml @@ -1,6 +1,6 @@ - + LuaSandboxFunction::call Call a Lua function @@ -19,7 +19,7 @@ Errors considered to be the fault of the PHP code will result in the function returning &false; and E_WARNING being raised, for example, a resource type being used as an - argument. Lua errors will result in a LuaSandboxRuntimeError + argument. Lua errors will result in a LuaSandboxRuntimeError exception being thrown. diff --git a/reference/luasandbox/luasandboxfunction/construct.xml b/reference/luasandbox/luasandboxfunction/construct.xml index ae94d0972..988c0211f 100644 --- a/reference/luasandbox/luasandboxfunction/construct.xml +++ b/reference/luasandbox/luasandboxfunction/construct.xml @@ -1,6 +1,6 @@ - + LuaSandboxFunction::__construct Unused diff --git a/reference/luasandbox/luasandboxfunction/dump.xml b/reference/luasandbox/luasandboxfunction/dump.xml index 4c76c59ee..a6a674169 100644 --- a/reference/luasandbox/luasandboxfunction/dump.xml +++ b/reference/luasandbox/luasandboxfunction/dump.xml @@ -1,6 +1,6 @@ - + LuaSandboxFunction::dump Dump the function as a binary blob diff --git a/reference/luasandbox/luasandboxmemoryerror.xml b/reference/luasandbox/luasandboxmemoryerror.xml index 9ae6439a9..f1ee03d8c 100644 --- a/reference/luasandbox/luasandboxmemoryerror.xml +++ b/reference/luasandbox/luasandboxmemoryerror.xml @@ -1,6 +1,6 @@ - + The LuaSandboxMemoryError class LuaSandboxMemoryError diff --git a/reference/luasandbox/luasandboxruntimeerror.xml b/reference/luasandbox/luasandboxruntimeerror.xml index 68a40b2c1..d2c27f4a1 100644 --- a/reference/luasandbox/luasandboxruntimeerror.xml +++ b/reference/luasandbox/luasandboxruntimeerror.xml @@ -1,6 +1,6 @@ - + The LuaSandboxRuntimeError class LuaSandboxRuntimeError diff --git a/reference/luasandbox/luasandboxsyntaxerror.xml b/reference/luasandbox/luasandboxsyntaxerror.xml index 75c2ae450..0deaf0408 100644 --- a/reference/luasandbox/luasandboxsyntaxerror.xml +++ b/reference/luasandbox/luasandboxsyntaxerror.xml @@ -1,6 +1,6 @@ - + The LuaSandboxSyntaxError class LuaSandboxSyntaxError diff --git a/reference/luasandbox/luasandboxtimeouterror.xml b/reference/luasandbox/luasandboxtimeouterror.xml index 978f453b4..a6df4e352 100644 --- a/reference/luasandbox/luasandboxtimeouterror.xml +++ b/reference/luasandbox/luasandboxtimeouterror.xml @@ -1,6 +1,6 @@ - + The LuaSandboxTimeoutError class LuaSandboxTimeoutError diff --git a/reference/luasandbox/setup.xml b/reference/luasandbox/setup.xml index c85c1ab55..51e29be0f 100644 --- a/reference/luasandbox/setup.xml +++ b/reference/luasandbox/setup.xml @@ -1,6 +1,6 @@ - + &reftitle.setup;
    diff --git a/reference/lzf/book.xml b/reference/lzf/book.xml index 25ab569d1..7268b9efc 100644 --- a/reference/lzf/book.xml +++ b/reference/lzf/book.xml @@ -1,6 +1,6 @@ - + LZF LZF diff --git a/reference/lzf/configure.xml b/reference/lzf/configure.xml index 9b1298b62..b6d068753 100644 --- a/reference/lzf/configure.xml +++ b/reference/lzf/configure.xml @@ -1,6 +1,6 @@ -
    +
    &reftitle.install; &pecl.moved; diff --git a/reference/lzf/functions/lzf-compress.xml b/reference/lzf/functions/lzf-compress.xml index d091ce416..1170534f2 100644 --- a/reference/lzf/functions/lzf-compress.xml +++ b/reference/lzf/functions/lzf-compress.xml @@ -1,7 +1,7 @@ - + lzf_compress diff --git a/reference/lzf/functions/lzf-decompress.xml b/reference/lzf/functions/lzf-decompress.xml index af37ed29b..0162febe9 100644 --- a/reference/lzf/functions/lzf-decompress.xml +++ b/reference/lzf/functions/lzf-decompress.xml @@ -1,7 +1,7 @@ - + lzf_decompress diff --git a/reference/lzf/functions/lzf-optimized-for.xml b/reference/lzf/functions/lzf-optimized-for.xml index c7e694995..02636ca9e 100644 --- a/reference/lzf/functions/lzf-optimized-for.xml +++ b/reference/lzf/functions/lzf-optimized-for.xml @@ -1,7 +1,7 @@ - + lzf_optimized_for diff --git a/reference/mailparse/book.xml b/reference/mailparse/book.xml index 8d123b9d6..948a91f80 100644 --- a/reference/mailparse/book.xml +++ b/reference/mailparse/book.xml @@ -1,6 +1,6 @@ - + Mailparse diff --git a/reference/mailparse/configure.xml b/reference/mailparse/configure.xml index d9714de1e..ccd7248c3 100644 --- a/reference/mailparse/configure.xml +++ b/reference/mailparse/configure.xml @@ -1,6 +1,6 @@ -
    +
    &reftitle.install; &pecl.moved; diff --git a/reference/mailparse/functions/mailparse-determine-best-xfer-encoding.xml b/reference/mailparse/functions/mailparse-determine-best-xfer-encoding.xml index 62a175dfb..455888c4c 100644 --- a/reference/mailparse/functions/mailparse-determine-best-xfer-encoding.xml +++ b/reference/mailparse/functions/mailparse-determine-best-xfer-encoding.xml @@ -1,6 +1,6 @@ - + mailparse_determine_best_xfer_encoding Gets the best way of encoding diff --git a/reference/mailparse/functions/mailparse-msg-create.xml b/reference/mailparse/functions/mailparse-msg-create.xml index f37f1997d..139e5f0cb 100644 --- a/reference/mailparse/functions/mailparse-msg-create.xml +++ b/reference/mailparse/functions/mailparse-msg-create.xml @@ -1,6 +1,6 @@ - + mailparse_msg_create Create a mime mail resource diff --git a/reference/mailparse/functions/mailparse-msg-extract-part-file.xml b/reference/mailparse/functions/mailparse-msg-extract-part-file.xml index f10de454f..d13dd5e90 100644 --- a/reference/mailparse/functions/mailparse-msg-extract-part-file.xml +++ b/reference/mailparse/functions/mailparse-msg-extract-part-file.xml @@ -1,6 +1,6 @@ - + mailparse_msg_extract_part_file Extracts/decodes a message section diff --git a/reference/mailparse/functions/mailparse-msg-extract-part.xml b/reference/mailparse/functions/mailparse-msg-extract-part.xml index 46b70f18b..f07324198 100644 --- a/reference/mailparse/functions/mailparse-msg-extract-part.xml +++ b/reference/mailparse/functions/mailparse-msg-extract-part.xml @@ -1,6 +1,6 @@ - + mailparse_msg_extract_part diff --git a/reference/mailparse/functions/mailparse-msg-extract-whole-part-file.xml b/reference/mailparse/functions/mailparse-msg-extract-whole-part-file.xml index ff37575c2..8b9686b39 100644 --- a/reference/mailparse/functions/mailparse-msg-extract-whole-part-file.xml +++ b/reference/mailparse/functions/mailparse-msg-extract-whole-part-file.xml @@ -1,6 +1,6 @@ - + mailparse_msg_extract_whole_part_file Extracts a message section including headers without decoding the transfer encoding diff --git a/reference/mailparse/functions/mailparse-msg-free.xml b/reference/mailparse/functions/mailparse-msg-free.xml index ded38f497..59ee79ba8 100644 --- a/reference/mailparse/functions/mailparse-msg-free.xml +++ b/reference/mailparse/functions/mailparse-msg-free.xml @@ -1,6 +1,6 @@ - + mailparse_msg_free Frees a MIME resource diff --git a/reference/mailparse/functions/mailparse-msg-get-part-data.xml b/reference/mailparse/functions/mailparse-msg-get-part-data.xml index cb50d978e..1ddf5824f 100644 --- a/reference/mailparse/functions/mailparse-msg-get-part-data.xml +++ b/reference/mailparse/functions/mailparse-msg-get-part-data.xml @@ -1,6 +1,6 @@ - + mailparse_msg_get_part_data Returns an associative array of info about the message diff --git a/reference/mailparse/functions/mailparse-msg-get-part.xml b/reference/mailparse/functions/mailparse-msg-get-part.xml index c8d2fc15c..bbaec935a 100644 --- a/reference/mailparse/functions/mailparse-msg-get-part.xml +++ b/reference/mailparse/functions/mailparse-msg-get-part.xml @@ -1,6 +1,6 @@ - + mailparse_msg_get_part Returns a handle on a given section in a mimemessage diff --git a/reference/mailparse/functions/mailparse-msg-get-structure.xml b/reference/mailparse/functions/mailparse-msg-get-structure.xml index 155e34351..e0e4f9b3e 100644 --- a/reference/mailparse/functions/mailparse-msg-get-structure.xml +++ b/reference/mailparse/functions/mailparse-msg-get-structure.xml @@ -1,6 +1,6 @@ - + mailparse_msg_get_structure Returns an array of mime section names in the supplied message diff --git a/reference/mailparse/functions/mailparse-msg-parse-file.xml b/reference/mailparse/functions/mailparse-msg-parse-file.xml index 6bcf82ba8..8aa54fd65 100644 --- a/reference/mailparse/functions/mailparse-msg-parse-file.xml +++ b/reference/mailparse/functions/mailparse-msg-parse-file.xml @@ -1,6 +1,6 @@ - + mailparse_msg_parse_file Parses a file diff --git a/reference/mailparse/functions/mailparse-msg-parse.xml b/reference/mailparse/functions/mailparse-msg-parse.xml index 1b07ae0b8..ade7d20d0 100644 --- a/reference/mailparse/functions/mailparse-msg-parse.xml +++ b/reference/mailparse/functions/mailparse-msg-parse.xml @@ -1,6 +1,6 @@ - + mailparse_msg_parse Incrementally parse data into buffer diff --git a/reference/mailparse/functions/mailparse-rfc822-parse-addresses.xml b/reference/mailparse/functions/mailparse-rfc822-parse-addresses.xml index b30da0866..d4ab4649a 100644 --- a/reference/mailparse/functions/mailparse-rfc822-parse-addresses.xml +++ b/reference/mailparse/functions/mailparse-rfc822-parse-addresses.xml @@ -1,6 +1,6 @@ - + mailparse_rfc822_parse_addresses Parse RFC 822 compliant addresses diff --git a/reference/mailparse/functions/mailparse-stream-encode.xml b/reference/mailparse/functions/mailparse-stream-encode.xml index e3a33851d..ff09e0522 100644 --- a/reference/mailparse/functions/mailparse-stream-encode.xml +++ b/reference/mailparse/functions/mailparse-stream-encode.xml @@ -1,6 +1,6 @@ - + mailparse_stream_encode diff --git a/reference/mailparse/functions/mailparse-uudecode-all.xml b/reference/mailparse/functions/mailparse-uudecode-all.xml index 12ae26833..694323773 100644 --- a/reference/mailparse/functions/mailparse-uudecode-all.xml +++ b/reference/mailparse/functions/mailparse-uudecode-all.xml @@ -1,6 +1,6 @@ - + mailparse_uudecode_all diff --git a/reference/mailparse/setup.xml b/reference/mailparse/setup.xml index 5abf24b0b..dde2e9600 100644 --- a/reference/mailparse/setup.xml +++ b/reference/mailparse/setup.xml @@ -1,6 +1,6 @@ - + &reftitle.setup; diff --git a/reference/mcrypt/book.xml b/reference/mcrypt/book.xml index d77d16649..8989f1fd0 100644 --- a/reference/mcrypt/book.xml +++ b/reference/mcrypt/book.xml @@ -1,6 +1,6 @@ - + Mcrypt diff --git a/reference/mcrypt/ciphers.xml b/reference/mcrypt/ciphers.xml index a06cd6549..6908114cf 100644 --- a/reference/mcrypt/ciphers.xml +++ b/reference/mcrypt/ciphers.xml @@ -1,6 +1,6 @@ - + Mcrypt ciphers Here is a list of ciphers which are currently supported by the mcrypt diff --git a/reference/mcrypt/configure.xml b/reference/mcrypt/configure.xml index 500529191..14429f953 100644 --- a/reference/mcrypt/configure.xml +++ b/reference/mcrypt/configure.xml @@ -1,6 +1,6 @@ -
    +
    &reftitle.install; &pecl.moved-ver;7.2.0 diff --git a/reference/mcrypt/constants.xml b/reference/mcrypt/constants.xml index 60ace1d46..d73b197f5 100644 --- a/reference/mcrypt/constants.xml +++ b/reference/mcrypt/constants.xml @@ -51,16 +51,16 @@ in n-bit mode) is comparable to OFB mode, but operates on the full block size of the algorithm. - + MCRYPT_MODE_STREAM is an extra mode to include some stream algorithms like "WAKE" or "RC4". - + - + Mcrypt supports some other modes of operation for which there are no predefined constants. They can be utilised by passing a string in place of the missing constants. @@ -73,7 +73,7 @@ "ncfb" (cipher feedback, - in n-bit mode) is comparable to CFB mode, + in n-bit mode) is comparable to CFB mode, but operates on the full block size of the algorithm. @@ -85,56 +85,56 @@ - MCRYPT_ENCRYPT + MCRYPT_ENCRYPT (int) - + - MCRYPT_DECRYPT + MCRYPT_DECRYPT (int) - + - MCRYPT_DEV_RANDOM + MCRYPT_DEV_RANDOM (int) - + - MCRYPT_DEV_URANDOM + MCRYPT_DEV_URANDOM (int) - + - MCRYPT_RAND + MCRYPT_RAND (int) - + diff --git a/reference/mcrypt/functions/mcrypt-create-iv.xml b/reference/mcrypt/functions/mcrypt-create-iv.xml index 7af8c29d4..00ebddd76 100644 --- a/reference/mcrypt/functions/mcrypt-create-iv.xml +++ b/reference/mcrypt/functions/mcrypt-create-iv.xml @@ -1,6 +1,6 @@ - + mcrypt_create_iv Creates an initialization vector (IV) from a random source diff --git a/reference/mcrypt/functions/mcrypt-decrypt.xml b/reference/mcrypt/functions/mcrypt-decrypt.xml index 2badcdb1c..cbd8df5f1 100644 --- a/reference/mcrypt/functions/mcrypt-decrypt.xml +++ b/reference/mcrypt/functions/mcrypt-decrypt.xml @@ -1,6 +1,6 @@ - + mcrypt_decrypt Decrypts crypttext with given parameters diff --git a/reference/mcrypt/functions/mcrypt-enc-get-algorithms-name.xml b/reference/mcrypt/functions/mcrypt-enc-get-algorithms-name.xml index 9d0c348a9..23e66d5d0 100644 --- a/reference/mcrypt/functions/mcrypt-enc-get-algorithms-name.xml +++ b/reference/mcrypt/functions/mcrypt-enc-get-algorithms-name.xml @@ -1,6 +1,6 @@ - + mcrypt_enc_get_algorithms_name Returns the name of the opened algorithm diff --git a/reference/mcrypt/functions/mcrypt-enc-get-block-size.xml b/reference/mcrypt/functions/mcrypt-enc-get-block-size.xml index e4b559e77..19d17e12c 100644 --- a/reference/mcrypt/functions/mcrypt-enc-get-block-size.xml +++ b/reference/mcrypt/functions/mcrypt-enc-get-block-size.xml @@ -1,6 +1,6 @@ - + mcrypt_enc_get_block_size Returns the blocksize of the opened algorithm diff --git a/reference/mcrypt/functions/mcrypt-enc-get-iv-size.xml b/reference/mcrypt/functions/mcrypt-enc-get-iv-size.xml index 7f3b74caf..3d5f07bea 100644 --- a/reference/mcrypt/functions/mcrypt-enc-get-iv-size.xml +++ b/reference/mcrypt/functions/mcrypt-enc-get-iv-size.xml @@ -1,6 +1,6 @@ - + mcrypt_enc_get_iv_size Returns the size of the IV of the opened algorithm diff --git a/reference/mcrypt/functions/mcrypt-enc-get-key-size.xml b/reference/mcrypt/functions/mcrypt-enc-get-key-size.xml index 5dc131634..520ae1709 100644 --- a/reference/mcrypt/functions/mcrypt-enc-get-key-size.xml +++ b/reference/mcrypt/functions/mcrypt-enc-get-key-size.xml @@ -1,6 +1,6 @@ - + mcrypt_enc_get_key_size Returns the maximum supported keysize of the opened mode diff --git a/reference/mcrypt/functions/mcrypt-enc-get-modes-name.xml b/reference/mcrypt/functions/mcrypt-enc-get-modes-name.xml index 016557583..dc6542354 100644 --- a/reference/mcrypt/functions/mcrypt-enc-get-modes-name.xml +++ b/reference/mcrypt/functions/mcrypt-enc-get-modes-name.xml @@ -1,6 +1,6 @@ - + mcrypt_enc_get_modes_name Returns the name of the opened mode diff --git a/reference/mcrypt/functions/mcrypt-enc-get-supported-key-sizes.xml b/reference/mcrypt/functions/mcrypt-enc-get-supported-key-sizes.xml index b1db0d632..c07183715 100644 --- a/reference/mcrypt/functions/mcrypt-enc-get-supported-key-sizes.xml +++ b/reference/mcrypt/functions/mcrypt-enc-get-supported-key-sizes.xml @@ -1,6 +1,6 @@ - + mcrypt_enc_get_supported_key_sizes Returns an array with the supported keysizes of the opened algorithm diff --git a/reference/mcrypt/functions/mcrypt-enc-is-block-algorithm-mode.xml b/reference/mcrypt/functions/mcrypt-enc-is-block-algorithm-mode.xml index 4fde77e22..3a974844d 100644 --- a/reference/mcrypt/functions/mcrypt-enc-is-block-algorithm-mode.xml +++ b/reference/mcrypt/functions/mcrypt-enc-is-block-algorithm-mode.xml @@ -1,6 +1,6 @@ - + mcrypt_enc_is_block_algorithm_mode Checks whether the encryption of the opened mode works on blocks diff --git a/reference/mcrypt/functions/mcrypt-enc-is-block-algorithm.xml b/reference/mcrypt/functions/mcrypt-enc-is-block-algorithm.xml index 635df7391..ed6580ad2 100644 --- a/reference/mcrypt/functions/mcrypt-enc-is-block-algorithm.xml +++ b/reference/mcrypt/functions/mcrypt-enc-is-block-algorithm.xml @@ -1,6 +1,6 @@ - + mcrypt_enc_is_block_algorithm Checks whether the algorithm of the opened mode is a block algorithm diff --git a/reference/mcrypt/functions/mcrypt-enc-is-block-mode.xml b/reference/mcrypt/functions/mcrypt-enc-is-block-mode.xml index 94186970b..ae35ce9f5 100644 --- a/reference/mcrypt/functions/mcrypt-enc-is-block-mode.xml +++ b/reference/mcrypt/functions/mcrypt-enc-is-block-mode.xml @@ -1,6 +1,6 @@ - + mcrypt_enc_is_block_mode Checks whether the opened mode outputs blocks diff --git a/reference/mcrypt/functions/mcrypt-enc-self-test.xml b/reference/mcrypt/functions/mcrypt-enc-self-test.xml index 263526c9d..4d9d35426 100644 --- a/reference/mcrypt/functions/mcrypt-enc-self-test.xml +++ b/reference/mcrypt/functions/mcrypt-enc-self-test.xml @@ -1,6 +1,6 @@ - + mcrypt_enc_self_test Runs a self test on the opened module diff --git a/reference/mcrypt/functions/mcrypt-encrypt.xml b/reference/mcrypt/functions/mcrypt-encrypt.xml index cec4be3fe..b15f4f806 100644 --- a/reference/mcrypt/functions/mcrypt-encrypt.xml +++ b/reference/mcrypt/functions/mcrypt-encrypt.xml @@ -1,6 +1,6 @@ - + mcrypt_encrypt Encrypts plaintext with given parameters diff --git a/reference/mcrypt/functions/mcrypt-generic-deinit.xml b/reference/mcrypt/functions/mcrypt-generic-deinit.xml index 8bfa1b85c..8b85b7552 100644 --- a/reference/mcrypt/functions/mcrypt-generic-deinit.xml +++ b/reference/mcrypt/functions/mcrypt-generic-deinit.xml @@ -1,6 +1,6 @@ - + mcrypt_generic_deinit This function deinitializes an encryption module diff --git a/reference/mcrypt/functions/mcrypt-generic-init.xml b/reference/mcrypt/functions/mcrypt-generic-init.xml index 4d117af8d..d5b925ed4 100644 --- a/reference/mcrypt/functions/mcrypt-generic-init.xml +++ b/reference/mcrypt/functions/mcrypt-generic-init.xml @@ -1,6 +1,6 @@ - + mcrypt_generic_init This function initializes all buffers needed for encryption diff --git a/reference/mcrypt/functions/mcrypt-generic.xml b/reference/mcrypt/functions/mcrypt-generic.xml index 550ae900f..84a19b85d 100644 --- a/reference/mcrypt/functions/mcrypt-generic.xml +++ b/reference/mcrypt/functions/mcrypt-generic.xml @@ -1,6 +1,6 @@ - + mcrypt_generic This function encrypts data diff --git a/reference/mcrypt/functions/mcrypt-get-block-size.xml b/reference/mcrypt/functions/mcrypt-get-block-size.xml index aaa2ff9df..ed906c37e 100644 --- a/reference/mcrypt/functions/mcrypt-get-block-size.xml +++ b/reference/mcrypt/functions/mcrypt-get-block-size.xml @@ -1,6 +1,6 @@ - + mcrypt_get_block_size Gets the block size of the specified cipher diff --git a/reference/mcrypt/functions/mcrypt-get-cipher-name.xml b/reference/mcrypt/functions/mcrypt-get-cipher-name.xml index 40e89ba5c..6b64b8ca2 100644 --- a/reference/mcrypt/functions/mcrypt-get-cipher-name.xml +++ b/reference/mcrypt/functions/mcrypt-get-cipher-name.xml @@ -1,6 +1,6 @@ - + mcrypt_get_cipher_name Gets the name of the specified cipher diff --git a/reference/mcrypt/functions/mcrypt-get-iv-size.xml b/reference/mcrypt/functions/mcrypt-get-iv-size.xml index e728ad62a..3c3a501a5 100644 --- a/reference/mcrypt/functions/mcrypt-get-iv-size.xml +++ b/reference/mcrypt/functions/mcrypt-get-iv-size.xml @@ -1,6 +1,6 @@ - + mcrypt_get_iv_size Returns the size of the IV belonging to a specific cipher/mode combination diff --git a/reference/mcrypt/functions/mcrypt-get-key-size.xml b/reference/mcrypt/functions/mcrypt-get-key-size.xml index d5c27164a..34170cd5b 100644 --- a/reference/mcrypt/functions/mcrypt-get-key-size.xml +++ b/reference/mcrypt/functions/mcrypt-get-key-size.xml @@ -1,6 +1,6 @@ - + mcrypt_get_key_size Gets the key size of the specified cipher diff --git a/reference/mcrypt/functions/mcrypt-list-algorithms.xml b/reference/mcrypt/functions/mcrypt-list-algorithms.xml index 4b1e797ed..aa8a5b761 100644 --- a/reference/mcrypt/functions/mcrypt-list-algorithms.xml +++ b/reference/mcrypt/functions/mcrypt-list-algorithms.xml @@ -1,6 +1,6 @@ - + mcrypt_list_algorithms Gets an array of all supported ciphers diff --git a/reference/mcrypt/functions/mcrypt-list-modes.xml b/reference/mcrypt/functions/mcrypt-list-modes.xml index 7267e9eb4..f345038c1 100644 --- a/reference/mcrypt/functions/mcrypt-list-modes.xml +++ b/reference/mcrypt/functions/mcrypt-list-modes.xml @@ -1,6 +1,6 @@ - + mcrypt_list_modes Gets an array of all supported modes diff --git a/reference/mcrypt/functions/mcrypt-module-close.xml b/reference/mcrypt/functions/mcrypt-module-close.xml index b6cc358fb..d34f68fc6 100644 --- a/reference/mcrypt/functions/mcrypt-module-close.xml +++ b/reference/mcrypt/functions/mcrypt-module-close.xml @@ -1,6 +1,6 @@ - + mcrypt_module_close Closes the mcrypt module diff --git a/reference/mcrypt/functions/mcrypt-module-get-algo-block-size.xml b/reference/mcrypt/functions/mcrypt-module-get-algo-block-size.xml index 434c81392..ca745ed5f 100644 --- a/reference/mcrypt/functions/mcrypt-module-get-algo-block-size.xml +++ b/reference/mcrypt/functions/mcrypt-module-get-algo-block-size.xml @@ -1,6 +1,6 @@ - + mcrypt_module_get_algo_block_size Returns the blocksize of the specified algorithm diff --git a/reference/mcrypt/functions/mcrypt-module-get-algo-key-size.xml b/reference/mcrypt/functions/mcrypt-module-get-algo-key-size.xml index 0a953cb0b..e59903d9e 100644 --- a/reference/mcrypt/functions/mcrypt-module-get-algo-key-size.xml +++ b/reference/mcrypt/functions/mcrypt-module-get-algo-key-size.xml @@ -1,6 +1,6 @@ - + mcrypt_module_get_algo_key_size Returns the maximum supported keysize of the opened mode diff --git a/reference/mcrypt/functions/mcrypt-module-get-supported-key-sizes.xml b/reference/mcrypt/functions/mcrypt-module-get-supported-key-sizes.xml index 17f614a68..5a8fe402d 100644 --- a/reference/mcrypt/functions/mcrypt-module-get-supported-key-sizes.xml +++ b/reference/mcrypt/functions/mcrypt-module-get-supported-key-sizes.xml @@ -1,6 +1,6 @@ - + mcrypt_module_get_supported_key_sizes Returns an array with the supported keysizes of the opened algorithm diff --git a/reference/mcrypt/functions/mcrypt-module-is-block-algorithm-mode.xml b/reference/mcrypt/functions/mcrypt-module-is-block-algorithm-mode.xml index 9c4d16fd8..c57eadaf9 100644 --- a/reference/mcrypt/functions/mcrypt-module-is-block-algorithm-mode.xml +++ b/reference/mcrypt/functions/mcrypt-module-is-block-algorithm-mode.xml @@ -1,6 +1,6 @@ - + mcrypt_module_is_block_algorithm_mode Returns if the specified module is a block algorithm or not diff --git a/reference/mcrypt/functions/mcrypt-module-is-block-algorithm.xml b/reference/mcrypt/functions/mcrypt-module-is-block-algorithm.xml index e19866c7e..a3c2f89af 100644 --- a/reference/mcrypt/functions/mcrypt-module-is-block-algorithm.xml +++ b/reference/mcrypt/functions/mcrypt-module-is-block-algorithm.xml @@ -1,6 +1,6 @@ - + mcrypt_module_is_block_algorithm This function checks whether the specified algorithm is a block algorithm diff --git a/reference/mcrypt/functions/mcrypt-module-is-block-mode.xml b/reference/mcrypt/functions/mcrypt-module-is-block-mode.xml index 7c24a7fab..1cd458201 100644 --- a/reference/mcrypt/functions/mcrypt-module-is-block-mode.xml +++ b/reference/mcrypt/functions/mcrypt-module-is-block-mode.xml @@ -1,6 +1,6 @@ - + mcrypt_module_is_block_mode Returns if the specified mode outputs blocks or not diff --git a/reference/mcrypt/functions/mcrypt-module-open.xml b/reference/mcrypt/functions/mcrypt-module-open.xml index df6223025..463fbc74a 100644 --- a/reference/mcrypt/functions/mcrypt-module-open.xml +++ b/reference/mcrypt/functions/mcrypt-module-open.xml @@ -1,6 +1,6 @@ - + mcrypt_module_open Opens the module of the algorithm and the mode to be used diff --git a/reference/mcrypt/functions/mcrypt-module-self-test.xml b/reference/mcrypt/functions/mcrypt-module-self-test.xml index 6f3d575c7..d9eaf2f95 100644 --- a/reference/mcrypt/functions/mcrypt-module-self-test.xml +++ b/reference/mcrypt/functions/mcrypt-module-self-test.xml @@ -1,6 +1,6 @@ - + mcrypt_module_self_test This function runs a self test on the specified module diff --git a/reference/mcrypt/functions/mdecrypt-generic.xml b/reference/mcrypt/functions/mdecrypt-generic.xml index c4fc9f3e6..c140802e6 100644 --- a/reference/mcrypt/functions/mdecrypt-generic.xml +++ b/reference/mcrypt/functions/mdecrypt-generic.xml @@ -1,6 +1,6 @@ - + mdecrypt_generic Decrypts data diff --git a/reference/mcrypt/ini.xml b/reference/mcrypt/ini.xml index 6bdc65bec..42ed8a988 100644 --- a/reference/mcrypt/ini.xml +++ b/reference/mcrypt/ini.xml @@ -1,6 +1,6 @@ -
    +
    &reftitle.runtime; &extension.runtime; diff --git a/reference/mcrypt/reference.xml b/reference/mcrypt/reference.xml index 86f956850..3830edd99 100644 --- a/reference/mcrypt/reference.xml +++ b/reference/mcrypt/reference.xml @@ -6,7 +6,7 @@ &reference.mcrypt.entities.functions; - + - + &reftitle.setup; diff --git a/reference/memcache/book.xml b/reference/memcache/book.xml index 16a82cf72..5607f2852 100644 --- a/reference/memcache/book.xml +++ b/reference/memcache/book.xml @@ -1,6 +1,6 @@ - + Memcache diff --git a/reference/memcache/configure.xml b/reference/memcache/configure.xml index 01e07b98b..808932065 100644 --- a/reference/memcache/configure.xml +++ b/reference/memcache/configure.xml @@ -1,6 +1,6 @@ -
    +
    &reftitle.install; &pecl.moved; diff --git a/reference/memcache/examples.xml b/reference/memcache/examples.xml index cc49a39c6..e944ab051 100644 --- a/reference/memcache/examples.xml +++ b/reference/memcache/examples.xml @@ -1,6 +1,6 @@ - + &reftitle.examples;
    Basic usage diff --git a/reference/memcache/functions/memcache-debug.xml b/reference/memcache/functions/memcache-debug.xml index ee4c10dbf..6a8046559 100644 --- a/reference/memcache/functions/memcache-debug.xml +++ b/reference/memcache/functions/memcache-debug.xml @@ -1,6 +1,6 @@ - + memcache_debug Turn debug output on/off diff --git a/reference/memcache/ini.xml b/reference/memcache/ini.xml index 3a6bf69c9..2ede59627 100644 --- a/reference/memcache/ini.xml +++ b/reference/memcache/ini.xml @@ -1,6 +1,6 @@ -
    +
    &reftitle.runtime; &extension.runtime; diff --git a/reference/memcache/memcache.xml b/reference/memcache/memcache.xml index 33ae22e73..83d038719 100644 --- a/reference/memcache/memcache.xml +++ b/reference/memcache/memcache.xml @@ -1,6 +1,6 @@ - + The Memcache class Memcache diff --git a/reference/memcache/memcache/add.xml b/reference/memcache/memcache/add.xml index f5a3dec95..6612f8749 100644 --- a/reference/memcache/memcache/add.xml +++ b/reference/memcache/memcache/add.xml @@ -1,6 +1,6 @@ - + Memcache::add memcache_add diff --git a/reference/memcache/memcache/addserver.xml b/reference/memcache/memcache/addserver.xml index 61ba70bab..04edaebc0 100644 --- a/reference/memcache/memcache/addserver.xml +++ b/reference/memcache/memcache/addserver.xml @@ -1,6 +1,6 @@ - + Memcache::addServer memcache_add_server diff --git a/reference/memcache/memcache/close.xml b/reference/memcache/memcache/close.xml index 2f54184ff..89c664309 100644 --- a/reference/memcache/memcache/close.xml +++ b/reference/memcache/memcache/close.xml @@ -1,6 +1,6 @@ - + Memcache::close memcache_close diff --git a/reference/memcache/memcache/connect.xml b/reference/memcache/memcache/connect.xml index ef293eeee..ea16c9838 100644 --- a/reference/memcache/memcache/connect.xml +++ b/reference/memcache/memcache/connect.xml @@ -1,6 +1,6 @@ - + Memcache::connect memcache_connect diff --git a/reference/memcache/memcache/decrement.xml b/reference/memcache/memcache/decrement.xml index 580024582..20e190fbf 100644 --- a/reference/memcache/memcache/decrement.xml +++ b/reference/memcache/memcache/decrement.xml @@ -1,6 +1,6 @@ - + Memcache::decrement memcache_decrement diff --git a/reference/memcache/memcache/delete.xml b/reference/memcache/memcache/delete.xml index 86735bc33..2b52c0981 100644 --- a/reference/memcache/memcache/delete.xml +++ b/reference/memcache/memcache/delete.xml @@ -1,6 +1,6 @@ - + Memcache::delete memcache_delete diff --git a/reference/memcache/memcache/flush.xml b/reference/memcache/memcache/flush.xml index e971b01b9..28a686f36 100644 --- a/reference/memcache/memcache/flush.xml +++ b/reference/memcache/memcache/flush.xml @@ -1,6 +1,6 @@ - + Memcache::flush memcache_flush diff --git a/reference/memcache/memcache/get.xml b/reference/memcache/memcache/get.xml index 3a99ff1ce..200c384ba 100644 --- a/reference/memcache/memcache/get.xml +++ b/reference/memcache/memcache/get.xml @@ -1,6 +1,6 @@ - + Memcache::get memcache_get diff --git a/reference/memcache/memcache/getextendedstats.xml b/reference/memcache/memcache/getextendedstats.xml index b32b1b0f0..ff56efe88 100644 --- a/reference/memcache/memcache/getextendedstats.xml +++ b/reference/memcache/memcache/getextendedstats.xml @@ -1,6 +1,6 @@ - + Memcache::getExtendedStats memcache_get_extended_stats diff --git a/reference/memcache/memcache/getserverstatus.xml b/reference/memcache/memcache/getserverstatus.xml index 84c35385a..4d1459b3f 100644 --- a/reference/memcache/memcache/getserverstatus.xml +++ b/reference/memcache/memcache/getserverstatus.xml @@ -1,6 +1,6 @@ - + Memcache::getServerStatus memcache_get_server_status diff --git a/reference/memcache/memcache/getstats.xml b/reference/memcache/memcache/getstats.xml index e05e1381e..5a7b15667 100644 --- a/reference/memcache/memcache/getstats.xml +++ b/reference/memcache/memcache/getstats.xml @@ -1,6 +1,6 @@ - + Memcache::getStats memcache_get_stats diff --git a/reference/memcache/memcache/getversion.xml b/reference/memcache/memcache/getversion.xml index 4ee8a4b58..572e5e573 100644 --- a/reference/memcache/memcache/getversion.xml +++ b/reference/memcache/memcache/getversion.xml @@ -1,6 +1,6 @@ - + Memcache::getVersion memcache_get_version diff --git a/reference/memcache/memcache/increment.xml b/reference/memcache/memcache/increment.xml index 341c99fcc..02d8b335b 100644 --- a/reference/memcache/memcache/increment.xml +++ b/reference/memcache/memcache/increment.xml @@ -1,6 +1,6 @@ - + Memcache::increment memcache_increment diff --git a/reference/memcache/memcache/pconnect.xml b/reference/memcache/memcache/pconnect.xml index ed09e4fce..c572413b2 100644 --- a/reference/memcache/memcache/pconnect.xml +++ b/reference/memcache/memcache/pconnect.xml @@ -1,6 +1,6 @@ - + Memcache::pconnect memcache_pconnect diff --git a/reference/memcache/memcache/replace.xml b/reference/memcache/memcache/replace.xml index 4891a4196..2672fb0d9 100644 --- a/reference/memcache/memcache/replace.xml +++ b/reference/memcache/memcache/replace.xml @@ -1,6 +1,6 @@ - + Memcache::replace memcache_replace diff --git a/reference/memcache/memcache/set.xml b/reference/memcache/memcache/set.xml index 98145f3ff..3efe4d4ce 100644 --- a/reference/memcache/memcache/set.xml +++ b/reference/memcache/memcache/set.xml @@ -1,6 +1,6 @@ - + Memcache::set memcache_set diff --git a/reference/memcache/memcache/setcompressthreshold.xml b/reference/memcache/memcache/setcompressthreshold.xml index 22b77de80..d8199ca0c 100644 --- a/reference/memcache/memcache/setcompressthreshold.xml +++ b/reference/memcache/memcache/setcompressthreshold.xml @@ -1,6 +1,6 @@ - + Memcache::setCompressThreshold memcache_set_compress_threshold diff --git a/reference/memcache/memcache/setserverparams.xml b/reference/memcache/memcache/setserverparams.xml index a6547952c..5a4222aa5 100644 --- a/reference/memcache/memcache/setserverparams.xml +++ b/reference/memcache/memcache/setserverparams.xml @@ -1,6 +1,6 @@ - + Memcache::setServerParams memcache_set_server_params diff --git a/reference/memcache/setup.xml b/reference/memcache/setup.xml index 2a435844b..545f4d8f4 100644 --- a/reference/memcache/setup.xml +++ b/reference/memcache/setup.xml @@ -1,6 +1,6 @@ - + &reftitle.setup; diff --git a/reference/memcached/book.xml b/reference/memcached/book.xml index b86b128fe..fc99aeb00 100644 --- a/reference/memcached/book.xml +++ b/reference/memcached/book.xml @@ -8,21 +8,21 @@ &reftitle.intro; - + memcached is a high-performance, distributed memory object caching system, generic in nature, but intended for use in speeding up dynamic web applications by alleviating database load. - - + + This extension uses the libmemcached library to provide an API for communicating with memcached servers. It also provides a session handler (memcached). - - + + Information about libmemcached can be found at &url.libmemcached;. - + &reference.memcached.setup; diff --git a/reference/memcached/callbacks.xml b/reference/memcached/callbacks.xml index 223a06f4f..a50c94129 100644 --- a/reference/memcached/callbacks.xml +++ b/reference/memcached/callbacks.xml @@ -6,13 +6,13 @@
    Result callbacks - + Result callables are invoked by Memcached::getDelayed or Memcached::getDelayedBykey methods for each item in the result set. The callback is passed the Memcached object and the array with the item information. The callback does not have to return anything. - + Result callback example @@ -61,7 +61,7 @@ array(3) {
    Read-through cache callbacks - + Read-through cache callbacks are invoked when an item cannot be retrieved from the server. The callback is passed the Memcached object, the requested key, and the by-reference value variable. The callback is responsible for @@ -71,7 +71,7 @@ array(3) { Memcached::getByKey support these callbacks, because the memcache protocol does not provide information on which keys were not found in the multi-key request. - + Read-through callback example diff --git a/reference/memcached/configure.xml b/reference/memcached/configure.xml index 5ea873c36..69b759395 100644 --- a/reference/memcached/configure.xml +++ b/reference/memcached/configure.xml @@ -3,32 +3,32 @@
    &reftitle.install; - + &pecl.info; &url.pecl.package;memcached. - - + + If libmemcached is installed in a non-standard location, use switch, where DIR is the libmemcached install prefix. This directory has to contain the include/libmemcached/memcached.h file. - - + + Zlib is required for compression support. To specify non-standard installation of Zlib, use switch, where DIR is the Zlib install prefix. - - + + Session handler support is enabled by default. To disable it, use switch. - - + + SASL authentication support is disabled by default. To enable it, use switch. This requires that libsasl2 has been installed and that libmemcached has been built with SASL support enabled. - +
    diff --git a/reference/memcached/constants.xml b/reference/memcached/constants.xml index 29dfba336..949426b0d 100644 --- a/reference/memcached/constants.xml +++ b/reference/memcached/constants.xml @@ -17,7 +17,7 @@ memcached.compression_threshold ini setting. - Type: bool, default: &true;. + Type: bool, default: &true;. @@ -30,7 +30,7 @@ Memcached::COMPRESSION_ZLIB and Memcached::COMPRESSION_ZSTD. - Type: int, default: Memcached::COMPRESSION_FASTLZ. + Type: int, default: Memcached::COMPRESSION_FASTLZ. @@ -73,7 +73,7 @@ Memcached::COMPRESSION_ZSTD: minimum level is -22 and maximum level is 22. Memcached::COMPRESSION_ZLIB: minimum level is 0 and maximum level is 9. - Type: int, default: 3. + Type: int, default: 3. @@ -88,18 +88,18 @@ Memcached::SERIALIZER_JSON_ARRAY and Memcached::SERIALIZER_MSGPACK. - + Type: int, default: Memcached::SERIALIZER_IGBINARY if available, then Memcached::SERIALIZER_MSGPACK if available, then Memcached::SERIALIZER_PHP. - + Memcached::SERIALIZER_PHP - The default PHP serializer. + The default PHP serializer. @@ -122,7 +122,7 @@ Memcached::SERIALIZER_JSON - The JSON serializer. This serializer deserializes JSON to an object. + The JSON serializer. This serializer deserializes JSON to an object. @@ -160,7 +160,7 @@ maximum available key size. The prefix is applied only to the item keys, not to the server keys. - Type: string, default: "". + Type: string, default: "". @@ -173,70 +173,70 @@ Each hash algorithm has its advantages and its disadvantages. Go with the default if you don't know or don't care. - Type: int, default: Memcached::HASH_DEFAULT + Type: int, default: Memcached::HASH_DEFAULT Memcached::HASH_DEFAULT - The default (Jenkins one-at-a-time) item key hashing algorithm. + The default (Jenkins one-at-a-time) item key hashing algorithm. Memcached::HASH_MD5 - MD5 item key hashing algorithm. + MD5 item key hashing algorithm. Memcached::HASH_CRC - CRC item key hashing algorithm. + CRC item key hashing algorithm. Memcached::HASH_FNV1_64 - FNV1_64 item key hashing algorithm. + FNV1_64 item key hashing algorithm. Memcached::HASH_FNV1A_64 - FNV1_64A item key hashing algorithm. + FNV1_64A item key hashing algorithm. Memcached::HASH_FNV1_32 - FNV1_32 item key hashing algorithm. + FNV1_32 item key hashing algorithm. Memcached::HASH_FNV1A_32 - FNV1_32A item key hashing algorithm. + FNV1_32A item key hashing algorithm. Memcached::HASH_HSIEH - Hsieh item key hashing algorithm. + Hsieh item key hashing algorithm. Memcached::HASH_MURMUR - Murmur item key hashing algorithm. + Murmur item key hashing algorithm. @@ -249,21 +249,21 @@ hashing delivers better distribution and allows servers to be added to the cluster with minimal cache losses. - Type: int, default: Memcached::DISTRIBUTION_MODULA. + Type: int, default: Memcached::DISTRIBUTION_MODULA. Memcached::DISTRIBUTION_MODULA - Modulo-based key distribution algorithm. + Modulo-based key distribution algorithm. Memcached::DISTRIBUTION_CONSISTENT - Consistent hashing key distribution algorithm (based on libketama). + Consistent hashing key distribution algorithm (based on libketama). @@ -279,21 +279,21 @@ Memcached::OPT_LIBKETAMA_COMPATIBLE - + Enables or disables compatibility with libketama-like behavior. When enabled, the item key hashing algorithm is set to MD5 and distribution is set to be weighted consistent hashing distribution. This is useful because other libketama-based clients (Python, Ruby, etc.) with the same server configuration will be able to access the keys transparently. - + - + It is highly recommended to enable this option if you want to use consistent hashing, and it may be enabled by default in future releases. - + - Type: bool, default: &false;. + Type: bool, default: &false;. @@ -303,7 +303,7 @@ Specifies the hashing algorithm for host mapping. - Type: int. + Type: int. @@ -313,7 +313,7 @@ Enables TCP keep alive. - Type: bool, default: &false;. + Type: bool, default: &false;. @@ -327,7 +327,7 @@ Quitting the connection or closing down the connection will also cause the buffered data to be pushed to the remote connection. - Type: bool, default: &false;. + Type: bool, default: &false;. @@ -338,7 +338,7 @@ Enable the use of the binary protocol. Please note that you cannot toggle this option on an open connection. - Type: bool, default: &false;. + Type: bool, default: &false;. @@ -349,7 +349,7 @@ Enables or disables asynchronous I/O. This is the fastest transport available for storage functions. - Type: bool, default: &false;. + Type: bool, default: &false;. @@ -363,7 +363,7 @@ (there would be no reply). Retrieval commands such as Memcached::get are unaffected by this setting. - Type: bool, default: &false;. + Type: bool, default: &false;. @@ -374,7 +374,7 @@ Enables or disables the no-delay feature for connecting sockets (may be faster in some environments). - Type: bool, default: &false;. + Type: bool, default: &false;. @@ -382,10 +382,10 @@ Memcached::OPT_SOCKET_SEND_SIZE The maximum socket send buffer in bytes. - + Type: int, default: varies by platform/kernel configuration. - + @@ -393,10 +393,10 @@ Memcached::OPT_SOCKET_RECV_SIZE The maximum socket receive buffer in bytes. - + Type: int, default: varies by platform/kernel configuration. - + @@ -407,7 +407,7 @@ In non-blocking mode this set the value of the timeout during socket connection, in milliseconds. - Type: int, default: 1000. + Type: int, default: 1000. @@ -418,7 +418,7 @@ The amount of time, in seconds, to wait until retrying a failed connection attempt. - Type: int, default: 2. + Type: int, default: 2. @@ -429,7 +429,7 @@ The amount of time, in seconds, to wait until retrying dead servers. 0 means no retry. - Type: int, default: 0. + Type: int, default: 0. @@ -441,7 +441,7 @@ use non-blocking I/O this will allow you to still have timeouts on the sending of data. - Type: int, default: 0. + Type: int, default: 0. @@ -453,7 +453,7 @@ use non-blocking I/O this will allow you to still have timeouts on the reading of data. - Type: int, default: 0. + Type: int, default: 0. @@ -461,7 +461,7 @@ Memcached::OPT_POLL_TIMEOUT Timeout for connection polling, in milliseconds. - Type: int, default: 1000. + Type: int, default: 1000. @@ -469,7 +469,7 @@ Memcached::OPT_CACHE_LOOKUPS Enables or disables caching of DNS lookups. - Type: bool, default: &false;. + Type: bool, default: &false;. @@ -480,7 +480,7 @@ Specifies the failure limit for server connection attempts. The server will be removed after this many continuous connection failures. - Type: int, default: 5. + Type: int, default: 5. @@ -491,25 +491,25 @@ Specifies the timeout limit for server connection attempts. The server will be removed after this many continuous connection timeouts. - Type: int, default: 0. + Type: int, default: 0. Memcached::OPT_AUTO_EJECT_HOSTS - + Removes disabled servers from the list. Use together with Memcached::OPT_SERVER_FAILURE_LIMIT and Memcached::OPT_SERVER_TIMEOUT_LIMIT. - + - + This option is replaced by Memcached::OPT_REMOVE_FAILED_SERVERS. - + - Type: bool, default: &false;. + Type: bool, default: &false;. @@ -519,7 +519,7 @@ Enables verification of keys by memcached. - Type: bool, default: &false;. + Type: bool, default: &false;. @@ -529,7 +529,7 @@ Uses UDP instead of TCP. - Type: bool, default: &false;. + Type: bool, default: &false;. @@ -539,7 +539,7 @@ Stores this many replicas of each item on different servers. - Type: int, default: 0. + Type: int, default: 0. @@ -549,7 +549,7 @@ Randomizes replica read server. - Type: bool, default: &false;. + Type: bool, default: &false;. @@ -561,7 +561,7 @@ Memcached::OPT_SERVER_FAILURE_LIMIT and Memcached::OPT_SERVER_TIMEOUT_LIMIT. - Type: bool, default: &false;. + Type: bool, default: &false;. @@ -569,7 +569,7 @@ Memcached::HAVE_IGBINARY Indicates whether igbinary serializer support is available. - Type: bool. + Type: bool. @@ -577,7 +577,7 @@ Memcached::HAVE_JSON Indicates whether JSON serializer support is available. - Type: bool. + Type: bool. @@ -585,8 +585,8 @@ Memcached::HAVE_MSGPACK Indicates whether MessagePack serializer support is available. - Type: bool. - Available as of Memcached 3.0.0. + Type: bool. + Available as of Memcached 3.0.0. @@ -594,8 +594,8 @@ Memcached::HAVE_ZSTD Indicates whether ZSTD compression support is available. - Type: bool. - Available as of Memcached 3.3.0. + Type: bool. + Available as of Memcached 3.3.0. @@ -606,189 +606,189 @@ Indicates whether data encryption using Memcached::setEncodingKey is supported. - Type: bool. - Available as of Memcached 3.1.0. + Type: bool. + Available as of Memcached 3.1.0. Memcached::HAVE_SESSION - Type: bool. - Available as of Memcached 3.0.0. + Type: bool. + Available as of Memcached 3.0.0. Memcached::HAVE_SASL - Type: bool. - Available as of Memcached 3.0.0. + Type: bool. + Available as of Memcached 3.0.0. Memcached::GET_EXTENDED - + A flag for Memcached::get, Memcached::getMulti and Memcached::getMultiByKey to ensure that the CAS token values are returned as well. - - Available as of Memcached 3.0.0. + + Available as of Memcached 3.0.0. Memcached::GET_PRESERVE_ORDER - + A flag for Memcached::getMulti and Memcached::getMultiByKey to ensure that the keys are returned in the same order as they were requested in. Non-existing keys get a default value of &null;. - + Memcached::RES_SUCCESS - The operation was successful. + The operation was successful. Memcached::RES_FAILURE - The operation failed in some fashion. + The operation failed in some fashion. Memcached::RES_HOST_LOOKUP_FAILURE - DNS lookup failed. + DNS lookup failed. Memcached::RES_UNKNOWN_READ_FAILURE - Failed to read network data. + Failed to read network data. Memcached::RES_PROTOCOL_ERROR - Bad command in memcached protocol. + Bad command in memcached protocol. Memcached::RES_CLIENT_ERROR - Error on the client side. + Error on the client side. Memcached::RES_SERVER_ERROR - Error on the server side. + Error on the server side. Memcached::RES_WRITE_FAILURE - Failed to write network data. + Failed to write network data. Memcached::RES_DATA_EXISTS - Failed to do compare-and-swap: item you are trying to store has been - modified since you last fetched it. + Failed to do compare-and-swap: item you are trying to store has been + modified since you last fetched it. Memcached::RES_NOTSTORED - + Item was not stored: but not because of an error. This normally means that either the condition for an "add" or a "replace" command wasn't met, or that the item is in a delete queue. - + Memcached::RES_NOTFOUND - + Item with this key was not found (with "get" operation or "cas" operations). - + Memcached::RES_PARTIAL_READ - Partial network data read error. + Partial network data read error. Memcached::RES_SOME_ERRORS - Some errors occurred during multi-get. + Some errors occurred during multi-get. Memcached::RES_NO_SERVERS - Server list is empty. + Server list is empty. Memcached::RES_END - End of result set. + End of result set. Memcached::RES_ERRNO - System error. + System error. Memcached::RES_BUFFERED - The operation was buffered. + The operation was buffered. Memcached::RES_TIMEOUT - The operation timed out. + The operation timed out. Memcached::RES_BAD_KEY_PROVIDED - Bad key. + Bad key. @@ -865,63 +865,63 @@ Memcached::RES_CONNECTION_SOCKET_CREATE_FAILURE - Failed to create network socket. + Failed to create network socket. Memcached::RES_PAYLOAD_FAILURE - Payload failure: could not compress/decompress or serialize/unserialize the value. + Payload failure: could not compress/decompress or serialize/unserialize the value. Memcached::RES_AUTH_PROBLEM - Available as of Memcached 3.0.0. + Available as of Memcached 3.0.0. Memcached::RES_AUTH_FAILURE - Available as of Memcached 3.0.0. + Available as of Memcached 3.0.0. Memcached::RES_AUTH_CONTINUE - Available as of Memcached 3.0.0. + Available as of Memcached 3.0.0. Memcached::RES_E2BIG - Available as of Memcached 3.0.0. + Available as of Memcached 3.0.0. Memcached::RES_KEY_TOO_BIG - Available as of Memcached 3.0.0. + Available as of Memcached 3.0.0. Memcached::RES_SERVER_TEMPORARILY_DISABLED - Available as of Memcached 3.0.0. + Available as of Memcached 3.0.0. Memcached::RES_SERVER_MEMORY_ALLOCATION_FAILURE - Available as of Memcached 3.0.0. + Available as of Memcached 3.0.0. diff --git a/reference/memcached/expiration.xml b/reference/memcached/expiration.xml index a596cacd1..fdae11af3 100644 --- a/reference/memcached/expiration.xml +++ b/reference/memcached/expiration.xml @@ -3,7 +3,7 @@ Expiration Times - + Some storage commands involve sending an expiration value (relative to an item or to an operation requested by the client) to the server. In all such cases, the actual value sent may either be Unix time (number of seconds @@ -12,12 +12,12 @@ 60*60*24*30 (number of seconds in 30 days); if the expiration value is larger than that, the server will consider it to be real Unix time value rather than an offset from current time. - - + + If the expiration value is 0 (the default), the item never expires (although it may be deleted from the server to make place for - other items). - + other items). +
    &reftitle.intro; - + Represents a connection to a set of memcached servers. - +
    @@ -38,7 +38,7 @@
    - + &reference.memcached.entities.memcached; diff --git a/reference/memcached/memcached/add.xml b/reference/memcached/memcached/add.xml index e78dba248..b1bcf8f3f 100644 --- a/reference/memcached/memcached/add.xml +++ b/reference/memcached/memcached/add.xml @@ -14,11 +14,11 @@ mixedvalue intexpiration0 - + Memcached::add is similar to Memcached::set, but the operation fails if the key already exists on the server. - + @@ -28,25 +28,25 @@ key - + &memcached.parameter.key; - + value - + &memcached.parameter.value; - + expiration - + &memcached.parameter.expiration; - + @@ -55,11 +55,11 @@ &reftitle.returnvalues; - + &return.success; The Memcached::getResultCode will return Memcached::RES_NOTSTORED if the key already exists. - + diff --git a/reference/memcached/memcached/addbykey.xml b/reference/memcached/memcached/addbykey.xml index d4a98f1d1..3352bcd07 100644 --- a/reference/memcached/memcached/addbykey.xml +++ b/reference/memcached/memcached/addbykey.xml @@ -15,13 +15,13 @@ mixedvalue intexpiration0 - + Memcached::addByKey is functionally equivalent to Memcached::add, except that the free-form server_key can be used to map the key to a specific server. This is useful if you need to keep a bunch of related keys on a certain server. - + @@ -31,33 +31,33 @@ server_key - + &memcached.parameter.server_key; - + key - + &memcached.parameter.key; - + value - + &memcached.parameter.value; - + expiration - + &memcached.parameter.expiration; - + @@ -66,11 +66,11 @@ &reftitle.returnvalues; - + &return.success; The Memcached::getResultCode will return Memcached::RES_NOTSTORED if the key already exists. - + diff --git a/reference/memcached/memcached/addserver.xml b/reference/memcached/memcached/addserver.xml index c6c5df84a..af39d8521 100644 --- a/reference/memcached/memcached/addserver.xml +++ b/reference/memcached/memcached/addserver.xml @@ -14,7 +14,7 @@ intport intweight0 - + Memcached::addServer adds the specified server to the server pool. No connection is established to the server at this time, but if you are using consistent key distribution option (via @@ -24,13 +24,13 @@ multiple servers, it is better to use Memcached::addServers as the update then happens only once. - - + + The same server may appear multiple times in the server pool, because no duplication checks are made. This is not advisable; instead, use the weight option to increase the selection weighting of this server. - + @@ -40,37 +40,37 @@ host - + The hostname of the memcache server. If the hostname is invalid, - data-related operations will set + data-related operations will set Memcached::RES_HOST_LOOKUP_FAILURE result code. As of version 2.0.0b1, this parameter may also specify the path of a unix socket filepath ex. /path/to/memcached.sock to use UNIX domain sockets, in this case port must also be set to 0. - + port - + The port on which memcache is running. Usually, this is - 11211. As of version 2.0.0b1, set this parameter to 0 when + 11211. As of version 2.0.0b1, set this parameter to 0 when using UNIX domain sockets. - + weight - + The weight of the server relative to the total weight of all the servers in the pool. This controls the probability of the server being selected for operations. This is used only with consistent distribution option and usually corresponds to the amount of memory available to memcache on that server. - + @@ -79,9 +79,9 @@ &reftitle.returnvalues; - + &return.success; - + diff --git a/reference/memcached/memcached/addservers.xml b/reference/memcached/memcached/addservers.xml index 4bb99510a..e0e35d453 100644 --- a/reference/memcached/memcached/addservers.xml +++ b/reference/memcached/memcached/addservers.xml @@ -12,19 +12,19 @@ public boolMemcached::addServers arrayservers - + Memcached::addServers adds servers to the server pool. Each entry in servers is supposed to be an array containing hostname, port, and, optionally, weight of the server. No connection is established to the servers at this time. - - + + The same server may appear multiple times in the server pool, because no duplication checks are made. This is not advisable; instead, use the weight option to increase the selection weighting of this server. - + @@ -34,9 +34,9 @@ array - + Array of the servers to add to the pool. - + @@ -45,9 +45,9 @@ &reftitle.returnvalues; - + &return.success; - + diff --git a/reference/memcached/memcached/append.xml b/reference/memcached/memcached/append.xml index 9a402ed7f..d636ff5ef 100644 --- a/reference/memcached/memcached/append.xml +++ b/reference/memcached/memcached/append.xml @@ -13,19 +13,19 @@ stringkey stringvalue - + Memcached::append appends the given value string to the value of an existing item. The reason that value is forced to be a string is that appending mixed types is not well-defined. - + - + If the Memcached::OPT_COMPRESSION is enabled, the operation will fail and a warning will be issued, because appending compressed data to a value that is potentially already compressed is not possible. - + @@ -36,17 +36,17 @@ key - + &memcached.parameter.key; - + value - + The string to append. - + @@ -55,18 +55,18 @@ &reftitle.returnvalues; - + &return.success; Returns &null; when compression is on. - + &reftitle.errors; - + Returns &null; and raises an E_WARNING when compression is enabled. - + diff --git a/reference/memcached/memcached/appendbykey.xml b/reference/memcached/memcached/appendbykey.xml index 756b4bdcc..21201777c 100644 --- a/reference/memcached/memcached/appendbykey.xml +++ b/reference/memcached/memcached/appendbykey.xml @@ -14,12 +14,12 @@ stringkey stringvalue - + Memcached::appendByKey is functionally equivalent to Memcached::append, except that the free-form server_key can be used to map the key to a specific server. - + @@ -29,25 +29,25 @@ server_key - + &memcached.parameter.server_key; - + key - + &memcached.parameter.key; - + value - + The string to append. - + @@ -56,18 +56,18 @@ &reftitle.returnvalues; - + &return.success; Returns &null; when compression is on. - + &reftitle.errors; - + Returns &null; and raises an E_WARNING when compression is enabled. - + diff --git a/reference/memcached/memcached/cas.xml b/reference/memcached/memcached/cas.xml index 40d6e2c5a..1f635c362 100644 --- a/reference/memcached/memcached/cas.xml +++ b/reference/memcached/memcached/cas.xml @@ -15,16 +15,16 @@ mixedvalue intexpiration0 - + Memcached::cas performs a "check and set" operation, so that the item will be stored only if no other client has updated it since it was last fetched by this client. The check is done via the cas_token parameter which is a unique 64-bit - value assigned to the existing item by memcache. See the documentation for + value assigned to the existing item by memcache. See the documentation for Memcached::get* methods for how to obtain this token. Note that the token is represented as a float due to the limitations of PHP's integer space. - + @@ -34,33 +34,33 @@ cas_token - + Unique value associated with the existing item. Generated by memcache. - + key - + &memcached.parameter.key; - + value - + &memcached.parameter.value; - + expiration - + &memcached.parameter.expiration; - + @@ -69,12 +69,12 @@ &reftitle.returnvalues; - + &return.success; The Memcached::getResultCode will return Memcached::RES_DATA_EXISTS if the item you are trying to store has been modified since you last fetched it. - + @@ -98,10 +98,10 @@ do { $m->add('ip_block', $ips); /* otherwise, add IP to the list and store via compare-and-swap with the token, which will fail if someone else updated the list */ - } else { + } else { $ips[] = $_SERVER['REMOTE_ADDR']; $m->cas($cas, 'ip_block', $ips); - } + } } while ($m->getResultCode() != Memcached::RES_SUCCESS); ?> diff --git a/reference/memcached/memcached/casbykey.xml b/reference/memcached/memcached/casbykey.xml index 1b192d27a..7d907dd46 100644 --- a/reference/memcached/memcached/casbykey.xml +++ b/reference/memcached/memcached/casbykey.xml @@ -16,13 +16,13 @@ mixedvalue intexpiration0 - + Memcached::casByKey is functionally equivalent to Memcached::cas, except that the free-form server_key can be used to map the key to a specific server. This is useful if you need to keep a bunch of related keys on a certain server. - + @@ -32,41 +32,41 @@ cas_token - + Unique value associated with the existing item. Generated by memcache. - + server_key - + &memcached.parameter.server_key; - + key - + &memcached.parameter.key; - + value - + &memcached.parameter.value; - + expiration - + &memcached.parameter.expiration; - + @@ -75,12 +75,12 @@ &reftitle.returnvalues; - + &return.success; The Memcached::getResultCode will return Memcached::RES_DATA_EXISTS if the item you are trying to store has been modified since you last fetched it. - + diff --git a/reference/memcached/memcached/construct.xml b/reference/memcached/memcached/construct.xml index 9bb6dfefa..25bf7f39c 100644 --- a/reference/memcached/memcached/construct.xml +++ b/reference/memcached/memcached/construct.xml @@ -14,10 +14,10 @@ callablenullcallback&null; stringnullconnection_str&null; - + Creates a Memcached instance representing the connection to the memcache servers. - + &warn.undocumented.func; @@ -28,13 +28,13 @@ persistent_id - + By default the Memcached instances are destroyed at the end of the request. To create an instance that persists between requests, use persistent_id to specify a unique ID for the instance. All instances created with the same persistent_id will share the same connection. - + @@ -56,10 +56,10 @@ connection_str - + This parameter is used to pass additional connection options to the memcache servers, such as a server weight in a cluster. - + diff --git a/reference/memcached/memcached/decrement.xml b/reference/memcached/memcached/decrement.xml index 8f0e0ab03..280867b89 100644 --- a/reference/memcached/memcached/decrement.xml +++ b/reference/memcached/memcached/decrement.xml @@ -15,14 +15,14 @@ intinitial_value0 intexpiry0 - + Memcached::decrement decrements a numeric item's value by the specified offset. If the item's value is not numeric, an error will result. If the operation would decrease the value below 0, the new value will be 0. Memcached::decrement will set the item to the initial_value parameter if the key doesn't exist. - + @@ -32,33 +32,33 @@ key - + The key of the item to decrement. - + offset - + The amount by which to decrement the item's value. - + initial_value - + The value to set the item to if it doesn't currently exist. - + expiry - + The expiry time to set on the item. - + @@ -67,9 +67,9 @@ &reftitle.returnvalues; - + Returns item's new value on success&return.falseforfailure;. - + diff --git a/reference/memcached/memcached/decrementbykey.xml b/reference/memcached/memcached/decrementbykey.xml index b4de2b90b..e0bb1eaec 100644 --- a/reference/memcached/memcached/decrementbykey.xml +++ b/reference/memcached/memcached/decrementbykey.xml @@ -16,14 +16,14 @@ intinitial_value0 intexpiry0 - + Memcached::decrementByKey decrements a numeric item's value by the specified offset. If the item's value is not numeric, an error will result. If the operation would decrease the value below 0, the new value will be 0. Memcached::decrementByKey will set the item to the initial_value parameter if the key doesn't exist. - + @@ -33,41 +33,41 @@ server_key - + &memcached.parameter.server_key; - + key - + The key of the item to decrement. - + offset - + The amount by which to decrement the item's value. - + initial_value - + The value to set the item to if it doesn't currently exist. - + expiry - + The expiry time to set on the item. - + @@ -76,9 +76,9 @@ &reftitle.returnvalues; - + Returns item's new value on success&return.falseforfailure;. - + diff --git a/reference/memcached/memcached/delete.xml b/reference/memcached/memcached/delete.xml index c2b0baa8e..70b8b5a76 100644 --- a/reference/memcached/memcached/delete.xml +++ b/reference/memcached/memcached/delete.xml @@ -13,9 +13,9 @@ stringkey inttime0 - + Delete the key from the server. - + @@ -25,17 +25,17 @@ key - + The key to be deleted. - + time - + The amount of time the server will wait to delete the item. - + &memcached.note.delete-time; @@ -45,11 +45,11 @@ &reftitle.returnvalues; - + &return.success; The Memcached::getResultCode will return Memcached::RES_NOTFOUND if the key does not exist. - + diff --git a/reference/memcached/memcached/deletebykey.xml b/reference/memcached/memcached/deletebykey.xml index c987e525b..4a46fe46c 100644 --- a/reference/memcached/memcached/deletebykey.xml +++ b/reference/memcached/memcached/deletebykey.xml @@ -14,12 +14,12 @@ stringkey inttime0 - + Memcached::deleteByKey is functionally equivalent to Memcached::delete, except that the free-form server_key can be used to map the key to a specific server. - + @@ -29,25 +29,25 @@ server_key - + &memcached.parameter.server_key; - + key - + The key to be deleted. - + time - + The amount of time the server will wait to delete the item. - + &memcached.note.delete-time; @@ -57,11 +57,11 @@ &reftitle.returnvalues; - + &return.success; The Memcached::getResultCode will return Memcached::RES_NOTFOUND if the key does not exist. - + diff --git a/reference/memcached/memcached/deletemulti.xml b/reference/memcached/memcached/deletemulti.xml index ef8b8bbe4..cc790f569 100644 --- a/reference/memcached/memcached/deletemulti.xml +++ b/reference/memcached/memcached/deletemulti.xml @@ -13,9 +13,9 @@ arraykeys inttime0 - + Delete the array of keys from the server. - + @@ -25,17 +25,17 @@ keys - + The keys to be deleted. - + time - + The amount of time the server will wait to delete the items. - + &memcached.note.delete-time; diff --git a/reference/memcached/memcached/deletemultibykey.xml b/reference/memcached/memcached/deletemultibykey.xml index 9b489cf85..9e79a3a11 100644 --- a/reference/memcached/memcached/deletemultibykey.xml +++ b/reference/memcached/memcached/deletemultibykey.xml @@ -14,12 +14,12 @@ arraykeys inttime0 - + Memcached::deleteMultiByKey is functionally equivalent to Memcached::deleteMulti, except that the free-form server_key can be used to map the keys to a specific server. - + @@ -30,25 +30,25 @@ server_key - + &memcached.parameter.server_key; - + keys - + The keys to be deleted. - + time - + The amount of time the server will wait to delete the items. - + &memcached.note.delete-time; diff --git a/reference/memcached/memcached/fetch.xml b/reference/memcached/memcached/fetch.xml index 04bf6411f..e5cdb0307 100644 --- a/reference/memcached/memcached/fetch.xml +++ b/reference/memcached/memcached/fetch.xml @@ -12,10 +12,10 @@ public arrayfalseMemcached::fetch - + Memcached::fetch retrieves the next result from the last request. - + @@ -25,11 +25,11 @@ &reftitle.returnvalues; - + Returns the next result or &false; otherwise. The Memcached::getResultCode will return Memcached::RES_END if result set is exhausted. - + diff --git a/reference/memcached/memcached/fetchall.xml b/reference/memcached/memcached/fetchall.xml index c579694cd..13875ccaa 100644 --- a/reference/memcached/memcached/fetchall.xml +++ b/reference/memcached/memcached/fetchall.xml @@ -12,10 +12,10 @@ public arrayfalseMemcached::fetchAll - + Memcached::fetchAll retrieves all the remaining results from the last request. - + @@ -25,10 +25,10 @@ &reftitle.returnvalues; - + Returns the results&return.falseforfailure;. &memcached.result.getresultcode; - + diff --git a/reference/memcached/memcached/flush.xml b/reference/memcached/memcached/flush.xml index 85afd18b5..17ec4ad54 100644 --- a/reference/memcached/memcached/flush.xml +++ b/reference/memcached/memcached/flush.xml @@ -12,7 +12,7 @@ public boolMemcached::flush intdelay0 - + Memcached::flush invalidates all existing cache items immediately (by default) or after the delay specified. After invalidation none of the items will be returned in @@ -20,7 +20,7 @@ key after Memcached::flush has invalidated the items). The flush does not actually free all the memory taken up by the existing items; that will happen gradually as new items are stored. - + @@ -30,9 +30,9 @@ delay - + Number of seconds to wait before invalidating the items. - + @@ -41,10 +41,10 @@ &reftitle.returnvalues; - + &return.success; &memcached.result.getresultcode; - + diff --git a/reference/memcached/memcached/get.xml b/reference/memcached/memcached/get.xml index 493bfb549..2887aaf5b 100644 --- a/reference/memcached/memcached/get.xml +++ b/reference/memcached/memcached/get.xml @@ -14,7 +14,7 @@ callablenullcache_cb&null; intget_flags0 - + Memcached::get returns the item that was previously stored under the key. If the item is found and the get_flags is given Memcached::GET_EXTENDED, @@ -22,9 +22,9 @@ Memcached::cas for how to use CAS tokens. Read-through caching callback may be specified via cache_cb parameter. - - - + + + @@ -34,26 +34,26 @@ key - + The key of the item to retrieve. - + cache_cb - + Read-through caching callback or &null;. - + get_flags - + Flags to control the returned result. When Memcached::GET_EXTENDED is given, the function will also return the CAS token. - + @@ -62,13 +62,13 @@ &reftitle.returnvalues; - + Returns the value stored in the cache or &false; otherwise. If the get_flags is set to Memcached::GET_EXTENDED, an array containing the value and the CAS token is returned instead of only the value. The Memcached::getResultCode will return Memcached::RES_NOTFOUND if the key does not exist. - + diff --git a/reference/memcached/memcached/getallkeys.xml b/reference/memcached/memcached/getallkeys.xml index c69666ff3..5af746981 100644 --- a/reference/memcached/memcached/getallkeys.xml +++ b/reference/memcached/memcached/getallkeys.xml @@ -12,17 +12,17 @@ public arrayfalseMemcached::getAllKeys - + Memcached::getAllKeys queries each memcache server and retrieves an array of all keys stored on them at that point in time. This is not an atomic operation, so it isn't a truly consistent snapshot of the keys at point in time. As memcache doesn't guarantee to return all keys you also cannot assume that all keys have been returned. - + - + This method is intended for debugging purposes and should not be used at scale! - + @@ -33,9 +33,9 @@ &reftitle.returnvalues; - + Returns the keys stored on all the servers on success&return.falseforfailure;. - + diff --git a/reference/memcached/memcached/getbykey.xml b/reference/memcached/memcached/getbykey.xml index 3138e8f39..009d036d9 100644 --- a/reference/memcached/memcached/getbykey.xml +++ b/reference/memcached/memcached/getbykey.xml @@ -15,12 +15,12 @@ callablenullcache_cb&null; intget_flags0 - + Memcached::getByKey is functionally equivalent to Memcached::get, except that the free-form server_key can be used to map the key to a specific server. - + @@ -30,34 +30,34 @@ server_key - + &memcached.parameter.server_key; - + key - + The key of the item to fetch. - + cache_cb - + Read-through caching callback or &null; - + get_flags - + Flags to control the returned result. When value of Memcached::GET_EXTENDED is given will return the CAS token. - + @@ -66,11 +66,11 @@ &reftitle.returnvalues; - + Returns the value stored in the cache or &false; otherwise. The Memcached::getResultCode will return Memcached::RES_NOTFOUND if the key does not exist. - + diff --git a/reference/memcached/memcached/getdelayed.xml b/reference/memcached/memcached/getdelayed.xml index 2c0ef5889..6872e4f35 100644 --- a/reference/memcached/memcached/getdelayed.xml +++ b/reference/memcached/memcached/getdelayed.xml @@ -14,7 +14,7 @@ boolwith_cas&false; callablenullvalue_cb&null; - + Memcached::getDelayed issues a request to memcache for multiple items the keys of which are specified in the keys array. The method does not wait for response @@ -22,11 +22,11 @@ either Memcached::fetch or Memcached::fetchAll. If with_cas is true, the CAS token values will also be requested. - - + + Instead of fetching the results explicitly, you can specify a result callback via value_cb parameter. - + @@ -36,25 +36,25 @@ keys - + Array of keys to request. - + with_cas - + Whether to request CAS token values also. - + value_cb - + The result callback or &null;. - + @@ -63,10 +63,10 @@ &reftitle.returnvalues; - + &return.success; &memcached.result.getresultcode; - + diff --git a/reference/memcached/memcached/getdelayedbykey.xml b/reference/memcached/memcached/getdelayedbykey.xml index 92f4c76a7..440bc8397 100644 --- a/reference/memcached/memcached/getdelayedbykey.xml +++ b/reference/memcached/memcached/getdelayedbykey.xml @@ -15,12 +15,12 @@ boolwith_cas&false; callablenullvalue_cb&null; - + Memcached::getDelayedByKey is functionally equivalent to Memcached::getDelayed, except that the free-form server_key can be used to map the keys to a specific server. - + @@ -30,33 +30,33 @@ server_key - + &memcached.parameter.server_key; - + keys - + Array of keys to request. - + with_cas - + Whether to request CAS token values also. - + value_cb - + The result callback or &null;. - + @@ -65,10 +65,10 @@ &reftitle.returnvalues; - + &return.success; &memcached.result.getresultcode; - + diff --git a/reference/memcached/memcached/getmulti.xml b/reference/memcached/memcached/getmulti.xml index 169c59447..2db0e554f 100644 --- a/reference/memcached/memcached/getmulti.xml +++ b/reference/memcached/memcached/getmulti.xml @@ -19,23 +19,23 @@ item, it retrieves multiple items the keys of which are specified in the keys array. - + Before v3.0 a second argument cas_tokens was in use. It was filled with the CAS token values for the found items. The cas_tokens parameter was removed in v3.0 of the extension. It was replaced with a new flag Memcached::GET_EXTENDED that needs is to be used as the value for get_flags. - + - + The get_flags parameter can be used to specify additional options for Memcached::getMulti. Memcached::GET_PRESERVE_ORDER ensures that the keys are returned in the same order as they were requested in. Memcached::GET_EXTENDED ensures that the CAS tokens will be fetched too. - + @@ -45,17 +45,17 @@ keys - + Array of keys to retrieve. - + get_flags - + The flags for the get operation. - + @@ -64,10 +64,10 @@ &reftitle.returnvalues; - + Returns the array of found items&return.falseforfailure;. &memcached.result.getresultcode; - + @@ -212,7 +212,7 @@ bar bar-data baz baz-data lol lol-data kek kek-data -zoo +zoo ]]>     @@ -258,7 +258,7 @@ bar bar-data baz baz-data lol lol-data kek kek-data -zoo +zoo ]]> diff --git a/reference/memcached/memcached/getmultibykey.xml b/reference/memcached/memcached/getmultibykey.xml index 5196d24dd..863883c56 100644 --- a/reference/memcached/memcached/getmultibykey.xml +++ b/reference/memcached/memcached/getmultibykey.xml @@ -14,12 +14,12 @@ arraykeys intget_flags0 - + Memcached::getMultiByKey is functionally equivalent to Memcached::getMulti, except that the free-form server_key can be used to map the keys to a specific server. - + @@ -29,25 +29,25 @@ server_key - + &memcached.parameter.server_key; - + keys - + Array of keys to retrieve. - + get_flags - + The flags for the get operation. - + @@ -56,10 +56,10 @@ &reftitle.returnvalues; - + Returns the array of found items&return.falseforfailure;. &memcached.result.getresultcode; - + diff --git a/reference/memcached/memcached/getoption.xml b/reference/memcached/memcached/getoption.xml index a2b146faa..9dfac98c6 100644 --- a/reference/memcached/memcached/getoption.xml +++ b/reference/memcached/memcached/getoption.xml @@ -12,12 +12,12 @@ public mixedMemcached::getOption intoption - + This method returns the value of a Memcached option. Some options correspond to the ones defined by libmemcached, and some are specific to the extension. See Memcached Constants for more information. - + @@ -27,9 +27,9 @@ option - + One of the Memcached::OPT_* constants. - + @@ -38,10 +38,10 @@ &reftitle.returnvalues; - + Returns the value of the requested option, or &false; on error. - + diff --git a/reference/memcached/memcached/getresultcode.xml b/reference/memcached/memcached/getresultcode.xml index a94bed423..ca3473ca0 100644 --- a/reference/memcached/memcached/getresultcode.xml +++ b/reference/memcached/memcached/getresultcode.xml @@ -12,11 +12,11 @@ public intMemcached::getResultCode - + Memcached::getResultCode returns one of the Memcached::RES_* constants that is the result of the last executed Memcached method. - + @@ -26,9 +26,9 @@ &reftitle.returnvalues; - + Result code of the last Memcached operation. - + diff --git a/reference/memcached/memcached/getresultmessage.xml b/reference/memcached/memcached/getresultmessage.xml index 4d8c5dd6c..eb81dca87 100644 --- a/reference/memcached/memcached/getresultmessage.xml +++ b/reference/memcached/memcached/getresultmessage.xml @@ -12,10 +12,10 @@ public stringMemcached::getResultMessage - + Memcached::getResultMessage returns a string that describes the result code of the last executed Memcached method. - + @@ -25,9 +25,9 @@ &reftitle.returnvalues; - + Message describing the result of the last Memcached operation. - + diff --git a/reference/memcached/memcached/getserverbykey.xml b/reference/memcached/memcached/getserverbykey.xml index b1f784a8f..c8a89c321 100644 --- a/reference/memcached/memcached/getserverbykey.xml +++ b/reference/memcached/memcached/getserverbykey.xml @@ -12,11 +12,11 @@ public arrayfalseMemcached::getServerByKey stringserver_key - + Memcached::getServerByKey returns the server that would be selected by a particular server_key in all the Memcached::*ByKey operations. - + @@ -26,9 +26,9 @@ server_key - + &memcached.parameter.server_key; - + @@ -37,11 +37,11 @@ &reftitle.returnvalues; - + Returns an array containing three keys of host, port, and weight on success&return.falseforfailure;. &memcached.result.getresultcode; - + diff --git a/reference/memcached/memcached/getserverlist.xml b/reference/memcached/memcached/getserverlist.xml index ca7e053a1..50cfcb587 100644 --- a/reference/memcached/memcached/getserverlist.xml +++ b/reference/memcached/memcached/getserverlist.xml @@ -12,10 +12,10 @@ public arrayMemcached::getServerList - + Memcached::getServerList returns the list of all servers that are in its server pool. - + @@ -25,9 +25,9 @@ &reftitle.returnvalues; - + The list of all servers in the server pool. - + diff --git a/reference/memcached/memcached/getstats.xml b/reference/memcached/memcached/getstats.xml index b42ade783..c9277be8c 100644 --- a/reference/memcached/memcached/getstats.xml +++ b/reference/memcached/memcached/getstats.xml @@ -12,12 +12,12 @@ public arrayfalseMemcached::getStats stringnulltype&null; - + Memcached::getStats returns an array containing the state of all available memcache servers. See memcache protocol specification for details on these statistics. - + @@ -27,9 +27,9 @@ type - + The type of statistics to fetch. - + @@ -38,9 +38,9 @@ &reftitle.returnvalues; - + Array of server statistics, one entry per server, &return.falseforfailure;. - + diff --git a/reference/memcached/memcached/getversion.xml b/reference/memcached/memcached/getversion.xml index eb0e79fbe..153f64a08 100644 --- a/reference/memcached/memcached/getversion.xml +++ b/reference/memcached/memcached/getversion.xml @@ -12,10 +12,10 @@ public arrayfalseMemcached::getVersion - + Memcached::getVersion returns an array containing the version info for all available memcache servers. - + @@ -25,9 +25,9 @@ &reftitle.returnvalues; - + Array of server versions, one entry per server. - + diff --git a/reference/memcached/memcached/increment.xml b/reference/memcached/memcached/increment.xml index 562568952..7983a87a4 100644 --- a/reference/memcached/memcached/increment.xml +++ b/reference/memcached/memcached/increment.xml @@ -15,13 +15,13 @@ intinitial_value0 intexpiry0 - + Memcached::increment increments a numeric item's value by the specified offset. If the item's value is not numeric, an error will result. Memcached::increment will set the item to the initial_value parameter if the key doesn't exist. - + @@ -31,33 +31,33 @@ key - + The key of the item to increment. - + offset - + The amount by which to increment the item's value. - + initial_value - + The value to set the item to if it doesn't currently exist. - + expiry - + The expiry time to set on the item. - + @@ -66,9 +66,9 @@ &reftitle.returnvalues; - + Returns new item's value on success&return.falseforfailure;. - + diff --git a/reference/memcached/memcached/incrementbykey.xml b/reference/memcached/memcached/incrementbykey.xml index 1e8cc8d75..e3097333b 100644 --- a/reference/memcached/memcached/incrementbykey.xml +++ b/reference/memcached/memcached/incrementbykey.xml @@ -16,13 +16,13 @@ intinitial_value0 intexpiry0 - + Memcached::incrementByKey increments a numeric item's value by the specified offset. If the item's value is not numeric, an error will result. Memcached::incrementByKey will set the item to the initial_value parameter if the key doesn't exist. - + @@ -32,41 +32,41 @@ server_key - + &memcached.parameter.server_key; - + key - + The key of the item to increment. - + offset - + The amount by which to increment the item's value. - + initial_value - + The value to set the item to if it doesn't currently exist. - + expiry - + The expiry time to set on the item. - + @@ -75,9 +75,9 @@ &reftitle.returnvalues; - + Returns new item's value on success&return.falseforfailure;. - + diff --git a/reference/memcached/memcached/ispersistent.xml b/reference/memcached/memcached/ispersistent.xml index 52a183663..345ac7c01 100644 --- a/reference/memcached/memcached/ispersistent.xml +++ b/reference/memcached/memcached/ispersistent.xml @@ -12,10 +12,10 @@ public boolMemcached::isPersistent - + Memcached::isPersistent checks if the connections to the memcache servers are persistent connections. - + @@ -26,9 +26,9 @@ &reftitle.returnvalues; - + Returns &true; if Memcache instance uses a persistent connection, &false; otherwise. - + diff --git a/reference/memcached/memcached/ispristine.xml b/reference/memcached/memcached/ispristine.xml index 5052afaef..ac82f3dbe 100644 --- a/reference/memcached/memcached/ispristine.xml +++ b/reference/memcached/memcached/ispristine.xml @@ -12,10 +12,10 @@ public boolMemcached::isPristine - + Memcached::isPristine checks if the Memcache instance was recently created. - + @@ -25,9 +25,9 @@ &reftitle.returnvalues; - + Returns &true; if instance is recently created, &false; otherwise. - + diff --git a/reference/memcached/memcached/prepend.xml b/reference/memcached/memcached/prepend.xml index 25a204bd4..186ecff24 100644 --- a/reference/memcached/memcached/prepend.xml +++ b/reference/memcached/memcached/prepend.xml @@ -13,19 +13,19 @@ stringkey stringvalue - + Memcached::prepend prepends the given value string to the value of an existing item. The reason that value is forced to be a string is that prepending mixed types is not well-defined. - + - + If the Memcached::OPT_COMPRESSION is enabled, the operation will fail and a warning will be issued, because prepending compressed data to a value that is potentially already compressed is not possible. - + @@ -36,17 +36,17 @@ key - + The key of the item to prepend the data to. - + value - + The string to prepend. - + @@ -55,18 +55,18 @@ &reftitle.returnvalues; - + &return.success; Returns &null; when compression is on. - + &reftitle.errors; - + Returns &null; and raises an E_WARNING when compression is enabled. - + diff --git a/reference/memcached/memcached/prependbykey.xml b/reference/memcached/memcached/prependbykey.xml index c89f14a79..adc7bd4ed 100644 --- a/reference/memcached/memcached/prependbykey.xml +++ b/reference/memcached/memcached/prependbykey.xml @@ -14,12 +14,12 @@ stringkey stringvalue - + Memcached::prependByKey is functionally equivalent to Memcached::prepend, except that the free-form server_key can be used to map the key to a specific server. - + @@ -29,25 +29,25 @@ server_key - + &memcached.parameter.server_key; - + key - + The key of the item to prepend the data to. - + value - + The string to prepend. - + @@ -56,18 +56,18 @@ &reftitle.returnvalues; - + &return.success; Returns &null; when compression is on. - + &reftitle.errors; - + Returns &null; and raises an E_WARNING when compression is enabled. - + diff --git a/reference/memcached/memcached/quit.xml b/reference/memcached/memcached/quit.xml index ad3c3e515..90b4611db 100644 --- a/reference/memcached/memcached/quit.xml +++ b/reference/memcached/memcached/quit.xml @@ -12,10 +12,10 @@ public boolMemcached::quit - + Memcached::quit closes any open connections to the memcache servers. - + @@ -26,9 +26,9 @@ &reftitle.returnvalues; - + &return.success; - + diff --git a/reference/memcached/memcached/replace.xml b/reference/memcached/memcached/replace.xml index fdae37c01..65fe87cfd 100644 --- a/reference/memcached/memcached/replace.xml +++ b/reference/memcached/memcached/replace.xml @@ -14,11 +14,11 @@ mixedvalue intexpiration0 - + Memcached::replace is similar to Memcached::set, but the operation fails if the key does not exist on the server. - + @@ -28,25 +28,25 @@ key - + &memcached.parameter.key; - + value - + &memcached.parameter.value; - + expiration - + &memcached.parameter.expiration; - + @@ -55,11 +55,11 @@ &reftitle.returnvalues; - + &return.success; The Memcached::getResultCode will return Memcached::RES_NOTSTORED if the key does not exist. - + diff --git a/reference/memcached/memcached/replacebykey.xml b/reference/memcached/memcached/replacebykey.xml index 589410783..ec89f7586 100644 --- a/reference/memcached/memcached/replacebykey.xml +++ b/reference/memcached/memcached/replacebykey.xml @@ -15,13 +15,13 @@ mixedvalue intexpiration0 - + Memcached::replaceByKey is functionally equivalent to Memcached::replace, except that the free-form server_key can be used to map the key to a specific server. This is useful if you need to keep a bunch of related keys on a certain server. - + @@ -31,33 +31,33 @@ server_key - + &memcached.parameter.server_key; - + key - + &memcached.parameter.key; - + value - + &memcached.parameter.value; - + expiration - + &memcached.parameter.expiration; - + @@ -66,11 +66,11 @@ &reftitle.returnvalues; - + &return.success; The Memcached::getResultCode will return Memcached::RES_NOTSTORED if the key does not exist. - + diff --git a/reference/memcached/memcached/resetserverlist.xml b/reference/memcached/memcached/resetserverlist.xml index 4c6a55a58..8caccca04 100644 --- a/reference/memcached/memcached/resetserverlist.xml +++ b/reference/memcached/memcached/resetserverlist.xml @@ -12,10 +12,10 @@ public boolMemcached::resetServerList - + Memcached::resetserverlist removes all memcache servers from the known server list, resetting it back to empty. - + @@ -25,9 +25,9 @@ &reftitle.returnvalues; - + &return.success; - + diff --git a/reference/memcached/memcached/set.xml b/reference/memcached/memcached/set.xml index 4e335ceb3..5a2a916aa 100644 --- a/reference/memcached/memcached/set.xml +++ b/reference/memcached/memcached/set.xml @@ -14,18 +14,18 @@ mixedvalue intexpiration0 - + Memcached::set stores the value on a memcache server under the specified key. The expiration parameter can be used to control when the value is considered expired. - - + + The value can be any valid PHP type except for resources, because those cannot be represented in a serialized form. If the Memcached::OPT_COMPRESSION option is turned on, the serialized value will also be compressed before storage. - + @@ -35,25 +35,25 @@ key - + &memcached.parameter.key; - + value - + &memcached.parameter.value; - + expiration - + &memcached.parameter.expiration; - + @@ -62,10 +62,10 @@ &reftitle.returnvalues; - + &return.success; &memcached.result.getresultcode; - + diff --git a/reference/memcached/memcached/setbykey.xml b/reference/memcached/memcached/setbykey.xml index 815f71bdd..244293827 100644 --- a/reference/memcached/memcached/setbykey.xml +++ b/reference/memcached/memcached/setbykey.xml @@ -15,13 +15,13 @@ mixedvalue intexpiration0 - + Memcached::setByKey is functionally equivalent to Memcached::set, except that the free-form server_key can be used to map the key to a specific server. This is useful if you need to keep a bunch of related keys on a certain server. - + @@ -31,33 +31,33 @@ server_key - + &memcached.parameter.server_key; - + key - + &memcached.parameter.key; - + value - + &memcached.parameter.value; - + expiration - + &memcached.parameter.expiration; - + @@ -66,10 +66,10 @@ &reftitle.returnvalues; - + &return.success; &memcached.result.getresultcode; - + diff --git a/reference/memcached/memcached/setmulti.xml b/reference/memcached/memcached/setmulti.xml index 144afe825..c5810fa35 100644 --- a/reference/memcached/memcached/setmulti.xml +++ b/reference/memcached/memcached/setmulti.xml @@ -13,13 +13,13 @@ arrayitems intexpiration0 - + Memcached::setMulti is similar to Memcached::set, but instead of a single key/value item, it works on multiple items specified in items. The expiration time applies to all the items at once. - + @@ -29,17 +29,17 @@ items - + &memcached.parameter.items; - + expiration - + &memcached.parameter.expiration; - + @@ -48,10 +48,10 @@ &reftitle.returnvalues; - + &return.success; &memcached.result.getresultcode; - + diff --git a/reference/memcached/memcached/setmultibykey.xml b/reference/memcached/memcached/setmultibykey.xml index 1709bb50a..5af1208f3 100644 --- a/reference/memcached/memcached/setmultibykey.xml +++ b/reference/memcached/memcached/setmultibykey.xml @@ -14,13 +14,13 @@ arrayitems intexpiration0 - + Memcached::setMultiByKey is functionally equivalent to Memcached::setMulti, except that the free-form server_key can be used to map the keys from items to a specific server. This is useful if you need to keep a bunch of related keys on a certain server. - + @@ -30,25 +30,25 @@ server_key - + &memcached.parameter.server_key; - + items - + &memcached.parameter.items; - + expiration - + &memcached.parameter.expiration; - + @@ -57,10 +57,10 @@ &reftitle.returnvalues; - + &return.success; &memcached.result.getresultcode; - + diff --git a/reference/memcached/memcached/setoption.xml b/reference/memcached/memcached/setoption.xml index a790fc6dc..95dee4f74 100644 --- a/reference/memcached/memcached/setoption.xml +++ b/reference/memcached/memcached/setoption.xml @@ -13,11 +13,11 @@ intoption mixedvalue - + This method sets the value of a Memcached option. Some options correspond to the ones defined by libmemcached, and some are specific to the extension. - + @@ -27,18 +27,18 @@ option - + One of the Memcached::OPT_* constant. See Memcached Constants for more information. - + value - + The value to be set. - + The options listed below require values specified via constants. @@ -74,9 +74,9 @@ &reftitle.returnvalues; - + &return.success; - + diff --git a/reference/memcached/memcached/setoptions.xml b/reference/memcached/memcached/setoptions.xml index f5debf114..b55aa581a 100644 --- a/reference/memcached/memcached/setoptions.xml +++ b/reference/memcached/memcached/setoptions.xml @@ -12,11 +12,11 @@ public boolMemcached::setOptions arrayoptions - + Memcached::setOptions is a variation of the Memcached::setOption that takes an array of options to be set. - + @@ -25,10 +25,10 @@ options - + An associative array of options where the key is the option to set and the value is the new value for the option. - + @@ -36,9 +36,9 @@ &reftitle.returnvalues; - + &return.success; - + diff --git a/reference/memcached/memcached/setsaslauthdata.xml b/reference/memcached/memcached/setsaslauthdata.xml index 63cfd1c04..64b0f21f4 100644 --- a/reference/memcached/memcached/setsaslauthdata.xml +++ b/reference/memcached/memcached/setsaslauthdata.xml @@ -13,16 +13,16 @@ stringusername stringpassword - + Memcached::setSaslAuthData sets the username and password that should be used for SASL authentication with the memcache servers. - - + + This method is only available when the memcached extension is built with SASL support. Please refer to Memcached setup for how to do this. - + @@ -32,17 +32,17 @@ username - + The username to use for authentication. - + password - + The password to use for authentication. - + @@ -51,9 +51,9 @@ &reftitle.returnvalues; - + &return.success; - + diff --git a/reference/memcached/memcached/touch.xml b/reference/memcached/memcached/touch.xml index cb50f310d..ddbd8a90a 100644 --- a/reference/memcached/memcached/touch.xml +++ b/reference/memcached/memcached/touch.xml @@ -13,9 +13,9 @@ stringkey intexpiration0 - + Memcached::touch sets a new expiration value on the given key. - + @@ -25,17 +25,17 @@ key - + &memcached.parameter.key; - + expiration - + &memcached.parameter.expiration; - + @@ -44,10 +44,10 @@ &reftitle.returnvalues; - + &return.success; &memcached.result.getresultcode; - + diff --git a/reference/memcached/memcached/touchbykey.xml b/reference/memcached/memcached/touchbykey.xml index 5c77f6127..0454ca941 100644 --- a/reference/memcached/memcached/touchbykey.xml +++ b/reference/memcached/memcached/touchbykey.xml @@ -14,12 +14,12 @@ stringkey intexpiration0 - + Memcached::touchByKey is functionally equivalent to Memcached::touch, except that the free-form server_key can be used to map the key to a specific server. - + @@ -29,25 +29,25 @@ server_key - + &memcached.parameter.server_key; - + key - + &memcached.parameter.key; - + expiration - + &memcached.parameter.expiration; - + @@ -56,10 +56,10 @@ &reftitle.returnvalues; - + &return.success; &memcached.result.getresultcode; - + diff --git a/reference/memcached/memcachedexception.xml b/reference/memcached/memcachedexception.xml index 3c10b5007..0b85249ea 100644 --- a/reference/memcached/memcachedexception.xml +++ b/reference/memcached/memcachedexception.xml @@ -11,9 +11,9 @@
    &reftitle.intro; - - - + + +
    @@ -29,14 +29,14 @@ MemcachedException - + extends RuntimeException - + &InheritedProperties; @@ -48,7 +48,7 @@
    - +     diff --git a/reference/memcached/sessions.xml b/reference/memcached/sessions.xml index f9cc49362..605d90610 100644 --- a/reference/memcached/sessions.xml +++ b/reference/memcached/sessions.xml @@ -3,12 +3,12 @@ Sessions support - Memcached provides a custom session handler that can be used to store + Memcached provides a custom session handler that can be used to store user sessions in memcache. A completely separate memcached instance is used for that internally, so you can use a different server pool if necessary. The session keys are stored under the prefix memc.sess.key., so be aware of this if you use the - same server pool for sessions and generic caching. + same server pool for sessions and generic caching. @@ -18,9 +18,9 @@ string - + Set to memcached to enable sessions support. - + @@ -30,11 +30,11 @@ string - + Defines a comma separated of hostname:port entries to use for session server pool, for example "sess1:11211, sess2:11211". - + diff --git a/reference/memcached/setup.xml b/reference/memcached/setup.xml index 6590fe5cf..7298e4fd7 100644 --- a/reference/memcached/setup.xml +++ b/reference/memcached/setup.xml @@ -6,15 +6,15 @@
    &reftitle.required; - + This extension requires libmemcached client library (version 1.0.0 or greater). For SASL authentication support, libmemcached must be built with SASL enabled. - - + + Since version 0.2.0, this extension requires PHP version 5.2.0 or higher. - +
    diff --git a/reference/mongodb/architecture.xml b/reference/mongodb/architecture.xml index 94972a67a..379441354 100644 --- a/reference/mongodb/architecture.xml +++ b/reference/mongodb/architecture.xml @@ -292,13 +292,13 @@ foreach ($managers as $manager) { MongoDB\BSON\Serializable may only be serialized as a document field value. Attempting to serialize such an object as a root document will throw a - MongoDB\Driver\Exception\UnexpectedValueException + MongoDB\Driver\Exception\UnexpectedValueException If an object is of an unknown class implementing the MongoDB\BSON\Type interface, then throw a - MongoDB\Driver\Exception\UnexpectedValueException + MongoDB\Driver\Exception\UnexpectedValueException @@ -347,7 +347,7 @@ foreach ($managers as $manager) { If MongoDB\BSON\Serializable::bsonSerialize did not return an array or stdClass, throw an - MongoDB\Driver\Exception\UnexpectedValueException + MongoDB\Driver\Exception\UnexpectedValueException exception. @@ -736,7 +736,7 @@ class UpperClass implements MongoDB\BSON\Persistable If the named class does not exist, is not concrete (i.e. it is abstract or an interface), or does not implement MongoDB\BSON\Unserializable then an - MongoDB\Driver\Exception\InvalidArgumentException + MongoDB\Driver\Exception\InvalidArgumentException exception is thrown. diff --git a/reference/mongodb/bson/binary/construct.xml b/reference/mongodb/bson/binary/construct.xml index 959c1d892..0228a7db8 100644 --- a/reference/mongodb/bson/binary/construct.xml +++ b/reference/mongodb/bson/binary/construct.xml @@ -42,8 +42,8 @@ &reftitle.errors; &mongodb.throws.argumentparsing; - Throws MongoDB\Driver\Exception\InvalidArgumentException if type is not an unsigned 8-bit integer. - Throws MongoDB\Driver\Exception\InvalidArgumentException if type is MongoDB\BSON\Binary::TYPE_UUID or MongoDB\BSON\Binary::TYPE_OLD_UUID and data is not exactly 16 bytes in length. + Throws MongoDB\Driver\Exception\InvalidArgumentException if type is not an unsigned 8-bit integer. + Throws MongoDB\Driver\Exception\InvalidArgumentException if type is MongoDB\BSON\Binary::TYPE_UUID or MongoDB\BSON\Binary::TYPE_OLD_UUID and data is not exactly 16 bytes in length. @@ -71,7 +71,7 @@ PECL mongodb 1.3.0 - MongoDB\Driver\Exception\InvalidArgumentException + MongoDB\Driver\Exception\InvalidArgumentException is thrown if type is MongoDB\BSON\Binary::TYPE_UUID or MongoDB\BSON\Binary::TYPE_OLD_UUID and @@ -83,7 +83,7 @@ PECL mongodb 1.1.3 - MongoDB\Driver\Exception\InvalidArgumentException + MongoDB\Driver\Exception\InvalidArgumentException is thrown if type is not an unsigned 8-bit integer. diff --git a/reference/mongodb/bson/binary/getvectortype.xml b/reference/mongodb/bson/binary/getvectortype.xml index d858645fe..3f90fc44b 100644 --- a/reference/mongodb/bson/binary/getvectortype.xml +++ b/reference/mongodb/bson/binary/getvectortype.xml @@ -30,7 +30,7 @@ &reftitle.errors; - Throws MongoDB\Driver\Exception\LogicException if the subtype is not MongoDB\BSON\Binary::SUBTYPE_VECTOR. + Throws MongoDB\Driver\Exception\LogicException if the subtype is not MongoDB\BSON\Binary::SUBTYPE_VECTOR. &mongodb.throws.argumentparsing; diff --git a/reference/mongodb/bson/binary/toarray.xml b/reference/mongodb/bson/binary/toarray.xml index e73e98115..6d5b9c2d2 100644 --- a/reference/mongodb/bson/binary/toarray.xml +++ b/reference/mongodb/bson/binary/toarray.xml @@ -30,7 +30,7 @@ &reftitle.errors; - Throws MongoDB\Driver\Exception\LogicException if the subtype is not MongoDB\BSON\Binary::SUBTYPE_VECTOR. + Throws MongoDB\Driver\Exception\LogicException if the subtype is not MongoDB\BSON\Binary::SUBTYPE_VECTOR. &mongodb.throws.argumentparsing; diff --git a/reference/mongodb/bson/decimal128/construct.xml b/reference/mongodb/bson/decimal128/construct.xml index 48b29afe4..31031412b 100644 --- a/reference/mongodb/bson/decimal128/construct.xml +++ b/reference/mongodb/bson/decimal128/construct.xml @@ -34,7 +34,7 @@ &reftitle.errors; &mongodb.throws.argumentparsing; - Throws MongoDB\Driver\Exception\InvalidArgumentException if value is not a valid decimal string. + Throws MongoDB\Driver\Exception\InvalidArgumentException if value is not a valid decimal string. diff --git a/reference/mongodb/bson/document/frombson.xml b/reference/mongodb/bson/document/frombson.xml index 87a76ce07..e50dc9a82 100644 --- a/reference/mongodb/bson/document/frombson.xml +++ b/reference/mongodb/bson/document/frombson.xml @@ -40,7 +40,7 @@ &reftitle.errors; &mongodb.throws.argumentparsing; - Throws MongoDB\Driver\Exception\UnexpectedValueException if bson is an invalid BSON string or contains more than a single document. + Throws MongoDB\Driver\Exception\UnexpectedValueException if bson is an invalid BSON string or contains more than a single document. diff --git a/reference/mongodb/bson/document/fromjson.xml b/reference/mongodb/bson/document/fromjson.xml index 23e460fb9..ea074b822 100644 --- a/reference/mongodb/bson/document/fromjson.xml +++ b/reference/mongodb/bson/document/fromjson.xml @@ -47,7 +47,7 @@ &mongodb.throws.argumentparsing; Throws - MongoDB\Driver\Exception\UnexpectedValueException if + MongoDB\Driver\Exception\UnexpectedValueException if the JSON value cannot be converted to a BSON document (e.g. due to a syntax error). diff --git a/reference/mongodb/bson/document/get.xml b/reference/mongodb/bson/document/get.xml index c9f4186e1..6548b1e81 100644 --- a/reference/mongodb/bson/document/get.xml +++ b/reference/mongodb/bson/document/get.xml @@ -48,7 +48,7 @@ &reftitle.errors; &mongodb.throws.argumentparsing; - Throws MongoDB\Driver\Exception\RuntimeException if the key is not present in the document. + Throws MongoDB\Driver\Exception\RuntimeException if the key is not present in the document. diff --git a/reference/mongodb/bson/document/getiterator.xml b/reference/mongodb/bson/document/getiterator.xml index 1992625f6..ddf84822d 100644 --- a/reference/mongodb/bson/document/getiterator.xml +++ b/reference/mongodb/bson/document/getiterator.xml @@ -32,7 +32,7 @@ &reftitle.errors; &mongodb.throws.argumentparsing; - Throws MongoDB\Driver\Exception\UnexpectedValueException if the BSON iterator could not be initialized. + Throws MongoDB\Driver\Exception\UnexpectedValueException if the BSON iterator could not be initialized. diff --git a/reference/mongodb/bson/document/offsetget.xml b/reference/mongodb/bson/document/offsetget.xml index 8463b5aef..6d3b546a1 100644 --- a/reference/mongodb/bson/document/offsetget.xml +++ b/reference/mongodb/bson/document/offsetget.xml @@ -48,7 +48,7 @@ &reftitle.errors; &mongodb.throws.argumentparsing; - Throws MongoDB\Driver\Exception\RuntimeException if the key is not present in the document. + Throws MongoDB\Driver\Exception\RuntimeException if the key is not present in the document. diff --git a/reference/mongodb/bson/document/offsetset.xml b/reference/mongodb/bson/document/offsetset.xml index 9109ac6b5..d955e5b0f 100644 --- a/reference/mongodb/bson/document/offsetset.xml +++ b/reference/mongodb/bson/document/offsetset.xml @@ -52,7 +52,7 @@ &reftitle.errors; - Always throws a MongoDB\Driver\Exception\LogicException. + Always throws a MongoDB\Driver\Exception\LogicException. diff --git a/reference/mongodb/bson/document/offsetunset.xml b/reference/mongodb/bson/document/offsetunset.xml index b175dabf8..3f7824752 100644 --- a/reference/mongodb/bson/document/offsetunset.xml +++ b/reference/mongodb/bson/document/offsetunset.xml @@ -42,7 +42,7 @@ &reftitle.errors; - Always throws a MongoDB\Driver\Exception\LogicException. + Always throws a MongoDB\Driver\Exception\LogicException. diff --git a/reference/mongodb/bson/document/tophp.xml b/reference/mongodb/bson/document/tophp.xml index 3aad47e7d..a2b805994 100644 --- a/reference/mongodb/bson/document/tophp.xml +++ b/reference/mongodb/bson/document/tophp.xml @@ -47,7 +47,7 @@ Throws - MongoDB\Driver\Exception\InvalidArgumentException if + MongoDB\Driver\Exception\InvalidArgumentException if a class in the type map cannot be instantiated or does not implement MongoDB\BSON\Unserializable. diff --git a/reference/mongodb/bson/int64/construct.xml b/reference/mongodb/bson/int64/construct.xml index 955f62c20..ae9681416 100644 --- a/reference/mongodb/bson/int64/construct.xml +++ b/reference/mongodb/bson/int64/construct.xml @@ -64,7 +64,7 @@ &reftitle.errors; &mongodb.throws.argumentparsing; - Throws MongoDB\Driver\Exception\InvalidArgumentException if string value cannot be parsed as a 64-bit integer. + Throws MongoDB\Driver\Exception\InvalidArgumentException if string value cannot be parsed as a 64-bit integer. diff --git a/reference/mongodb/bson/iterator/current.xml b/reference/mongodb/bson/iterator/current.xml index 28c3ccf32..b471cf422 100644 --- a/reference/mongodb/bson/iterator/current.xml +++ b/reference/mongodb/bson/iterator/current.xml @@ -38,7 +38,7 @@ &reftitle.errors; &mongodb.throws.argumentparsing; - Throws MongoDB\Driver\Exception\LogicException if the iterator is not valid. + Throws MongoDB\Driver\Exception\LogicException if the iterator is not valid. diff --git a/reference/mongodb/bson/iterator/key.xml b/reference/mongodb/bson/iterator/key.xml index 902d0f3fb..82943cf9d 100644 --- a/reference/mongodb/bson/iterator/key.xml +++ b/reference/mongodb/bson/iterator/key.xml @@ -33,7 +33,7 @@ &reftitle.errors; &mongodb.throws.argumentparsing; - Throws MongoDB\Driver\Exception\LogicException if the iterator is not valid. + Throws MongoDB\Driver\Exception\LogicException if the iterator is not valid. diff --git a/reference/mongodb/bson/javascript/construct.xml b/reference/mongodb/bson/javascript/construct.xml index 3ddff9dcd..232f3ed29 100644 --- a/reference/mongodb/bson/javascript/construct.xml +++ b/reference/mongodb/bson/javascript/construct.xml @@ -42,7 +42,7 @@ &reftitle.errors; &mongodb.throws.argumentparsing; - Throws MongoDB\Driver\Exception\InvalidArgumentException if code contains null bytes. + Throws MongoDB\Driver\Exception\InvalidArgumentException if code contains null bytes. @@ -61,7 +61,7 @@ PECL mongodb 1.2.0 - MongoDB\Driver\Exception\InvalidArgumentException + MongoDB\Driver\Exception\InvalidArgumentException is thrown if code contains null bytes. Previously, values would be truncated at the first null byte. diff --git a/reference/mongodb/bson/maxkey/construct.xml b/reference/mongodb/bson/maxkey/construct.xml index 5b5e25c70..d506a70dd 100644 --- a/reference/mongodb/bson/maxkey/construct.xml +++ b/reference/mongodb/bson/maxkey/construct.xml @@ -1,5 +1,5 @@ - + diff --git a/reference/mongodb/bson/minkey/construct.xml b/reference/mongodb/bson/minkey/construct.xml index 6d7ceae54..8f7f08f68 100644 --- a/reference/mongodb/bson/minkey/construct.xml +++ b/reference/mongodb/bson/minkey/construct.xml @@ -1,5 +1,5 @@ - + diff --git a/reference/mongodb/bson/objectid/construct.xml b/reference/mongodb/bson/objectid/construct.xml index e47250b04..4df99a429 100644 --- a/reference/mongodb/bson/objectid/construct.xml +++ b/reference/mongodb/bson/objectid/construct.xml @@ -34,7 +34,7 @@ &reftitle.errors; &mongodb.throws.argumentparsing; - Throws MongoDB\Driver\Exception\InvalidArgumentException if id is not a 24-character hexadecimal string. + Throws MongoDB\Driver\Exception\InvalidArgumentException if id is not a 24-character hexadecimal string. diff --git a/reference/mongodb/bson/packedarray/fromjson.xml b/reference/mongodb/bson/packedarray/fromjson.xml index d671f426d..c3065146c 100644 --- a/reference/mongodb/bson/packedarray/fromjson.xml +++ b/reference/mongodb/bson/packedarray/fromjson.xml @@ -46,7 +46,7 @@ &mongodb.throws.argumentparsing; Throws - MongoDB\Driver\Exception\UnexpectedValueException if + MongoDB\Driver\Exception\UnexpectedValueException if the JSON value cannot be converted to a BSON array (e.g. due to a syntax error). diff --git a/reference/mongodb/bson/packedarray/fromphp.xml b/reference/mongodb/bson/packedarray/fromphp.xml index aaa46329e..908583ec4 100644 --- a/reference/mongodb/bson/packedarray/fromphp.xml +++ b/reference/mongodb/bson/packedarray/fromphp.xml @@ -41,7 +41,7 @@ &reftitle.errors; &mongodb.throws.argumentparsing; - Throws MongoDB\Driver\Exception\InvalidArgumentException if the given array is not a list (i.e. has sequential numeric keys starting with 0). + Throws MongoDB\Driver\Exception\InvalidArgumentException if the given array is not a list (i.e. has sequential numeric keys starting with 0). diff --git a/reference/mongodb/bson/packedarray/get.xml b/reference/mongodb/bson/packedarray/get.xml index 6f89e44cb..83a49b876 100644 --- a/reference/mongodb/bson/packedarray/get.xml +++ b/reference/mongodb/bson/packedarray/get.xml @@ -48,7 +48,7 @@ &reftitle.errors; &mongodb.throws.argumentparsing; - Throws MongoDB\Driver\Exception\RuntimeException if the index is not present in the array. + Throws MongoDB\Driver\Exception\RuntimeException if the index is not present in the array. diff --git a/reference/mongodb/bson/packedarray/getiterator.xml b/reference/mongodb/bson/packedarray/getiterator.xml index a96fd1a1d..05ba15c7c 100644 --- a/reference/mongodb/bson/packedarray/getiterator.xml +++ b/reference/mongodb/bson/packedarray/getiterator.xml @@ -32,7 +32,7 @@ &reftitle.errors; &mongodb.throws.argumentparsing; - Throws MongoDB\Driver\Exception\UnexpectedValueException if the BSON iterator could not be initialized. + Throws MongoDB\Driver\Exception\UnexpectedValueException if the BSON iterator could not be initialized. diff --git a/reference/mongodb/bson/packedarray/offsetget.xml b/reference/mongodb/bson/packedarray/offsetget.xml index 46b38b6fd..8ef09b83e 100644 --- a/reference/mongodb/bson/packedarray/offsetget.xml +++ b/reference/mongodb/bson/packedarray/offsetget.xml @@ -48,7 +48,7 @@ &reftitle.errors; &mongodb.throws.argumentparsing; - Throws MongoDB\Driver\Exception\RuntimeException if the index is not present in the array. + Throws MongoDB\Driver\Exception\RuntimeException if the index is not present in the array. diff --git a/reference/mongodb/bson/packedarray/offsetset.xml b/reference/mongodb/bson/packedarray/offsetset.xml index edf95ca9d..8fb3d04ae 100644 --- a/reference/mongodb/bson/packedarray/offsetset.xml +++ b/reference/mongodb/bson/packedarray/offsetset.xml @@ -52,7 +52,7 @@ &reftitle.errors; - Always throws a MongoDB\Driver\Exception\LogicException. + Always throws a MongoDB\Driver\Exception\LogicException. diff --git a/reference/mongodb/bson/packedarray/offsetunset.xml b/reference/mongodb/bson/packedarray/offsetunset.xml index 6ecaead40..74c4cc761 100644 --- a/reference/mongodb/bson/packedarray/offsetunset.xml +++ b/reference/mongodb/bson/packedarray/offsetunset.xml @@ -42,7 +42,7 @@ &reftitle.errors; - Always throws a MongoDB\Driver\Exception\LogicException. + Always throws a MongoDB\Driver\Exception\LogicException. diff --git a/reference/mongodb/bson/packedarray/tophp.xml b/reference/mongodb/bson/packedarray/tophp.xml index 45304188f..fe9f3f757 100644 --- a/reference/mongodb/bson/packedarray/tophp.xml +++ b/reference/mongodb/bson/packedarray/tophp.xml @@ -41,7 +41,7 @@ Throws - MongoDB\Driver\Exception\InvalidArgumentException if + MongoDB\Driver\Exception\InvalidArgumentException if a class in the type map cannot be instantiated or does not implement MongoDB\BSON\Unserializable. diff --git a/reference/mongodb/bson/regex/construct.xml b/reference/mongodb/bson/regex/construct.xml index b22c5ce9b..f16b21722 100644 --- a/reference/mongodb/bson/regex/construct.xml +++ b/reference/mongodb/bson/regex/construct.xml @@ -49,7 +49,7 @@ &reftitle.errors; &mongodb.throws.argumentparsing; - Throws MongoDB\Driver\Exception\InvalidArgumentException if pattern or flags contain null bytes. + Throws MongoDB\Driver\Exception\InvalidArgumentException if pattern or flags contain null bytes. @@ -77,7 +77,7 @@ were stored in the order provided. - MongoDB\Driver\Exception\InvalidArgumentException + MongoDB\Driver\Exception\InvalidArgumentException is thrown if pattern or flags contain null bytes. Previously, values would be truncated at the first null byte. diff --git a/reference/mongodb/exceptions.xml b/reference/mongodb/exceptions.xml index d423662c9..348c401dc 100644 --- a/reference/mongodb/exceptions.xml +++ b/reference/mongodb/exceptions.xml @@ -30,35 +30,35 @@ The class hierarchy for MongoDB exceptions is modeled after that of the SPL Exceptions. Base classes extend their SPL counterpart and all exception classes in the extension implement - the MongoDB\Driver\Exception\Exception interface. + the MongoDB\Driver\Exception\Exception interface. - MongoDB\Driver\Exception\LogicException (extends LogicException) - MongoDB\Driver\Exception\InvalidArgumentException (extends InvalidArgumentException) - MongoDB\Driver\Exception\UnexpectedValueException (extends UnexpectedValueException) + MongoDB\Driver\Exception\LogicException (extends LogicException) + MongoDB\Driver\Exception\InvalidArgumentException (extends InvalidArgumentException) + MongoDB\Driver\Exception\UnexpectedValueException (extends UnexpectedValueException) - MongoDB\Driver\Exception\RuntimeException (extends RuntimeException) + MongoDB\Driver\Exception\RuntimeException (extends RuntimeException) - MongoDB\Driver\Exception\ConnectionException + MongoDB\Driver\Exception\ConnectionException - MongoDB\Driver\Exception\AuthenticationException - MongoDB\Driver\Exception\ConnectionTimeoutException - MongoDB\Driver\Exception\SSLConnectionException (deprecated) + MongoDB\Driver\Exception\AuthenticationException + MongoDB\Driver\Exception\ConnectionTimeoutException + MongoDB\Driver\Exception\SSLConnectionException (deprecated) - MongoDB\Driver\Exception\EncryptionException + MongoDB\Driver\Exception\EncryptionException - MongoDB\Driver\Exception\ServerException + MongoDB\Driver\Exception\ServerException - MongoDB\Driver\Exception\BulkWriteCommandException - MongoDB\Driver\Exception\CommandException - MongoDB\Driver\Exception\ExecutionTimeoutException + MongoDB\Driver\Exception\BulkWriteCommandException + MongoDB\Driver\Exception\CommandException + MongoDB\Driver\Exception\ExecutionTimeoutException - MongoDB\Driver\Exception\WriteException (deprecated) + MongoDB\Driver\Exception\WriteException (deprecated) - MongoDB\Driver\Exception\BulkWriteException + MongoDB\Driver\Exception\BulkWriteException diff --git a/reference/mongodb/functions/bson/fromjson.xml b/reference/mongodb/functions/bson/fromjson.xml index a91e0e0b2..da1514e3f 100644 --- a/reference/mongodb/functions/bson/fromjson.xml +++ b/reference/mongodb/functions/bson/fromjson.xml @@ -56,7 +56,7 @@ Throws - MongoDB\Driver\Exception\UnexpectedValueException if + MongoDB\Driver\Exception\UnexpectedValueException if the JSON value cannot be converted to BSON (e.g. due to a syntax error). diff --git a/reference/mongodb/functions/bson/fromphp.xml b/reference/mongodb/functions/bson/fromphp.xml index d7d45261b..f53538a3c 100644 --- a/reference/mongodb/functions/bson/fromphp.xml +++ b/reference/mongodb/functions/bson/fromphp.xml @@ -56,7 +56,7 @@ Throws - MongoDB\Driver\Exception\UnexpectedValueException if + MongoDB\Driver\Exception\UnexpectedValueException if the PHP value cannot be converted to BSON. Possible reasons include, but are not limited to, encountering an unexpected MongoDB\BSON\Type instance or diff --git a/reference/mongodb/functions/bson/tophp.xml b/reference/mongodb/functions/bson/tophp.xml index 55fd33728..1517bdbf3 100644 --- a/reference/mongodb/functions/bson/tophp.xml +++ b/reference/mongodb/functions/bson/tophp.xml @@ -59,7 +59,7 @@ Throws - MongoDB\Driver\Exception\InvalidArgumentException if + MongoDB\Driver\Exception\InvalidArgumentException if a class in the type map cannot be instantiated or does not implement MongoDB\BSON\Unserializable. @@ -93,7 +93,7 @@ PECL mongodb 1.3.2 - MongoDB\Driver\Exception\UnexpectedValueException + MongoDB\Driver\Exception\UnexpectedValueException is no longer thrown if the input contains an unsupported, deprecated BSON type. Such types will be ignored (as they were in versions before 1.3.0), although the extension will now log a warning to the debug log @@ -105,7 +105,7 @@ PECL mongodb 1.3.0 - MongoDB\Driver\Exception\UnexpectedValueException + MongoDB\Driver\Exception\UnexpectedValueException is thrown if the input contains an unsupported, deprecated BSON type. Previously, such types were ignored. diff --git a/reference/mongodb/mongodb/driver/bulkwrite.xml b/reference/mongodb/mongodb/driver/bulkwrite.xml index 81e2df95c..a0f7d318b 100644 --- a/reference/mongodb/mongodb/driver/bulkwrite.xml +++ b/reference/mongodb/mongodb/driver/bulkwrite.xml @@ -192,8 +192,8 @@ Updated 2 document(s) MongoDB\Driver\Manager::executeBulkWrite MongoDB\Driver\WriteResult MongoDB\Driver\WriteConcern - MongoDB\Driver\WriteConcernError - MongoDB\Driver\WriteError + MongoDB\Driver\WriteConcernError + MongoDB\Driver\WriteError
    diff --git a/reference/mongodb/mongodb/driver/bulkwritecommand.xml b/reference/mongodb/mongodb/driver/bulkwritecommand.xml index ab837a85a..7ce7546a1 100644 --- a/reference/mongodb/mongodb/driver/bulkwritecommand.xml +++ b/reference/mongodb/mongodb/driver/bulkwritecommand.xml @@ -167,10 +167,10 @@ Inserted 2 document(s) MongoDB\Driver\Manager::executeBulkWriteCommand MongoDB\Driver\BulkWriteCommandResult - MongoDB\Driver\Exception\BulkWriteCommandException + MongoDB\Driver\Exception\BulkWriteCommandException MongoDB\Driver\WriteConcern - MongoDB\Driver\WriteConcernError - MongoDB\Driver\WriteError + MongoDB\Driver\WriteConcernError + MongoDB\Driver\WriteError
    diff --git a/reference/mongodb/mongodb/driver/clientencryption/addkeyaltname.xml b/reference/mongodb/mongodb/driver/clientencryption/addkeyaltname.xml index a48595e1d..128ac4501 100644 --- a/reference/mongodb/mongodb/driver/clientencryption/addkeyaltname.xml +++ b/reference/mongodb/mongodb/driver/clientencryption/addkeyaltname.xml @@ -56,7 +56,7 @@ &reftitle.errors; &mongodb.throws.std; - Throws MongoDB\Driver\Exception\RuntimeException on other errors. + Throws MongoDB\Driver\Exception\RuntimeException on other errors. diff --git a/reference/mongodb/mongodb/driver/clientencryption/construct.xml b/reference/mongodb/mongodb/driver/clientencryption/construct.xml index 044af3620..e875da158 100644 --- a/reference/mongodb/mongodb/driver/clientencryption/construct.xml +++ b/reference/mongodb/mongodb/driver/clientencryption/construct.xml @@ -57,7 +57,7 @@ &reftitle.errors; &mongodb.throws.argumentparsing; - Throws MongoDB\Driver\Exception\RuntimeException if the extension was compiled without libmongocrypt support + Throws MongoDB\Driver\Exception\RuntimeException if the extension was compiled without libmongocrypt support diff --git a/reference/mongodb/mongodb/driver/clientencryption/createdatakey.xml b/reference/mongodb/mongodb/driver/clientencryption/createdatakey.xml index 995bfad5c..7b705d5c2 100644 --- a/reference/mongodb/mongodb/driver/clientencryption/createdatakey.xml +++ b/reference/mongodb/mongodb/driver/clientencryption/createdatakey.xml @@ -105,7 +105,7 @@ &reftitle.errors; &mongodb.throws.std; - Throws MongoDB\Driver\Exception\RuntimeException on other errors. + Throws MongoDB\Driver\Exception\RuntimeException on other errors. diff --git a/reference/mongodb/mongodb/driver/clientencryption/decrypt.xml b/reference/mongodb/mongodb/driver/clientencryption/decrypt.xml index 7753f4996..59eee9e47 100644 --- a/reference/mongodb/mongodb/driver/clientencryption/decrypt.xml +++ b/reference/mongodb/mongodb/driver/clientencryption/decrypt.xml @@ -45,7 +45,7 @@ &reftitle.errors; &mongodb.throws.argumentparsing; - Throws MongoDB\Driver\Exception\EncryptionException if an error occurs while decrypting the value + Throws MongoDB\Driver\Exception\EncryptionException if an error occurs while decrypting the value diff --git a/reference/mongodb/mongodb/driver/clientencryption/deletekey.xml b/reference/mongodb/mongodb/driver/clientencryption/deletekey.xml index 398b5397b..acdfa0c0a 100644 --- a/reference/mongodb/mongodb/driver/clientencryption/deletekey.xml +++ b/reference/mongodb/mongodb/driver/clientencryption/deletekey.xml @@ -46,7 +46,7 @@ &reftitle.errors; &mongodb.throws.std; - Throws MongoDB\Driver\Exception\RuntimeException on other errors. + Throws MongoDB\Driver\Exception\RuntimeException on other errors.     diff --git a/reference/mongodb/mongodb/driver/clientencryption/encrypt.xml b/reference/mongodb/mongodb/driver/clientencryption/encrypt.xml index af39a7e2b..ae4a466bf 100644 --- a/reference/mongodb/mongodb/driver/clientencryption/encrypt.xml +++ b/reference/mongodb/mongodb/driver/clientencryption/encrypt.xml @@ -47,7 +47,7 @@ &reftitle.errors; &mongodb.throws.argumentparsing; - Throws MongoDB\Driver\Exception\EncryptionException if an error occurs while encrypting the value + Throws MongoDB\Driver\Exception\EncryptionException if an error occurs while encrypting the value diff --git a/reference/mongodb/mongodb/driver/clientencryption/encryptexpression.xml b/reference/mongodb/mongodb/driver/clientencryption/encryptexpression.xml index 284b88462..8231391ed 100644 --- a/reference/mongodb/mongodb/driver/clientencryption/encryptexpression.xml +++ b/reference/mongodb/mongodb/driver/clientencryption/encryptexpression.xml @@ -80,7 +80,7 @@ &reftitle.errors; &mongodb.throws.argumentparsing; - Throws MongoDB\Driver\Exception\EncryptionException if an error occurs while encrypting the expression + Throws MongoDB\Driver\Exception\EncryptionException if an error occurs while encrypting the expression diff --git a/reference/mongodb/mongodb/driver/clientencryption/getkey.xml b/reference/mongodb/mongodb/driver/clientencryption/getkey.xml index 6d6032635..133b1dc4c 100644 --- a/reference/mongodb/mongodb/driver/clientencryption/getkey.xml +++ b/reference/mongodb/mongodb/driver/clientencryption/getkey.xml @@ -45,7 +45,7 @@ &reftitle.errors; &mongodb.throws.std; - Throws MongoDB\Driver\Exception\RuntimeException on other errors. + Throws MongoDB\Driver\Exception\RuntimeException on other errors.     diff --git a/reference/mongodb/mongodb/driver/clientencryption/getkeybyaltname.xml b/reference/mongodb/mongodb/driver/clientencryption/getkeybyaltname.xml index 3fa9f2def..36b2e7bb2 100644 --- a/reference/mongodb/mongodb/driver/clientencryption/getkeybyaltname.xml +++ b/reference/mongodb/mongodb/driver/clientencryption/getkeybyaltname.xml @@ -44,7 +44,7 @@ &reftitle.errors; &mongodb.throws.std; - Throws MongoDB\Driver\Exception\RuntimeException on other errors. + Throws MongoDB\Driver\Exception\RuntimeException on other errors. diff --git a/reference/mongodb/mongodb/driver/clientencryption/getkeys.xml b/reference/mongodb/mongodb/driver/clientencryption/getkeys.xml index db0a84be4..54e3b45aa 100644 --- a/reference/mongodb/mongodb/driver/clientencryption/getkeys.xml +++ b/reference/mongodb/mongodb/driver/clientencryption/getkeys.xml @@ -32,7 +32,7 @@ &reftitle.errors; &mongodb.throws.std; - Throws MongoDB\Driver\Exception\RuntimeException on other errors. + Throws MongoDB\Driver\Exception\RuntimeException on other errors. diff --git a/reference/mongodb/mongodb/driver/clientencryption/removekeyaltname.xml b/reference/mongodb/mongodb/driver/clientencryption/removekeyaltname.xml index 25f59ed16..6997f8c76 100644 --- a/reference/mongodb/mongodb/driver/clientencryption/removekeyaltname.xml +++ b/reference/mongodb/mongodb/driver/clientencryption/removekeyaltname.xml @@ -56,7 +56,7 @@ &reftitle.errors; &mongodb.throws.std; - Throws MongoDB\Driver\Exception\RuntimeException on other errors. + Throws MongoDB\Driver\Exception\RuntimeException on other errors. diff --git a/reference/mongodb/mongodb/driver/clientencryption/rewrapmanydatakey.xml b/reference/mongodb/mongodb/driver/clientencryption/rewrapmanydatakey.xml index 66e7b9036..62a5614cf 100644 --- a/reference/mongodb/mongodb/driver/clientencryption/rewrapmanydatakey.xml +++ b/reference/mongodb/mongodb/driver/clientencryption/rewrapmanydatakey.xml @@ -98,8 +98,8 @@ &reftitle.errors; &mongodb.throws.std; - Throws MongoDB\Driver\Exception\EncryptionException if an error occurs while decrypting or re-encrypting a data key. - Throws MongoDB\Driver\Exception\RuntimeException on other errors. + Throws MongoDB\Driver\Exception\EncryptionException if an error occurs while decrypting or re-encrypting a data key. + Throws MongoDB\Driver\Exception\RuntimeException on other errors. diff --git a/reference/mongodb/mongodb/driver/cursor.xml b/reference/mongodb/mongodb/driver/cursor.xml index 96ee97180..f5fa0900a 100644 --- a/reference/mongodb/mongodb/driver/cursor.xml +++ b/reference/mongodb/mongodb/driver/cursor.xml @@ -276,7 +276,7 @@ while (true) { Throws - MongoDB\Driver\Exception\InvalidArgumentException if + MongoDB\Driver\Exception\InvalidArgumentException if a class in the type map cannot be instantiated or does not implement MongoDB\BSON\Unserializable. diff --git a/reference/mongodb/mongodb/driver/cursor/rewind.xml b/reference/mongodb/mongodb/driver/cursor/rewind.xml index 548d1ec8e..30d6a7e1b 100644 --- a/reference/mongodb/mongodb/driver/cursor/rewind.xml +++ b/reference/mongodb/mongodb/driver/cursor/rewind.xml @@ -35,7 +35,7 @@ &reftitle.errors; &mongodb.throws.std; - Throws MongoDB\Driver\Exception\LogicException if this method is called after the cursor has advanced beyond its first position. + Throws MongoDB\Driver\Exception\LogicException if this method is called after the cursor has advanced beyond its first position. diff --git a/reference/mongodb/mongodb/driver/cursor/settypemap.xml b/reference/mongodb/mongodb/driver/cursor/settypemap.xml index 2d74b8fad..33aac3419 100644 --- a/reference/mongodb/mongodb/driver/cursor/settypemap.xml +++ b/reference/mongodb/mongodb/driver/cursor/settypemap.xml @@ -45,7 +45,7 @@ Throws - MongoDB\Driver\Exception\InvalidArgumentException if + MongoDB\Driver\Exception\InvalidArgumentException if a class in the type map cannot be instantiated or does not implement MongoDB\BSON\Unserializable. diff --git a/reference/mongodb/mongodb/driver/exception/bulkwritecommandexception.xml b/reference/mongodb/mongodb/driver/exception/bulkwritecommandexception.xml index cc34384f2..c94d7c586 100644 --- a/reference/mongodb/mongodb/driver/exception/bulkwritecommandexception.xml +++ b/reference/mongodb/mongodb/driver/exception/bulkwritecommandexception.xml @@ -114,7 +114,7 @@ writeConcernErrors - An array of any MongoDB\Driver\WriteConcernErrors + An array of any MongoDB\Driver\WriteConcernErrors that occurred while executing the bulk write. This list may have multiple items if more than one server command was required to execute the bulk write. @@ -125,7 +125,7 @@ writeErrors - An array of any MongoDB\Driver\WriteErrors + An array of any MongoDB\Driver\WriteErrors that occurred during the execution of individual write operations. Array keys will correspond to the index of the write operation from MongoDB\Driver\BulkWriteCommand. This map will diff --git a/reference/mongodb/mongodb/driver/exception/bulkwritecommandexception/getwriteconcernerrors.xml b/reference/mongodb/mongodb/driver/exception/bulkwritecommandexception/getwriteconcernerrors.xml index b8198261d..8262737ae 100644 --- a/reference/mongodb/mongodb/driver/exception/bulkwritecommandexception/getwriteconcernerrors.xml +++ b/reference/mongodb/mongodb/driver/exception/bulkwritecommandexception/getwriteconcernerrors.xml @@ -25,7 +25,7 @@ &reftitle.returnvalues; - An array of any MongoDB\Driver\WriteConcernErrors + An array of any MongoDB\Driver\WriteConcernErrors that occurred while executing the bulk write. This list may have multiple items if more than one server command was required to execute the bulk write. @@ -90,7 +90,7 @@ array(1) { MongoDB\Driver\Manager::executeBulkWriteCommand MongoDB\Driver\WriteConcern - MongoDB\Driver\WriteConcernError + MongoDB\Driver\WriteConcernError diff --git a/reference/mongodb/mongodb/driver/exception/bulkwritecommandexception/getwriteerrors.xml b/reference/mongodb/mongodb/driver/exception/bulkwritecommandexception/getwriteerrors.xml index 1d80e52c5..302c69cfb 100644 --- a/reference/mongodb/mongodb/driver/exception/bulkwritecommandexception/getwriteerrors.xml +++ b/reference/mongodb/mongodb/driver/exception/bulkwritecommandexception/getwriteerrors.xml @@ -25,7 +25,7 @@ &reftitle.returnvalues; - An array of any MongoDB\Driver\WriteErrors that + An array of any MongoDB\Driver\WriteErrors that occurred during the execution of individual write operations. Array keys will correspond to the index of the write operation from MongoDB\Driver\BulkWriteCommand. This map will @@ -96,7 +96,7 @@ array(2) { &reftitle.seealso; MongoDB\Driver\Manager::executeBulkWriteCommand - MongoDB\Driver\WriteError + MongoDB\Driver\WriteError diff --git a/reference/mongodb/mongodb/driver/exception/bulkwriteexception.xml b/reference/mongodb/mongodb/driver/exception/bulkwriteexception.xml index c6b8f08ca..a99ae7c41 100644 --- a/reference/mongodb/mongodb/driver/exception/bulkwriteexception.xml +++ b/reference/mongodb/mongodb/driver/exception/bulkwriteexception.xml @@ -108,9 +108,9 @@ This class now extends - MongoDB\Driver\Exception\ServerException + MongoDB\Driver\Exception\ServerException instead of - MongoDB\Driver\Exception\WriteException. + MongoDB\Driver\Exception\WriteException. diff --git a/reference/mongodb/mongodb/driver/exception/executiontimeoutexception.xml b/reference/mongodb/mongodb/driver/exception/executiontimeoutexception.xml index 37539dc8b..442343393 100644 --- a/reference/mongodb/mongodb/driver/exception/executiontimeoutexception.xml +++ b/reference/mongodb/mongodb/driver/exception/executiontimeoutexception.xml @@ -76,9 +76,9 @@ This class now extends - MongoDB\Driver\Exception\ServerException + MongoDB\Driver\Exception\ServerException instead of - MongoDB\Driver\Exception\RuntimeException. + MongoDB\Driver\Exception\RuntimeException. diff --git a/reference/mongodb/mongodb/driver/exception/sslconnectionexception.xml b/reference/mongodb/mongodb/driver/exception/sslconnectionexception.xml index 3c275913d..1474d44f3 100644 --- a/reference/mongodb/mongodb/driver/exception/sslconnectionexception.xml +++ b/reference/mongodb/mongodb/driver/exception/sslconnectionexception.xml @@ -13,7 +13,7 @@ This exception class is DEPRECATED as of extension version 1.5.0 and was removed in 2.0. This exception was never thrown by the extension. Applications should use - MongoDB\Driver\Exception\ConnectionException instead. + MongoDB\Driver\Exception\ConnectionException instead. diff --git a/reference/mongodb/mongodb/driver/exception/writeexception.xml b/reference/mongodb/mongodb/driver/exception/writeexception.xml index b8b0b4345..64254617c 100644 --- a/reference/mongodb/mongodb/driver/exception/writeexception.xml +++ b/reference/mongodb/mongodb/driver/exception/writeexception.xml @@ -13,7 +13,7 @@ This exception class is DEPRECATED as of extension version 1.20.0 and was removed in 2.0. This exception was never directly thrown by the extension. Applications should use - MongoDB\Driver\Exception\BulkWriteException instead. + MongoDB\Driver\Exception\BulkWriteException instead. @@ -119,9 +119,9 @@ This class now extends - MongoDB\Driver\Exception\ServerException + MongoDB\Driver\Exception\ServerException instead of - MongoDB\Driver\Exception\RuntimeException. + MongoDB\Driver\Exception\RuntimeException. diff --git a/reference/mongodb/mongodb/driver/manager/addsubscriber.xml b/reference/mongodb/mongodb/driver/manager/addsubscriber.xml index 90e3772f3..8876b649c 100644 --- a/reference/mongodb/mongodb/driver/manager/addsubscriber.xml +++ b/reference/mongodb/mongodb/driver/manager/addsubscriber.xml @@ -54,7 +54,7 @@ &mongodb.throws.argumentparsing; Throws - MongoDB\Driver\Exception\InvalidArgumentException if + MongoDB\Driver\Exception\InvalidArgumentException if subscriber is a MongoDB\Driver\Monitoring\LogSubscriber, since loggers can only be registered globally. diff --git a/reference/mongodb/mongodb/driver/manager/construct.xml b/reference/mongodb/mongodb/driver/manager/construct.xml index 7779dbb22..8856e570b 100644 --- a/reference/mongodb/mongodb/driver/manager/construct.xml +++ b/reference/mongodb/mongodb/driver/manager/construct.xml @@ -891,7 +891,7 @@ mongodb://[username:password@]host1[:port1][,host2[:port2],...[,hostN[:portN]]][ &reftitle.errors; &mongodb.throws.argumentparsing; - Throws MongoDB\Driver\Exception\RuntimeException if the uri format is invalid + Throws MongoDB\Driver\Exception\RuntimeException if the uri format is invalid diff --git a/reference/mongodb/mongodb/driver/manager/createclientencryption.xml b/reference/mongodb/mongodb/driver/manager/createclientencryption.xml index 641d47370..f70b11fd2 100644 --- a/reference/mongodb/mongodb/driver/manager/createclientencryption.xml +++ b/reference/mongodb/mongodb/driver/manager/createclientencryption.xml @@ -60,7 +60,7 @@ &reftitle.errors; &mongodb.throws.argumentparsing; - Throws MongoDB\Driver\Exception\RuntimeException if the extension was compiled without libmongocrypt support + Throws MongoDB\Driver\Exception\RuntimeException if the extension was compiled without libmongocrypt support diff --git a/reference/mongodb/mongodb/driver/manager/executebulkwrite.xml b/reference/mongodb/mongodb/driver/manager/executebulkwrite.xml index e41371889..60d0b96a4 100644 --- a/reference/mongodb/mongodb/driver/manager/executebulkwrite.xml +++ b/reference/mongodb/mongodb/driver/manager/executebulkwrite.xml @@ -71,12 +71,12 @@ &reftitle.errors; - Throws MongoDB\Driver\Exception\InvalidArgumentException if bulk does not contain any write operations. - Throws MongoDB\Driver\Exception\InvalidArgumentException if bulk has already been executed. MongoDB\Driver\BulkWrite objects may not be executed multiple times. + Throws MongoDB\Driver\Exception\InvalidArgumentException if bulk does not contain any write operations. + Throws MongoDB\Driver\Exception\InvalidArgumentException if bulk has already been executed. MongoDB\Driver\BulkWrite objects may not be executed multiple times. &mongodb.throws.session-unacknowledged; &mongodb.throws.std; &mongodb.throws.bulkwriteexception; - Throws MongoDB\Driver\Exception\RuntimeException on other errors. + Throws MongoDB\Driver\Exception\RuntimeException on other errors. @@ -108,7 +108,7 @@ PECL mongodb 1.4.4 - MongoDB\Driver\Exception\InvalidArgumentException + MongoDB\Driver\Exception\InvalidArgumentException will be thrown if the "session" option is used in combination with an unacknowledged write concern. @@ -124,10 +124,10 @@ PECL mongodb 1.3.0 - MongoDB\Driver\Exception\InvalidArgumentException + MongoDB\Driver\Exception\InvalidArgumentException is now thrown if bulk does not contain any write operations. Previously, a - MongoDB\Driver\Exception\BulkWriteException was + MongoDB\Driver\Exception\BulkWriteException was thrown. diff --git a/reference/mongodb/mongodb/driver/manager/executebulkwritecommand.xml b/reference/mongodb/mongodb/driver/manager/executebulkwritecommand.xml index 5a1f13816..be05a9b42 100644 --- a/reference/mongodb/mongodb/driver/manager/executebulkwritecommand.xml +++ b/reference/mongodb/mongodb/driver/manager/executebulkwritecommand.xml @@ -70,12 +70,12 @@ &reftitle.errors; - Throws MongoDB\Driver\Exception\InvalidArgumentException if bulk does not contain any write operations. - Throws MongoDB\Driver\Exception\InvalidArgumentException if bulk has already been executed. MongoDB\Driver\BulkWriteCommand objects may not be executed multiple times. + Throws MongoDB\Driver\Exception\InvalidArgumentException if bulk does not contain any write operations. + Throws MongoDB\Driver\Exception\InvalidArgumentException if bulk has already been executed. MongoDB\Driver\BulkWriteCommand objects may not be executed multiple times. &mongodb.throws.session-unacknowledged; &mongodb.throws.std; &mongodb.throws.bulkwritecommandexception; - Throws MongoDB\Driver\Exception\RuntimeException on other errors. + Throws MongoDB\Driver\Exception\RuntimeException on other errors. diff --git a/reference/mongodb/mongodb/driver/manager/executecommand.xml b/reference/mongodb/mongodb/driver/manager/executecommand.xml index 941fa4eb8..669596b5a 100644 --- a/reference/mongodb/mongodb/driver/manager/executecommand.xml +++ b/reference/mongodb/mongodb/driver/manager/executecommand.xml @@ -80,7 +80,7 @@ &mongodb.throws.session-readwriteconcern; &mongodb.throws.session-unacknowledged; &mongodb.throws.std; - Throws MongoDB\Driver\Exception\RuntimeException on other errors (e.g. invalid command, issuing a write command to a secondary). + Throws MongoDB\Driver\Exception\RuntimeException on other errors (e.g. invalid command, issuing a write command to a secondary). @@ -112,7 +112,7 @@ PECL mongodb 1.4.4 - MongoDB\Driver\Exception\InvalidArgumentException + MongoDB\Driver\Exception\InvalidArgumentException will be thrown if the "session" option is used in combination with an unacknowledged write concern. @@ -252,7 +252,7 @@ var_dump($cursor->toArray()[0]); If the command fails to complete after one second of execution time on the server, a - MongoDB\Driver\Exception\ExecutionTimeoutException + MongoDB\Driver\Exception\ExecutionTimeoutException will be thrown. diff --git a/reference/mongodb/mongodb/driver/manager/executequery.xml b/reference/mongodb/mongodb/driver/manager/executequery.xml index b0287a246..e562599d3 100644 --- a/reference/mongodb/mongodb/driver/manager/executequery.xml +++ b/reference/mongodb/mongodb/driver/manager/executequery.xml @@ -67,7 +67,7 @@ &reftitle.errors; &mongodb.throws.std; - Throws MongoDB\Driver\Exception\RuntimeException on other errors (e.g. invalid query operators). + Throws MongoDB\Driver\Exception\RuntimeException on other errors (e.g. invalid query operators). @@ -190,7 +190,7 @@ foreach ($cursor as $document) { If the query fails to complete after one second of execution time on the server, a - MongoDB\Driver\Exception\ExecutionTimeoutException + MongoDB\Driver\Exception\ExecutionTimeoutException will be thrown. diff --git a/reference/mongodb/mongodb/driver/manager/executereadcommand.xml b/reference/mongodb/mongodb/driver/manager/executereadcommand.xml index da1922943..8f659eeab 100644 --- a/reference/mongodb/mongodb/driver/manager/executereadcommand.xml +++ b/reference/mongodb/mongodb/driver/manager/executereadcommand.xml @@ -72,7 +72,7 @@ &mongodb.throws.session-readwriteconcern; &mongodb.throws.std; - Throws MongoDB\Driver\Exception\RuntimeException on other errors (e.g. invalid command). + Throws MongoDB\Driver\Exception\RuntimeException on other errors (e.g. invalid command). diff --git a/reference/mongodb/mongodb/driver/manager/executereadwritecommand.xml b/reference/mongodb/mongodb/driver/manager/executereadwritecommand.xml index b335d0bae..e76fcc6a7 100644 --- a/reference/mongodb/mongodb/driver/manager/executereadwritecommand.xml +++ b/reference/mongodb/mongodb/driver/manager/executereadwritecommand.xml @@ -72,7 +72,7 @@ &mongodb.throws.session-readwriteconcern; &mongodb.throws.session-unacknowledged; &mongodb.throws.std; - Throws MongoDB\Driver\Exception\RuntimeException on other errors (e.g. invalid command). + Throws MongoDB\Driver\Exception\RuntimeException on other errors (e.g. invalid command). @@ -90,7 +90,7 @@ PECL mongodb 1.4.4 - MongoDB\Driver\Exception\InvalidArgumentException + MongoDB\Driver\Exception\InvalidArgumentException will be thrown if the "session" option is used in combination with an unacknowledged write concern. diff --git a/reference/mongodb/mongodb/driver/manager/executewritecommand.xml b/reference/mongodb/mongodb/driver/manager/executewritecommand.xml index a7ddec1ab..5980ba064 100644 --- a/reference/mongodb/mongodb/driver/manager/executewritecommand.xml +++ b/reference/mongodb/mongodb/driver/manager/executewritecommand.xml @@ -82,7 +82,7 @@ &mongodb.throws.session-readwriteconcern; &mongodb.throws.session-unacknowledged; &mongodb.throws.std; - Throws MongoDB\Driver\Exception\RuntimeException on other errors (e.g. invalid command). + Throws MongoDB\Driver\Exception\RuntimeException on other errors (e.g. invalid command). @@ -100,7 +100,7 @@ PECL mongodb 1.4.4 - MongoDB\Driver\Exception\InvalidArgumentException + MongoDB\Driver\Exception\InvalidArgumentException will be thrown if the "session" option is used in combination with an unacknowledged write concern. diff --git a/reference/mongodb/mongodb/driver/manager/selectserver.xml b/reference/mongodb/mongodb/driver/manager/selectserver.xml index 7110a4cf5..a1f2a8c91 100644 --- a/reference/mongodb/mongodb/driver/manager/selectserver.xml +++ b/reference/mongodb/mongodb/driver/manager/selectserver.xml @@ -58,7 +58,7 @@ &reftitle.errors; &mongodb.throws.std; - Throws MongoDB\Driver\Exception\RuntimeException if a server matching the read preference could not be found. + Throws MongoDB\Driver\Exception\RuntimeException if a server matching the read preference could not be found. diff --git a/reference/mongodb/mongodb/driver/manager/startsession.xml b/reference/mongodb/mongodb/driver/manager/startsession.xml index 3f528d8e1..c65be8a62 100644 --- a/reference/mongodb/mongodb/driver/manager/startsession.xml +++ b/reference/mongodb/mongodb/driver/manager/startsession.xml @@ -144,8 +144,8 @@ &reftitle.errors; &mongodb.throws.argumentparsing; - Throws MongoDB\Driver\Exception\InvalidArgumentException if the "causalConsistency" and "snapshot" options are both &true;. - Throws MongoDB\Driver\Exception\RuntimeException if the session could not be created (e.g. libmongoc does not support crypto). + Throws MongoDB\Driver\Exception\InvalidArgumentException if the "causalConsistency" and "snapshot" options are both &true;. + Throws MongoDB\Driver\Exception\RuntimeException if the session could not be created (e.g. libmongoc does not support crypto). diff --git a/reference/mongodb/mongodb/driver/monitoring/commandfailedevent/geterror.xml b/reference/mongodb/mongodb/driver/monitoring/commandfailedevent/geterror.xml index 8560a208a..ccdda6f45 100644 --- a/reference/mongodb/mongodb/driver/monitoring/commandfailedevent/geterror.xml +++ b/reference/mongodb/mongodb/driver/monitoring/commandfailedevent/geterror.xml @@ -23,7 +23,7 @@ &reftitle.returnvalues; - Returns the Exception associated with the failed command. + Returns the Exception associated with the failed command. diff --git a/reference/mongodb/mongodb/driver/monitoring/serverheartbeatfailedevent/geterror.xml b/reference/mongodb/mongodb/driver/monitoring/serverheartbeatfailedevent/geterror.xml index c32abbb6c..01626dca7 100644 --- a/reference/mongodb/mongodb/driver/monitoring/serverheartbeatfailedevent/geterror.xml +++ b/reference/mongodb/mongodb/driver/monitoring/serverheartbeatfailedevent/geterror.xml @@ -23,7 +23,7 @@ &reftitle.returnvalues; - Returns the Exception associated with the failed + Returns the Exception associated with the failed heartbeat. diff --git a/reference/mongodb/mongodb/driver/readpreference/construct.xml b/reference/mongodb/mongodb/driver/readpreference/construct.xml index 59a3d2fe0..e85c5fd5b 100644 --- a/reference/mongodb/mongodb/driver/readpreference/construct.xml +++ b/reference/mongodb/mongodb/driver/readpreference/construct.xml @@ -183,9 +183,9 @@ &reftitle.errors; &mongodb.throws.argumentparsing; - Throws MongoDB\Driver\Exception\InvalidArgumentException if mode is invalid. - Throws MongoDB\Driver\Exception\InvalidArgumentException if tagSets is provided for a primary read preference or is malformed (i.e. not an array of zero or more documents). - Throws MongoDB\Driver\Exception\InvalidArgumentException if the "maxStalenessSeconds" option is provided for a primary read preference or is out of range. + Throws MongoDB\Driver\Exception\InvalidArgumentException if mode is invalid. + Throws MongoDB\Driver\Exception\InvalidArgumentException if tagSets is provided for a primary read preference or is malformed (i.e. not an array of zero or more documents). + Throws MongoDB\Driver\Exception\InvalidArgumentException if the "maxStalenessSeconds" option is provided for a primary read preference or is out of range. diff --git a/reference/mongodb/mongodb/driver/server/executebulkwrite.xml b/reference/mongodb/mongodb/driver/server/executebulkwrite.xml index 05ed61f5b..6958d010b 100644 --- a/reference/mongodb/mongodb/driver/server/executebulkwrite.xml +++ b/reference/mongodb/mongodb/driver/server/executebulkwrite.xml @@ -71,12 +71,12 @@ &reftitle.errors; - Throws MongoDB\Driver\Exception\InvalidArgumentException if bulk does not contain any write operations. - Throws MongoDB\Driver\Exception\InvalidArgumentException if bulk has already been executed. MongoDB\Driver\BulkWrite objects may not be executed multiple times. + Throws MongoDB\Driver\Exception\InvalidArgumentException if bulk does not contain any write operations. + Throws MongoDB\Driver\Exception\InvalidArgumentException if bulk has already been executed. MongoDB\Driver\BulkWrite objects may not be executed multiple times. &mongodb.throws.session-unacknowledged; &mongodb.throws.std; &mongodb.throws.bulkwriteexception; - Throws MongoDB\Driver\Exception\RuntimeException on other errors. + Throws MongoDB\Driver\Exception\RuntimeException on other errors. @@ -108,7 +108,7 @@ PECL mongodb 1.4.4 - MongoDB\Driver\Exception\InvalidArgumentException + MongoDB\Driver\Exception\InvalidArgumentException will be thrown if the "session" option is used in combination with an unacknowledged write concern. @@ -124,10 +124,10 @@ PECL mongodb 1.3.0 - MongoDB\Driver\Exception\InvalidArgumentException + MongoDB\Driver\Exception\InvalidArgumentException is now thrown if bulk does not contain any write operations. Previously, a - MongoDB\Driver\Exception\BulkWriteException was + MongoDB\Driver\Exception\BulkWriteException was thrown. diff --git a/reference/mongodb/mongodb/driver/server/executebulkwritecommand.xml b/reference/mongodb/mongodb/driver/server/executebulkwritecommand.xml index bef524c3a..660199a3d 100644 --- a/reference/mongodb/mongodb/driver/server/executebulkwritecommand.xml +++ b/reference/mongodb/mongodb/driver/server/executebulkwritecommand.xml @@ -70,12 +70,12 @@ &reftitle.errors; - Throws MongoDB\Driver\Exception\InvalidArgumentException if bulk does not contain any write operations. - Throws MongoDB\Driver\Exception\InvalidArgumentException if bulk has already been executed. MongoDB\Driver\BulkWriteCommand objects may not be executed multiple times. + Throws MongoDB\Driver\Exception\InvalidArgumentException if bulk does not contain any write operations. + Throws MongoDB\Driver\Exception\InvalidArgumentException if bulk has already been executed. MongoDB\Driver\BulkWriteCommand objects may not be executed multiple times. &mongodb.throws.session-unacknowledged; &mongodb.throws.std; &mongodb.throws.bulkwritecommandexception; - Throws MongoDB\Driver\Exception\RuntimeException on other errors. + Throws MongoDB\Driver\Exception\RuntimeException on other errors. diff --git a/reference/mongodb/mongodb/driver/server/executecommand.xml b/reference/mongodb/mongodb/driver/server/executecommand.xml index 8bd725182..9fb9a9748 100644 --- a/reference/mongodb/mongodb/driver/server/executecommand.xml +++ b/reference/mongodb/mongodb/driver/server/executecommand.xml @@ -80,7 +80,7 @@ &mongodb.throws.session-readwriteconcern; &mongodb.throws.session-unacknowledged; &mongodb.throws.std; - Throws MongoDB\Driver\Exception\RuntimeException on other errors (e.g. invalid command, issuing a write command to a secondary). + Throws MongoDB\Driver\Exception\RuntimeException on other errors (e.g. invalid command, issuing a write command to a secondary). @@ -112,7 +112,7 @@ PECL mongodb 1.4.4 - MongoDB\Driver\Exception\InvalidArgumentException + MongoDB\Driver\Exception\InvalidArgumentException will be thrown if the "session" option is used in combination with an unacknowledged write concern. diff --git a/reference/mongodb/mongodb/driver/server/executequery.xml b/reference/mongodb/mongodb/driver/server/executequery.xml index 24014368b..095d85044 100644 --- a/reference/mongodb/mongodb/driver/server/executequery.xml +++ b/reference/mongodb/mongodb/driver/server/executequery.xml @@ -67,7 +67,7 @@ &reftitle.errors; &mongodb.throws.std; - Throws MongoDB\Driver\Exception\RuntimeException on other errors (e.g. invalid query operators). + Throws MongoDB\Driver\Exception\RuntimeException on other errors (e.g. invalid query operators). diff --git a/reference/mongodb/mongodb/driver/server/executereadcommand.xml b/reference/mongodb/mongodb/driver/server/executereadcommand.xml index 667c3a119..695c55aba 100644 --- a/reference/mongodb/mongodb/driver/server/executereadcommand.xml +++ b/reference/mongodb/mongodb/driver/server/executereadcommand.xml @@ -73,7 +73,7 @@ &mongodb.throws.session-readwriteconcern; &mongodb.throws.std; - Throws MongoDB\Driver\Exception\RuntimeException on other errors (e.g. invalid command). + Throws MongoDB\Driver\Exception\RuntimeException on other errors (e.g. invalid command). diff --git a/reference/mongodb/mongodb/driver/server/executereadwritecommand.xml b/reference/mongodb/mongodb/driver/server/executereadwritecommand.xml index dfa143c74..b125d9f88 100644 --- a/reference/mongodb/mongodb/driver/server/executereadwritecommand.xml +++ b/reference/mongodb/mongodb/driver/server/executereadwritecommand.xml @@ -72,7 +72,7 @@ &mongodb.throws.session-readwriteconcern; &mongodb.throws.session-unacknowledged; &mongodb.throws.std; - Throws MongoDB\Driver\Exception\RuntimeException on other errors (e.g. invalid command). + Throws MongoDB\Driver\Exception\RuntimeException on other errors (e.g. invalid command). @@ -90,7 +90,7 @@ PECL mongodb 1.4.4 - MongoDB\Driver\Exception\InvalidArgumentException + MongoDB\Driver\Exception\InvalidArgumentException will be thrown if the "session" option is used in combination with an unacknowledged write concern. diff --git a/reference/mongodb/mongodb/driver/server/executewritecommand.xml b/reference/mongodb/mongodb/driver/server/executewritecommand.xml index ad5e6e25d..4da4af5f3 100644 --- a/reference/mongodb/mongodb/driver/server/executewritecommand.xml +++ b/reference/mongodb/mongodb/driver/server/executewritecommand.xml @@ -82,7 +82,7 @@ &mongodb.throws.session-readwriteconcern; &mongodb.throws.session-unacknowledged; &mongodb.throws.std; - Throws MongoDB\Driver\Exception\RuntimeException on other errors (e.g. invalid command). + Throws MongoDB\Driver\Exception\RuntimeException on other errors (e.g. invalid command). @@ -100,7 +100,7 @@ PECL mongodb 1.4.4 - MongoDB\Driver\Exception\InvalidArgumentException + MongoDB\Driver\Exception\InvalidArgumentException will be thrown if the "session" option is used in combination with an unacknowledged write concern. diff --git a/reference/mongodb/mongodb/driver/session/aborttransaction.xml b/reference/mongodb/mongodb/driver/session/aborttransaction.xml index cb03deca2..15cb2bb5b 100644 --- a/reference/mongodb/mongodb/driver/session/aborttransaction.xml +++ b/reference/mongodb/mongodb/driver/session/aborttransaction.xml @@ -36,7 +36,7 @@ &reftitle.errors; &mongodb.throws.argumentparsing; - Throws MongoDB\Driver\Exception\RuntimeException if the transaction could not be aborted (e.g. a transaction was not started). + Throws MongoDB\Driver\Exception\RuntimeException if the transaction could not be aborted (e.g. a transaction was not started). diff --git a/reference/mongodb/mongodb/driver/session/committransaction.xml b/reference/mongodb/mongodb/driver/session/committransaction.xml index 24770db07..e1c423335 100644 --- a/reference/mongodb/mongodb/driver/session/committransaction.xml +++ b/reference/mongodb/mongodb/driver/session/committransaction.xml @@ -37,7 +37,7 @@ &mongodb.throws.argumentparsing; Throws - MongoDB\Driver\Exception\CommandException if the + MongoDB\Driver\Exception\CommandException if the server could not commit the transaction (e.g. due to conflicts, network issues). In case the exception's MongoDB\Driver\Exception\CommandException::getResultDocument @@ -49,7 +49,7 @@ MongoDB\Driver\Exception\RuntimeException::hasErrorLabel should be used to test for this situation instead. Throws - MongoDB\Driver\Exception\RuntimeException if the + MongoDB\Driver\Exception\RuntimeException if the transaction could not be committed (e.g. a transaction was not started). diff --git a/reference/mongodb/mongodb/driver/session/starttransaction.xml b/reference/mongodb/mongodb/driver/session/starttransaction.xml index 01f953196..e3cff0479 100644 --- a/reference/mongodb/mongodb/driver/session/starttransaction.xml +++ b/reference/mongodb/mongodb/driver/session/starttransaction.xml @@ -81,8 +81,8 @@ &reftitle.errors; &mongodb.throws.argumentparsing; - Throws MongoDB\Driver\Exception\CommandException if the transaction could not be started because of a server-side problem (e.g. a lock could not be obtained). - Throws MongoDB\Driver\Exception\RuntimeException if the transaction could not be started (e.g. a transaction was already started). + Throws MongoDB\Driver\Exception\CommandException if the transaction could not be started because of a server-side problem (e.g. a lock could not be obtained). + Throws MongoDB\Driver\Exception\RuntimeException if the transaction could not be started (e.g. a transaction was already started). diff --git a/reference/mongodb/mongodb/driver/writeconcern/construct.xml b/reference/mongodb/mongodb/driver/writeconcern/construct.xml index 19c0c04ae..e58398fd9 100644 --- a/reference/mongodb/mongodb/driver/writeconcern/construct.xml +++ b/reference/mongodb/mongodb/driver/writeconcern/construct.xml @@ -98,7 +98,7 @@ wtimeout causes write operations to return with an - error (WriteConcernError) after the specified + error (WriteConcernError) after the specified limit, even if the required write concern will eventually succeed. When these write operations return, MongoDB does not undo successful data modifications performed before the write concern exceeded the @@ -150,7 +150,7 @@ &reftitle.errors; &mongodb.throws.argumentparsing; - Throws MongoDB\Driver\Exception\InvalidArgumentException if w is invalid or wtimeout is either negative or greater than the bounds of a signed 32-bit integer. + Throws MongoDB\Driver\Exception\InvalidArgumentException if w is invalid or wtimeout is either negative or greater than the bounds of a signed 32-bit integer. diff --git a/reference/mongodb/mongodb/driver/writeconcernerror.xml b/reference/mongodb/mongodb/driver/writeconcernerror.xml index f6f853355..910c7eead 100644 --- a/reference/mongodb/mongodb/driver/writeconcernerror.xml +++ b/reference/mongodb/mongodb/driver/writeconcernerror.xml @@ -12,7 +12,7 @@
    &reftitle.intro; - The MongoDB\Driver\WriteConcernError class + The MongoDB\Driver\WriteConcernError class encapsulates information about a write concern error and may be returned by MongoDB\Driver\WriteResult::getWriteConcernError. diff --git a/reference/mongodb/mongodb/driver/writeerror.xml b/reference/mongodb/mongodb/driver/writeerror.xml index 9ebcef865..fc43bb5b2 100644 --- a/reference/mongodb/mongodb/driver/writeerror.xml +++ b/reference/mongodb/mongodb/driver/writeerror.xml @@ -12,7 +12,7 @@
    &reftitle.intro; - The MongoDB\Driver\WriteError class encapsulates + The MongoDB\Driver\WriteError class encapsulates information about a write error and may be returned as an array element from MongoDB\Driver\WriteResult::getWriteErrors. diff --git a/reference/mongodb/mongodb/driver/writeresult.xml b/reference/mongodb/mongodb/driver/writeresult.xml index e14aee3a9..0451e12c7 100644 --- a/reference/mongodb/mongodb/driver/writeresult.xml +++ b/reference/mongodb/mongodb/driver/writeresult.xml @@ -184,7 +184,7 @@ writeErrors - An array of MongoDB\Driver\WriteErrors for any + An array of MongoDB\Driver\WriteErrors for any write errors that occurred during execution. @@ -193,7 +193,7 @@ writeConcernError - The MongoDB\Driver\WriteConcernError that + The MongoDB\Driver\WriteConcernError that occurred, or &null; if no write concern error occurred. diff --git a/reference/mongodb/mongodb/driver/writeresult/getwriteconcernerror.xml b/reference/mongodb/mongodb/driver/writeresult/getwriteconcernerror.xml index a0968a7c5..c549d15c9 100644 --- a/reference/mongodb/mongodb/driver/writeresult/getwriteconcernerror.xml +++ b/reference/mongodb/mongodb/driver/writeresult/getwriteconcernerror.xml @@ -27,7 +27,7 @@ &reftitle.returnvalues; - Returns a MongoDB\Driver\WriteConcernError if a write + Returns a MongoDB\Driver\WriteConcernError if a write concern error was encountered during the write operation, and &null; otherwise. diff --git a/reference/mongodb/mongodb/driver/writeresult/getwriteerrors.xml b/reference/mongodb/mongodb/driver/writeresult/getwriteerrors.xml index e0d7055c8..9d5d6aa9e 100644 --- a/reference/mongodb/mongodb/driver/writeresult/getwriteerrors.xml +++ b/reference/mongodb/mongodb/driver/writeresult/getwriteerrors.xml @@ -27,7 +27,7 @@ &reftitle.returnvalues; - Returns an array of MongoDB\Driver\WriteError objects + Returns an array of MongoDB\Driver\WriteError objects for any write errors encountered during the write operation. The array will be empty if no write errors occurred. @@ -154,7 +154,7 @@ array(2) { &reftitle.seealso; - MongoDB\Driver\WriteError + MongoDB\Driver\WriteError diff --git a/reference/mqseries/book.xml b/reference/mqseries/book.xml index 7de924e71..8d1f5c5a0 100644 --- a/reference/mqseries/book.xml +++ b/reference/mqseries/book.xml @@ -1,7 +1,7 @@ - + mqseries diff --git a/reference/mqseries/configure.xml b/reference/mqseries/configure.xml index 788981909..fd4652ccf 100644 --- a/reference/mqseries/configure.xml +++ b/reference/mqseries/configure.xml @@ -1,6 +1,6 @@ -
    +
    &reftitle.install; &pecl.moved; diff --git a/reference/mqseries/constants.xml b/reference/mqseries/constants.xml index 5c200aacd..9bc642c4e 100644 --- a/reference/mqseries/constants.xml +++ b/reference/mqseries/constants.xml @@ -1,6 +1,6 @@ - + &reftitle.constants; For each WebSphere MQ Constant there is a mqseries counterpart. diff --git a/reference/mqseries/functions/mqseries-back.xml b/reference/mqseries/functions/mqseries-back.xml index 04c66bed7..e1f0449c1 100644 --- a/reference/mqseries/functions/mqseries-back.xml +++ b/reference/mqseries/functions/mqseries-back.xml @@ -1,6 +1,6 @@ - + mqseries_back MQSeries MQBACK diff --git a/reference/mqseries/functions/mqseries-begin.xml b/reference/mqseries/functions/mqseries-begin.xml index aeb33ab1a..966c1f952 100644 --- a/reference/mqseries/functions/mqseries-begin.xml +++ b/reference/mqseries/functions/mqseries-begin.xml @@ -1,6 +1,6 @@ - + mqseries_begin MQseries MQBEGIN diff --git a/reference/mqseries/functions/mqseries-close.xml b/reference/mqseries/functions/mqseries-close.xml index 2f506711b..8a9b7211c 100644 --- a/reference/mqseries/functions/mqseries-close.xml +++ b/reference/mqseries/functions/mqseries-close.xml @@ -1,6 +1,6 @@ - + mqseries_close MQSeries MQCLOSE diff --git a/reference/mqseries/functions/mqseries-cmit.xml b/reference/mqseries/functions/mqseries-cmit.xml index f507efe06..0c3e65514 100644 --- a/reference/mqseries/functions/mqseries-cmit.xml +++ b/reference/mqseries/functions/mqseries-cmit.xml @@ -1,6 +1,6 @@ - + mqseries_cmit MQSeries MQCMIT diff --git a/reference/mqseries/functions/mqseries-conn.xml b/reference/mqseries/functions/mqseries-conn.xml index f5f7679e2..aeafd6dce 100644 --- a/reference/mqseries/functions/mqseries-conn.xml +++ b/reference/mqseries/functions/mqseries-conn.xml @@ -1,6 +1,6 @@ - + mqseries_conn MQSeries MQCONN diff --git a/reference/mqseries/functions/mqseries-connx.xml b/reference/mqseries/functions/mqseries-connx.xml index 437478999..61e3546ca 100644 --- a/reference/mqseries/functions/mqseries-connx.xml +++ b/reference/mqseries/functions/mqseries-connx.xml @@ -1,6 +1,6 @@ - + mqseries_connx MQSeries MQCONNX diff --git a/reference/mqseries/functions/mqseries-disc.xml b/reference/mqseries/functions/mqseries-disc.xml index e71eec977..fe4d79516 100644 --- a/reference/mqseries/functions/mqseries-disc.xml +++ b/reference/mqseries/functions/mqseries-disc.xml @@ -1,6 +1,6 @@ - + mqseries_disc MQSeries MQDISC diff --git a/reference/mqseries/functions/mqseries-get.xml b/reference/mqseries/functions/mqseries-get.xml index b4ad0fa7c..e4651b421 100644 --- a/reference/mqseries/functions/mqseries-get.xml +++ b/reference/mqseries/functions/mqseries-get.xml @@ -1,6 +1,6 @@ - + mqseries_get MQSeries MQGET diff --git a/reference/mqseries/functions/mqseries-inq.xml b/reference/mqseries/functions/mqseries-inq.xml index 77b9262f6..c244453e3 100644 --- a/reference/mqseries/functions/mqseries-inq.xml +++ b/reference/mqseries/functions/mqseries-inq.xml @@ -1,6 +1,6 @@ - + mqseries_inq MQSeries MQINQ diff --git a/reference/mqseries/functions/mqseries-open.xml b/reference/mqseries/functions/mqseries-open.xml index 1f43c7a59..5f85d6fa8 100644 --- a/reference/mqseries/functions/mqseries-open.xml +++ b/reference/mqseries/functions/mqseries-open.xml @@ -1,6 +1,6 @@ - + mqseries_open MQSeries MQOPEN diff --git a/reference/mqseries/functions/mqseries-put.xml b/reference/mqseries/functions/mqseries-put.xml index 72ee5ca45..0adc23986 100644 --- a/reference/mqseries/functions/mqseries-put.xml +++ b/reference/mqseries/functions/mqseries-put.xml @@ -1,6 +1,6 @@ - + mqseries_put MQSeries MQPUT diff --git a/reference/mqseries/functions/mqseries-put1.xml b/reference/mqseries/functions/mqseries-put1.xml index a6c47f9f5..4b648ce09 100644 --- a/reference/mqseries/functions/mqseries-put1.xml +++ b/reference/mqseries/functions/mqseries-put1.xml @@ -1,6 +1,6 @@ - + mqseries_put1 MQSeries MQPUT1 diff --git a/reference/mqseries/functions/mqseries-set.xml b/reference/mqseries/functions/mqseries-set.xml index a5900ff99..a41a7afb5 100644 --- a/reference/mqseries/functions/mqseries-set.xml +++ b/reference/mqseries/functions/mqseries-set.xml @@ -1,6 +1,6 @@ - + mqseries_set MQSeries MQSET diff --git a/reference/mqseries/functions/mqseries-strerror.xml b/reference/mqseries/functions/mqseries-strerror.xml index 1645acbc5..e780e2f8d 100644 --- a/reference/mqseries/functions/mqseries-strerror.xml +++ b/reference/mqseries/functions/mqseries-strerror.xml @@ -1,6 +1,6 @@ - + mqseries_strerror Returns the error message corresponding to a result code (MQRC) diff --git a/reference/mqseries/resources.xml b/reference/mqseries/resources.xml index 044e02940..da528146b 100644 --- a/reference/mqseries/resources.xml +++ b/reference/mqseries/resources.xml @@ -1,6 +1,6 @@ -
    +
    &reftitle.resources; This extension defines a connection and object_handle resources. diff --git a/reference/mysql/book.xml b/reference/mysql/book.xml index 5d88b44c7..97e6b2a45 100644 --- a/reference/mysql/book.xml +++ b/reference/mysql/book.xml @@ -1,6 +1,6 @@ - + Original MySQL API MySQL (Original) diff --git a/reference/mysql/changelog.xml b/reference/mysql/changelog.xml index ab7a19149..91297daee 100644 --- a/reference/mysql/changelog.xml +++ b/reference/mysql/changelog.xml @@ -1,6 +1,6 @@ - + &ChangelogListingTitle; &ChangelogListingDescription; diff --git a/reference/mysql/configure.xml b/reference/mysql/configure.xml index 511d3b314..7189335f0 100644 --- a/reference/mysql/configure.xml +++ b/reference/mysql/configure.xml @@ -1,6 +1,6 @@ -
    +
    &reftitle.install; diff --git a/reference/mysql/functions/mysql-affected-rows.xml b/reference/mysql/functions/mysql-affected-rows.xml index 6422d41bf..3fbff6cac 100644 --- a/reference/mysql/functions/mysql-affected-rows.xml +++ b/reference/mysql/functions/mysql-affected-rows.xml @@ -1,6 +1,6 @@ - + mysql_affected_rows Get number of affected rows in previous MySQL operation diff --git a/reference/mysql/functions/mysql-client-encoding.xml b/reference/mysql/functions/mysql-client-encoding.xml index 3712a8e55..ee06a3647 100644 --- a/reference/mysql/functions/mysql-client-encoding.xml +++ b/reference/mysql/functions/mysql-client-encoding.xml @@ -1,6 +1,6 @@ - + mysql_client_encoding Returns the name of the character set diff --git a/reference/mysql/functions/mysql-close.xml b/reference/mysql/functions/mysql-close.xml index ac6c74537..955048115 100644 --- a/reference/mysql/functions/mysql-close.xml +++ b/reference/mysql/functions/mysql-close.xml @@ -1,6 +1,6 @@ - + mysql_close Close MySQL connection diff --git a/reference/mysql/functions/mysql-connect.xml b/reference/mysql/functions/mysql-connect.xml index 4c6079939..450d306e1 100644 --- a/reference/mysql/functions/mysql-connect.xml +++ b/reference/mysql/functions/mysql-connect.xml @@ -1,6 +1,6 @@ - + mysql_connect Open a connection to a MySQL Server diff --git a/reference/mysql/functions/mysql-create-db.xml b/reference/mysql/functions/mysql-create-db.xml index ea11e1fa5..fa1daf1f3 100644 --- a/reference/mysql/functions/mysql-create-db.xml +++ b/reference/mysql/functions/mysql-create-db.xml @@ -1,6 +1,6 @@ - + mysql_create_db Create a MySQL database diff --git a/reference/mysql/functions/mysql-data-seek.xml b/reference/mysql/functions/mysql-data-seek.xml index 53933ae00..69674b1d7 100644 --- a/reference/mysql/functions/mysql-data-seek.xml +++ b/reference/mysql/functions/mysql-data-seek.xml @@ -1,6 +1,6 @@ - + mysql_data_seek Move internal result pointer diff --git a/reference/mysql/functions/mysql-db-name.xml b/reference/mysql/functions/mysql-db-name.xml index bf06fe0c7..080111fc3 100644 --- a/reference/mysql/functions/mysql-db-name.xml +++ b/reference/mysql/functions/mysql-db-name.xml @@ -1,6 +1,6 @@ - + mysql_db_name Retrieves database name from the call to mysql_list_dbs diff --git a/reference/mysql/functions/mysql-db-query.xml b/reference/mysql/functions/mysql-db-query.xml index da49bacfd..cbc3ae464 100644 --- a/reference/mysql/functions/mysql-db-query.xml +++ b/reference/mysql/functions/mysql-db-query.xml @@ -1,6 +1,6 @@ - + mysql_db_query Selects a database and executes a query on it diff --git a/reference/mysql/functions/mysql-drop-db.xml b/reference/mysql/functions/mysql-drop-db.xml index 432ff55c7..b35b13fc3 100644 --- a/reference/mysql/functions/mysql-drop-db.xml +++ b/reference/mysql/functions/mysql-drop-db.xml @@ -1,6 +1,6 @@ - + mysql_drop_db Drop (delete) a MySQL database diff --git a/reference/mysql/functions/mysql-errno.xml b/reference/mysql/functions/mysql-errno.xml index 2f0eb7f44..85acd4b76 100644 --- a/reference/mysql/functions/mysql-errno.xml +++ b/reference/mysql/functions/mysql-errno.xml @@ -1,6 +1,6 @@ - + mysql_errno Returns the numerical value of the error message from previous MySQL operation diff --git a/reference/mysql/functions/mysql-error.xml b/reference/mysql/functions/mysql-error.xml index 20babf417..b18160b2a 100644 --- a/reference/mysql/functions/mysql-error.xml +++ b/reference/mysql/functions/mysql-error.xml @@ -1,6 +1,6 @@ - + mysql_error Returns the text of the error message from previous MySQL operation diff --git a/reference/mysql/functions/mysql-escape-string.xml b/reference/mysql/functions/mysql-escape-string.xml index a28322331..c02c59f67 100644 --- a/reference/mysql/functions/mysql-escape-string.xml +++ b/reference/mysql/functions/mysql-escape-string.xml @@ -1,6 +1,6 @@ - + mysql_escape_string Escapes a string for use in a mysql_query diff --git a/reference/mysql/functions/mysql-fetch-array.xml b/reference/mysql/functions/mysql-fetch-array.xml index 83bfc1fba..158ef0b66 100644 --- a/reference/mysql/functions/mysql-fetch-array.xml +++ b/reference/mysql/functions/mysql-fetch-array.xml @@ -1,6 +1,6 @@ - + mysql_fetch_array Fetch a result row as an associative array, a numeric array, or both diff --git a/reference/mysql/functions/mysql-fetch-assoc.xml b/reference/mysql/functions/mysql-fetch-assoc.xml index 12e186890..5bc5ebe74 100644 --- a/reference/mysql/functions/mysql-fetch-assoc.xml +++ b/reference/mysql/functions/mysql-fetch-assoc.xml @@ -1,6 +1,6 @@ - + mysql_fetch_assoc Fetch a result row as an associative array diff --git a/reference/mysql/functions/mysql-fetch-field.xml b/reference/mysql/functions/mysql-fetch-field.xml index 2b00cdba2..99e58a198 100644 --- a/reference/mysql/functions/mysql-fetch-field.xml +++ b/reference/mysql/functions/mysql-fetch-field.xml @@ -1,6 +1,6 @@ - + mysql_fetch_field Get column information from a result and return as an object diff --git a/reference/mysql/functions/mysql-fetch-lengths.xml b/reference/mysql/functions/mysql-fetch-lengths.xml index d4bd2b46d..b0535fd18 100644 --- a/reference/mysql/functions/mysql-fetch-lengths.xml +++ b/reference/mysql/functions/mysql-fetch-lengths.xml @@ -1,6 +1,6 @@ - + mysql_fetch_lengths Get the length of each output in a result diff --git a/reference/mysql/functions/mysql-fetch-object.xml b/reference/mysql/functions/mysql-fetch-object.xml index d11820713..a7d9fab1a 100644 --- a/reference/mysql/functions/mysql-fetch-object.xml +++ b/reference/mysql/functions/mysql-fetch-object.xml @@ -1,6 +1,6 @@ - + mysql_fetch_object Fetch a result row as an object diff --git a/reference/mysql/functions/mysql-fetch-row.xml b/reference/mysql/functions/mysql-fetch-row.xml index 3e877a7af..7ee4c1922 100644 --- a/reference/mysql/functions/mysql-fetch-row.xml +++ b/reference/mysql/functions/mysql-fetch-row.xml @@ -1,6 +1,6 @@ - + mysql_fetch_row Get a result row as an enumerated array diff --git a/reference/mysql/functions/mysql-field-flags.xml b/reference/mysql/functions/mysql-field-flags.xml index 372861f95..1beb4b82b 100644 --- a/reference/mysql/functions/mysql-field-flags.xml +++ b/reference/mysql/functions/mysql-field-flags.xml @@ -1,6 +1,6 @@ - + mysql_field_flags Get the flags associated with the specified field in a result diff --git a/reference/mysql/functions/mysql-field-len.xml b/reference/mysql/functions/mysql-field-len.xml index 679d9c9dc..275aa21fb 100644 --- a/reference/mysql/functions/mysql-field-len.xml +++ b/reference/mysql/functions/mysql-field-len.xml @@ -1,6 +1,6 @@ - + mysql_field_len Returns the length of the specified field diff --git a/reference/mysql/functions/mysql-field-name.xml b/reference/mysql/functions/mysql-field-name.xml index 9d23f5bca..cdb9700e1 100644 --- a/reference/mysql/functions/mysql-field-name.xml +++ b/reference/mysql/functions/mysql-field-name.xml @@ -1,6 +1,6 @@ - + mysql_field_name Get the name of the specified field in a result diff --git a/reference/mysql/functions/mysql-field-seek.xml b/reference/mysql/functions/mysql-field-seek.xml index c1cb581b4..5627663de 100644 --- a/reference/mysql/functions/mysql-field-seek.xml +++ b/reference/mysql/functions/mysql-field-seek.xml @@ -1,6 +1,6 @@ - + mysql_field_seek Set result pointer to a specified field offset diff --git a/reference/mysql/functions/mysql-field-table.xml b/reference/mysql/functions/mysql-field-table.xml index 8c256f2ae..28fcee755 100644 --- a/reference/mysql/functions/mysql-field-table.xml +++ b/reference/mysql/functions/mysql-field-table.xml @@ -1,6 +1,6 @@ - + mysql_field_table Get name of the table the specified field is in diff --git a/reference/mysql/functions/mysql-field-type.xml b/reference/mysql/functions/mysql-field-type.xml index 7578758f0..2a5e33ec7 100644 --- a/reference/mysql/functions/mysql-field-type.xml +++ b/reference/mysql/functions/mysql-field-type.xml @@ -1,6 +1,6 @@ - + mysql_field_type Get the type of the specified field in a result diff --git a/reference/mysql/functions/mysql-free-result.xml b/reference/mysql/functions/mysql-free-result.xml index 575915e68..c644422dd 100644 --- a/reference/mysql/functions/mysql-free-result.xml +++ b/reference/mysql/functions/mysql-free-result.xml @@ -1,6 +1,6 @@ - + mysql_free_result Free result memory diff --git a/reference/mysql/functions/mysql-get-client-info.xml b/reference/mysql/functions/mysql-get-client-info.xml index 286d34421..e098f0534 100644 --- a/reference/mysql/functions/mysql-get-client-info.xml +++ b/reference/mysql/functions/mysql-get-client-info.xml @@ -1,6 +1,6 @@ - + mysql_get_client_info Get MySQL client info diff --git a/reference/mysql/functions/mysql-get-host-info.xml b/reference/mysql/functions/mysql-get-host-info.xml index 802c0d131..d02f39df8 100644 --- a/reference/mysql/functions/mysql-get-host-info.xml +++ b/reference/mysql/functions/mysql-get-host-info.xml @@ -1,6 +1,6 @@ - + mysql_get_host_info Get MySQL host info diff --git a/reference/mysql/functions/mysql-get-proto-info.xml b/reference/mysql/functions/mysql-get-proto-info.xml index 44b04b3ab..85b19cb64 100644 --- a/reference/mysql/functions/mysql-get-proto-info.xml +++ b/reference/mysql/functions/mysql-get-proto-info.xml @@ -1,6 +1,6 @@ - + mysql_get_proto_info Get MySQL protocol info diff --git a/reference/mysql/functions/mysql-get-server-info.xml b/reference/mysql/functions/mysql-get-server-info.xml index 13e34b525..48ceaa01c 100644 --- a/reference/mysql/functions/mysql-get-server-info.xml +++ b/reference/mysql/functions/mysql-get-server-info.xml @@ -1,6 +1,6 @@ - + mysql_get_server_info Get MySQL server info diff --git a/reference/mysql/functions/mysql-info.xml b/reference/mysql/functions/mysql-info.xml index 76796bd66..0091bf1d5 100644 --- a/reference/mysql/functions/mysql-info.xml +++ b/reference/mysql/functions/mysql-info.xml @@ -1,6 +1,6 @@ - + mysql_info Get information about the most recent query diff --git a/reference/mysql/functions/mysql-insert-id.xml b/reference/mysql/functions/mysql-insert-id.xml index d36bdf467..d7602ec59 100644 --- a/reference/mysql/functions/mysql-insert-id.xml +++ b/reference/mysql/functions/mysql-insert-id.xml @@ -1,6 +1,6 @@ - + mysql_insert_id Get the ID generated in the last query diff --git a/reference/mysql/functions/mysql-list-dbs.xml b/reference/mysql/functions/mysql-list-dbs.xml index 595dc27a8..d00eff3f0 100644 --- a/reference/mysql/functions/mysql-list-dbs.xml +++ b/reference/mysql/functions/mysql-list-dbs.xml @@ -1,6 +1,6 @@ - + mysql_list_dbs List databases available on a MySQL server diff --git a/reference/mysql/functions/mysql-list-fields.xml b/reference/mysql/functions/mysql-list-fields.xml index a9a3b736c..e99e056b3 100644 --- a/reference/mysql/functions/mysql-list-fields.xml +++ b/reference/mysql/functions/mysql-list-fields.xml @@ -1,6 +1,6 @@ - + mysql_list_fields List MySQL table fields diff --git a/reference/mysql/functions/mysql-list-processes.xml b/reference/mysql/functions/mysql-list-processes.xml index ef91dfdb2..f32b83a15 100644 --- a/reference/mysql/functions/mysql-list-processes.xml +++ b/reference/mysql/functions/mysql-list-processes.xml @@ -1,6 +1,6 @@ - + mysql_list_processes List MySQL processes diff --git a/reference/mysql/functions/mysql-list-tables.xml b/reference/mysql/functions/mysql-list-tables.xml index 36798fd5d..21a61bc76 100644 --- a/reference/mysql/functions/mysql-list-tables.xml +++ b/reference/mysql/functions/mysql-list-tables.xml @@ -1,6 +1,6 @@ - + mysql_list_tables List tables in a MySQL database diff --git a/reference/mysql/functions/mysql-num-fields.xml b/reference/mysql/functions/mysql-num-fields.xml index c525e0d6a..68f8e2cb8 100644 --- a/reference/mysql/functions/mysql-num-fields.xml +++ b/reference/mysql/functions/mysql-num-fields.xml @@ -1,6 +1,6 @@ - + mysql_num_fields Get number of fields in result diff --git a/reference/mysql/functions/mysql-num-rows.xml b/reference/mysql/functions/mysql-num-rows.xml index bc43c5340..822b61b95 100644 --- a/reference/mysql/functions/mysql-num-rows.xml +++ b/reference/mysql/functions/mysql-num-rows.xml @@ -1,6 +1,6 @@ - + mysql_num_rows Get number of rows in result diff --git a/reference/mysql/functions/mysql-pconnect.xml b/reference/mysql/functions/mysql-pconnect.xml index 723efea28..6852b44ee 100644 --- a/reference/mysql/functions/mysql-pconnect.xml +++ b/reference/mysql/functions/mysql-pconnect.xml @@ -1,6 +1,6 @@ - + mysql_pconnect Open a persistent connection to a MySQL server diff --git a/reference/mysql/functions/mysql-ping.xml b/reference/mysql/functions/mysql-ping.xml index 570cffe9e..9d1a9b3f4 100644 --- a/reference/mysql/functions/mysql-ping.xml +++ b/reference/mysql/functions/mysql-ping.xml @@ -1,6 +1,6 @@ - + mysql_ping Ping a server connection or reconnect if there is no connection diff --git a/reference/mysql/functions/mysql-query.xml b/reference/mysql/functions/mysql-query.xml index 39e974a5a..2def5d7f8 100644 --- a/reference/mysql/functions/mysql-query.xml +++ b/reference/mysql/functions/mysql-query.xml @@ -1,6 +1,6 @@ - + mysql_query Send a MySQL query diff --git a/reference/mysql/functions/mysql-real-escape-string.xml b/reference/mysql/functions/mysql-real-escape-string.xml index dd64f4bec..79eb42ec9 100644 --- a/reference/mysql/functions/mysql-real-escape-string.xml +++ b/reference/mysql/functions/mysql-real-escape-string.xml @@ -1,6 +1,6 @@ - + mysql_real_escape_string Escapes special characters in a string for use in an SQL statement diff --git a/reference/mysql/functions/mysql-result.xml b/reference/mysql/functions/mysql-result.xml index 097a3e289..e55d12915 100644 --- a/reference/mysql/functions/mysql-result.xml +++ b/reference/mysql/functions/mysql-result.xml @@ -1,6 +1,6 @@ - + mysql_result Get result data diff --git a/reference/mysql/functions/mysql-select-db.xml b/reference/mysql/functions/mysql-select-db.xml index 32ab346a2..f191b1873 100644 --- a/reference/mysql/functions/mysql-select-db.xml +++ b/reference/mysql/functions/mysql-select-db.xml @@ -1,6 +1,6 @@ - + mysql_select_db Select a MySQL database diff --git a/reference/mysql/functions/mysql-set-charset.xml b/reference/mysql/functions/mysql-set-charset.xml index 1001f4e22..14b3ff374 100644 --- a/reference/mysql/functions/mysql-set-charset.xml +++ b/reference/mysql/functions/mysql-set-charset.xml @@ -1,6 +1,6 @@ - + mysql_set_charset Sets the client character set diff --git a/reference/mysql/functions/mysql-stat.xml b/reference/mysql/functions/mysql-stat.xml index 019715df9..f99ee7163 100644 --- a/reference/mysql/functions/mysql-stat.xml +++ b/reference/mysql/functions/mysql-stat.xml @@ -1,6 +1,6 @@ - + mysql_stat Get current system status diff --git a/reference/mysql/functions/mysql-tablename.xml b/reference/mysql/functions/mysql-tablename.xml index af1002f98..a0365d800 100644 --- a/reference/mysql/functions/mysql-tablename.xml +++ b/reference/mysql/functions/mysql-tablename.xml @@ -1,6 +1,6 @@ - + mysql_tablename Get table name of field diff --git a/reference/mysql/functions/mysql-thread-id.xml b/reference/mysql/functions/mysql-thread-id.xml index aec4c5fd2..e797a981c 100644 --- a/reference/mysql/functions/mysql-thread-id.xml +++ b/reference/mysql/functions/mysql-thread-id.xml @@ -1,6 +1,6 @@ - + mysql_thread_id Return the current thread ID diff --git a/reference/mysql/functions/mysql-unbuffered-query.xml b/reference/mysql/functions/mysql-unbuffered-query.xml index 9b87633db..47168640d 100644 --- a/reference/mysql/functions/mysql-unbuffered-query.xml +++ b/reference/mysql/functions/mysql-unbuffered-query.xml @@ -1,6 +1,6 @@ - + mysql_unbuffered_query Send an SQL query to MySQL without fetching and buffering the result rows diff --git a/reference/mysql/ini.xml b/reference/mysql/ini.xml index 6ed6ee6f0..72be411a8 100644 --- a/reference/mysql/ini.xml +++ b/reference/mysql/ini.xml @@ -1,6 +1,6 @@ -
    +
    &reftitle.runtime; &extension.runtime; diff --git a/reference/mysql/reference.xml b/reference/mysql/reference.xml index 630c7d786..3e5abdfe3 100644 --- a/reference/mysql/reference.xml +++ b/reference/mysql/reference.xml @@ -1,6 +1,6 @@ - + MySQL &Functions; diff --git a/reference/mysql/setup.xml b/reference/mysql/setup.xml index 076f1d138..edb29e4e8 100644 --- a/reference/mysql/setup.xml +++ b/reference/mysql/setup.xml @@ -1,6 +1,6 @@ - + &reftitle.setup; diff --git a/reference/mysql_xdevapi/book.xml b/reference/mysql_xdevapi/book.xml index 8feb18d4e..f10fa2c34 100644 --- a/reference/mysql_xdevapi/book.xml +++ b/reference/mysql_xdevapi/book.xml @@ -8,21 +8,21 @@ &reftitle.intro; - + This extension provides access to the MySQL Document Store via the X DevAPI. The X DevAPI is a common API provided by multiple MySQL Connectors providing easy access to relational tables as well as collections of documents, which are represented in JSON, from a API with CRUD-style operations. - - + + The X DevAPI uses the X Protocol, the new generation client-server protocol of the MySQL 8.0 server. - - + + For general information about the MySQL Document Store, please refer to the MySQL Document Store chapter in the MySQL manual. - + &reference.mysql-xdevapi.setup; diff --git a/reference/mysql_xdevapi/changelog.xml b/reference/mysql_xdevapi/changelog.xml index b947cd385..5cf5f1f98 100644 --- a/reference/mysql_xdevapi/changelog.xml +++ b/reference/mysql_xdevapi/changelog.xml @@ -1,17 +1,17 @@ - + &ChangelogListingTitle; - &ChangelogListingDescription; + &ChangelogListingDescription; General Changelog for the ext/mysql_xdevapi extension - + This changelog references the ext/mysql_xdevapi extension. - + - + Global ext/mysql_xdevapi changes @@ -27,19 +27,19 @@ 8.0.28 - + Removed TLSv1 and TLSv1.1 support. The values "TLSv1", "TLSv1.0", and "TLSv1.1" are now considered invalid for the "tls-versions" connection attribute. - + 8.0.26 - + Deprecated TLSv1 and TLSv1.1 support. - + diff --git a/reference/mysql_xdevapi/examples.xml b/reference/mysql_xdevapi/examples.xml index 328553609..a5fcaa249 100644 --- a/reference/mysql_xdevapi/examples.xml +++ b/reference/mysql_xdevapi/examples.xml @@ -3,11 +3,11 @@ &reftitle.examples; - + The central entry point to the X DevAPI is the mysql_xdevapi\getSession function, which receives a URI to a MySQL 8.0 Server and returns a mysql_xdevapi\Session object. - + Connecting to a MySQL Server @@ -18,17 +18,17 @@ try { } catch(Exception $e) { die("Connection could not be established: " . $e->getMessage()); } - + // ... use $session ?> ]]> - + The session provides full access to the API. For a new MySQL Server installation, - the first step is to create a database schema with a collection + the first step is to create a database schema with a collection to store data: - + Creating a Schema and Collection on the MySQL Server @@ -40,14 +40,14 @@ $collection = $schema->createCollection("example"); ]]> - + When storing data, typically json_encode is used to encode the data into JSON, which can then be stored inside a collection. - - - The following example stores data into the collection we created earlier, + + + The following example stores data into the collection we created earlier, and then retrieve parts of it again. - + Storing and Retrieving Data @@ -89,18 +89,18 @@ array(4) { ]]> - + The example demonstrates that the MySQL Server adds an extra field named _id, which serves as primary key to the document. - - + + The example also demonstrates that retrieved data is sorted alphabetically. That specific order comes from the efficient binary storage inside the MySQL server, but it should not be relied upon. Refer to the MySQL JSON datatype documentation for details. - - + + Optionally use PHP's iterators to fetch multiple documents: - + Fetching and Iterating Multiple Documents diff --git a/reference/mysql_xdevapi/functions/mysql-xdevapi.expression.xml b/reference/mysql_xdevapi/functions/mysql-xdevapi.expression.xml index 4806da788..bf8452e55 100644 --- a/reference/mysql_xdevapi/functions/mysql-xdevapi.expression.xml +++ b/reference/mysql_xdevapi/functions/mysql-xdevapi.expression.xml @@ -13,9 +13,9 @@ objectmysql_xdevapi\expression stringexpression - + - + &warn.undocumented.func; @@ -27,9 +27,9 @@ expression - - - + + + @@ -37,9 +37,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/mysql_xdevapi/functions/mysql-xdevapi.getsession.xml b/reference/mysql_xdevapi/functions/mysql-xdevapi.getsession.xml index d22628cc6..091357a24 100644 --- a/reference/mysql_xdevapi/functions/mysql-xdevapi.getsession.xml +++ b/reference/mysql_xdevapi/functions/mysql-xdevapi.getsession.xml @@ -13,9 +13,9 @@ mysql_xdevapi\Sessionmysql_xdevapi\getSession stringuri - + Connects to the MySQL server. - + @@ -24,83 +24,83 @@ uri - + The URI to the MySQL server, such as mysqlx://user:password@host. - - + + URI format: - - + + scheme://[user[:[password]]@]target[:port][?attribute1=value1&attribute2=value2... - + - scheme: required, the connection protocol - In mysql_xdevapi it is always 'mysqlx' (for X Protocol) + scheme: required, the connection protocol + In mysql_xdevapi it is always 'mysqlx' (for X Protocol) - user: optional, the MySQL user account for authentication + user: optional, the MySQL user account for authentication - password: optional, the MySQL user's password for authentication + password: optional, the MySQL user's password for authentication - target: required, the server instance the connection refers to: - * TCP connection (host name, IPv4 address, or IPv6 address) - * Unix socket path (local file path) - * Windows named-pipe (local file path) + target: required, the server instance the connection refers to: + * TCP connection (host name, IPv4 address, or IPv6 address) + * Unix socket path (local file path) + * Windows named-pipe (local file path) - port: optional, network port of MySQL server. - by default port for X Protocol is 33060 + port: optional, network port of MySQL server. + by default port for X Protocol is 33060 - - ?attribute=value: this element is optional and specifies a data dictionary + + ?attribute=value: this element is optional and specifies a data dictionary that contains different options, including: - + - + The auth (authentication mechanism) attribute as it relates to encrypted connections. For additional information, see Command Options for Encrypted Connections. The following 'auth' values are supported: plain, mysql41, external, and sha256_mem. - + - + The connect-timeout attribute affects the connection and not subsequent operations. It is set per connection whether on a single or multiple hosts. - - + + Pass in a positive integer to define the connection timeout in seconds, or pass in 0 (zero) to disable the timeout (infinite). Not defining connect-timeout uses the default value of 10. - - + + Related, the MYSQLX_CONNECTION_TIMEOUT (timeout in seconds) and MYSQLX_TEST_CONNECTION_TIMEOUT (used while running tests) environment variables can be set and used instead of connect-timeout in the URI. The connect-timeout URI option has precedence over these environment variables. - + - - The optional compression attribute accepts these values: - preferred (client negotiates with server to find a supported algorithm; connection is uncompressed if a mutually supported algorithm is not found), + + The optional compression attribute accepts these values: + preferred (client negotiates with server to find a supported algorithm; connection is uncompressed if a mutually supported algorithm is not found), required (like "preferred", but connection is terminated if a mutually supported algorithm is not found), or disabled (connection is uncompressed). Defaults to preferred. - - + + This option was added in version 8.0.20. - + - - The optional compression-algorithms attribute defines - the desired compression algorithms (and their preferred usage order): + + The optional compression-algorithms attribute defines + the desired compression algorithms (and their preferred usage order): zstd_stream (alias: zstd), lz4_message (alias: lz4), or deflate_stream (aliases: deflate or zlib). @@ -108,10 +108,10 @@ For example, passing in compression-algorithms=[lz4,zstd_stream] uses lz4 if it's available, otherwise zstd_stream is used. If both are unavailable then behavior depends on the compression value e.g., if compression=required then it'll fail with an error. - - + + This option was added in version 8.0.22. - + @@ -137,10 +137,10 @@ mysqlx://foo:bar@localhost:33160/?connect-timeout=10&compression=required&am - + For related information, see MySQL Shell's Connecting using a URI String. - + @@ -149,16 +149,16 @@ mysqlx://foo:bar@localhost:33160/?connect-timeout=10&compression=required&am &reftitle.returnvalues; - + A Session object. - + &reftitle.errors; - - A connection failure throws an Exception. - + + A connection failure throws an Exception. + diff --git a/reference/mysql_xdevapi/ini.xml b/reference/mysql_xdevapi/ini.xml index 8e1a076aa..287d6a117 100644 --- a/reference/mysql_xdevapi/ini.xml +++ b/reference/mysql_xdevapi/ini.xml @@ -68,9 +68,9 @@ int - - - + + + @@ -79,9 +79,9 @@ int - - - + + + @@ -90,9 +90,9 @@ string - - - + + + @@ -101,9 +101,9 @@ int - - - + + + @@ -112,9 +112,9 @@ int - - - + + + @@ -123,9 +123,9 @@ string - - - + + + diff --git a/reference/mysql_xdevapi/mysql-xdevapi.baseresult.xml b/reference/mysql_xdevapi/mysql-xdevapi.baseresult.xml index c319d8a85..df11b0f4d 100644 --- a/reference/mysql_xdevapi/mysql-xdevapi.baseresult.xml +++ b/reference/mysql_xdevapi/mysql-xdevapi.baseresult.xml @@ -11,9 +11,9 @@
    &reftitle.intro; - + - +
    @@ -31,7 +31,7 @@ - + &Methods; diff --git a/reference/mysql_xdevapi/mysql-xdevapi.client.xml b/reference/mysql_xdevapi/mysql-xdevapi.client.xml index 12637dba4..bbe338c48 100644 --- a/reference/mysql_xdevapi/mysql-xdevapi.client.xml +++ b/reference/mysql_xdevapi/mysql-xdevapi.client.xml @@ -11,9 +11,9 @@
    &reftitle.intro; - + Provides access to the connection pool. - +
    @@ -31,7 +31,7 @@ - + &Methods; diff --git a/reference/mysql_xdevapi/mysql-xdevapi.collection.xml b/reference/mysql_xdevapi/mysql-xdevapi.collection.xml index 769b0ba79..a9957f4bc 100644 --- a/reference/mysql_xdevapi/mysql-xdevapi.collection.xml +++ b/reference/mysql_xdevapi/mysql-xdevapi.collection.xml @@ -11,9 +11,9 @@
    &reftitle.intro; - + - +
    @@ -29,7 +29,7 @@ mysql_xdevapi\Collection - + mysql_xdevapi\SchemaObject @@ -41,7 +41,7 @@ name - + &Methods; @@ -49,7 +49,7 @@
    - +
    &reftitle.properties; @@ -57,7 +57,7 @@ name - + diff --git a/reference/mysql_xdevapi/mysql-xdevapi.collectionadd.xml b/reference/mysql_xdevapi/mysql-xdevapi.collectionadd.xml index c3353d6a4..343639020 100644 --- a/reference/mysql_xdevapi/mysql-xdevapi.collectionadd.xml +++ b/reference/mysql_xdevapi/mysql-xdevapi.collectionadd.xml @@ -11,9 +11,9 @@
    &reftitle.intro; - + - +
    @@ -29,13 +29,13 @@ mysql_xdevapi\CollectionAdd - + mysql_xdevapi\Executable - + &Methods; diff --git a/reference/mysql_xdevapi/mysql-xdevapi.collectionfind.xml b/reference/mysql_xdevapi/mysql-xdevapi.collectionfind.xml index ac02dbb63..e1afd5e99 100644 --- a/reference/mysql_xdevapi/mysql-xdevapi.collectionfind.xml +++ b/reference/mysql_xdevapi/mysql-xdevapi.collectionfind.xml @@ -11,9 +11,9 @@
    &reftitle.intro; - + - +
    @@ -29,7 +29,7 @@ mysql_xdevapi\CollectionFind - + mysql_xdevapi\Executable @@ -47,7 +47,7 @@ - + &Methods; diff --git a/reference/mysql_xdevapi/mysql-xdevapi.collectionmodify.xml b/reference/mysql_xdevapi/mysql-xdevapi.collectionmodify.xml index 0fc9e70cd..069c66407 100644 --- a/reference/mysql_xdevapi/mysql-xdevapi.collectionmodify.xml +++ b/reference/mysql_xdevapi/mysql-xdevapi.collectionmodify.xml @@ -11,9 +11,9 @@
    &reftitle.intro; - + - +
    @@ -29,7 +29,7 @@ mysql_xdevapi\CollectionModify - + mysql_xdevapi\Executable @@ -51,7 +51,7 @@ - + &Methods; diff --git a/reference/mysql_xdevapi/mysql-xdevapi.collectionremove.xml b/reference/mysql_xdevapi/mysql-xdevapi.collectionremove.xml index 36c4939bb..8133a49dc 100644 --- a/reference/mysql_xdevapi/mysql-xdevapi.collectionremove.xml +++ b/reference/mysql_xdevapi/mysql-xdevapi.collectionremove.xml @@ -11,9 +11,9 @@
    &reftitle.intro; - + - +
    @@ -29,7 +29,7 @@ mysql_xdevapi\CollectionRemove - + mysql_xdevapi\Executable @@ -47,7 +47,7 @@ - + &Methods; diff --git a/reference/mysql_xdevapi/mysql-xdevapi.columnresult.xml b/reference/mysql_xdevapi/mysql-xdevapi.columnresult.xml index f0fd29380..76ac52060 100644 --- a/reference/mysql_xdevapi/mysql-xdevapi.columnresult.xml +++ b/reference/mysql_xdevapi/mysql-xdevapi.columnresult.xml @@ -11,9 +11,9 @@
    &reftitle.intro; - + - +
    @@ -31,7 +31,7 @@ - + &Methods; diff --git a/reference/mysql_xdevapi/mysql-xdevapi.crudoperationbindable.xml b/reference/mysql_xdevapi/mysql-xdevapi.crudoperationbindable.xml index 8927219c3..7b3a709e3 100644 --- a/reference/mysql_xdevapi/mysql-xdevapi.crudoperationbindable.xml +++ b/reference/mysql_xdevapi/mysql-xdevapi.crudoperationbindable.xml @@ -11,9 +11,9 @@
    &reftitle.intro; - + - +
    @@ -31,7 +31,7 @@ - + &Methods; diff --git a/reference/mysql_xdevapi/mysql-xdevapi.crudoperationlimitable.xml b/reference/mysql_xdevapi/mysql-xdevapi.crudoperationlimitable.xml index 0da4aad0e..f83ee786e 100644 --- a/reference/mysql_xdevapi/mysql-xdevapi.crudoperationlimitable.xml +++ b/reference/mysql_xdevapi/mysql-xdevapi.crudoperationlimitable.xml @@ -11,9 +11,9 @@
    &reftitle.intro; - + - +
    @@ -31,7 +31,7 @@ - + &Methods; diff --git a/reference/mysql_xdevapi/mysql-xdevapi.crudoperationskippable.xml b/reference/mysql_xdevapi/mysql-xdevapi.crudoperationskippable.xml index e7f8671ff..1946e9f1d 100644 --- a/reference/mysql_xdevapi/mysql-xdevapi.crudoperationskippable.xml +++ b/reference/mysql_xdevapi/mysql-xdevapi.crudoperationskippable.xml @@ -11,9 +11,9 @@
    &reftitle.intro; - + - +
    @@ -31,7 +31,7 @@ - + &Methods; diff --git a/reference/mysql_xdevapi/mysql-xdevapi.crudoperationsortable.xml b/reference/mysql_xdevapi/mysql-xdevapi.crudoperationsortable.xml index 71909b428..402ee6cd1 100644 --- a/reference/mysql_xdevapi/mysql-xdevapi.crudoperationsortable.xml +++ b/reference/mysql_xdevapi/mysql-xdevapi.crudoperationsortable.xml @@ -11,9 +11,9 @@
    &reftitle.intro; - + - +
    @@ -31,7 +31,7 @@ - + &Methods; diff --git a/reference/mysql_xdevapi/mysql-xdevapi.databaseobject.xml b/reference/mysql_xdevapi/mysql-xdevapi.databaseobject.xml index a059c14f8..b1b544ea8 100644 --- a/reference/mysql_xdevapi/mysql-xdevapi.databaseobject.xml +++ b/reference/mysql_xdevapi/mysql-xdevapi.databaseobject.xml @@ -11,9 +11,9 @@
    &reftitle.intro; - + - +
    @@ -31,7 +31,7 @@ - + &Methods; diff --git a/reference/mysql_xdevapi/mysql-xdevapi.docresult.xml b/reference/mysql_xdevapi/mysql-xdevapi.docresult.xml index 55753313b..f08d4c2a8 100644 --- a/reference/mysql_xdevapi/mysql-xdevapi.docresult.xml +++ b/reference/mysql_xdevapi/mysql-xdevapi.docresult.xml @@ -11,9 +11,9 @@
    &reftitle.intro; - + - +
    @@ -29,7 +29,7 @@ mysql_xdevapi\DocResult - + mysql_xdevapi\BaseResult @@ -39,7 +39,7 @@ - + &Methods; diff --git a/reference/mysql_xdevapi/mysql-xdevapi.driver.xml b/reference/mysql_xdevapi/mysql-xdevapi.driver.xml index 6ba5432e3..b88127a5f 100644 --- a/reference/mysql_xdevapi/mysql-xdevapi.driver.xml +++ b/reference/mysql_xdevapi/mysql-xdevapi.driver.xml @@ -11,9 +11,9 @@
    &reftitle.intro; - + - +
    @@ -52,7 +52,7 @@ mysql_xdevapi\Driver::version - + diff --git a/reference/mysql_xdevapi/mysql-xdevapi.exception.xml b/reference/mysql_xdevapi/mysql-xdevapi.exception.xml index 991b524a5..79c69b153 100644 --- a/reference/mysql_xdevapi/mysql-xdevapi.exception.xml +++ b/reference/mysql_xdevapi/mysql-xdevapi.exception.xml @@ -11,9 +11,9 @@
    &reftitle.intro; - + - +
    @@ -29,12 +29,12 @@ mysql_xdevapi\Exception - + extends RuntimeException - + Throwable @@ -43,10 +43,10 @@ diff --git a/reference/mysql_xdevapi/mysql-xdevapi.executable.xml b/reference/mysql_xdevapi/mysql-xdevapi.executable.xml index f023de7de..f54d54742 100644 --- a/reference/mysql_xdevapi/mysql-xdevapi.executable.xml +++ b/reference/mysql_xdevapi/mysql-xdevapi.executable.xml @@ -11,9 +11,9 @@
    &reftitle.intro; - + - +
    @@ -31,7 +31,7 @@ - + &Methods; diff --git a/reference/mysql_xdevapi/mysql-xdevapi.executionstatus.xml b/reference/mysql_xdevapi/mysql-xdevapi.executionstatus.xml index 298111b00..879c246a9 100644 --- a/reference/mysql_xdevapi/mysql-xdevapi.executionstatus.xml +++ b/reference/mysql_xdevapi/mysql-xdevapi.executionstatus.xml @@ -11,9 +11,9 @@
    &reftitle.intro; - + - +
    @@ -53,7 +53,7 @@ lastDocumentId - + Constructor @@ -61,7 +61,7 @@
    - +
    &reftitle.properties; @@ -69,31 +69,31 @@ affectedItems - + matchedItems - + foundItems - + lastInsertId - + lastDocumentId - + diff --git a/reference/mysql_xdevapi/mysql-xdevapi.expression.xml b/reference/mysql_xdevapi/mysql-xdevapi.expression.xml index 0b8cf1c06..b9bfdb3b2 100644 --- a/reference/mysql_xdevapi/mysql-xdevapi.expression.xml +++ b/reference/mysql_xdevapi/mysql-xdevapi.expression.xml @@ -11,9 +11,9 @@
    &reftitle.intro; - + - +
    @@ -37,7 +37,7 @@ name - + Constructor @@ -45,7 +45,7 @@
    - +
    &reftitle.properties; @@ -53,7 +53,7 @@ name - + diff --git a/reference/mysql_xdevapi/mysql-xdevapi.fieldmetadata.xml b/reference/mysql_xdevapi/mysql-xdevapi.fieldmetadata.xml index ff9696b52..07ea7e5cb 100644 --- a/reference/mysql_xdevapi/mysql-xdevapi.fieldmetadata.xml +++ b/reference/mysql_xdevapi/mysql-xdevapi.fieldmetadata.xml @@ -11,9 +11,9 @@
    &reftitle.intro; - + - +
    @@ -85,13 +85,13 @@ content_type - +
    - +
    &reftitle.properties; @@ -99,79 +99,79 @@ type - + type_name - + name - + original_name - + table - + original_table - + schema - + catalog - + collation - + fractional_digits - + length - + flags - + content_type - + diff --git a/reference/mysql_xdevapi/mysql-xdevapi.result.xml b/reference/mysql_xdevapi/mysql-xdevapi.result.xml index 098a6ab46..369ffc758 100644 --- a/reference/mysql_xdevapi/mysql-xdevapi.result.xml +++ b/reference/mysql_xdevapi/mysql-xdevapi.result.xml @@ -11,9 +11,9 @@
    &reftitle.intro; - + - +
    @@ -29,7 +29,7 @@ mysql_xdevapi\Result - + mysql_xdevapi\BaseResult @@ -39,7 +39,7 @@ - + &Methods; diff --git a/reference/mysql_xdevapi/mysql-xdevapi.rowresult.xml b/reference/mysql_xdevapi/mysql-xdevapi.rowresult.xml index d2de1dff4..cd03d0585 100644 --- a/reference/mysql_xdevapi/mysql-xdevapi.rowresult.xml +++ b/reference/mysql_xdevapi/mysql-xdevapi.rowresult.xml @@ -11,9 +11,9 @@
    &reftitle.intro; - + - +
    @@ -29,7 +29,7 @@ mysql_xdevapi\RowResult - + mysql_xdevapi\BaseResult @@ -39,7 +39,7 @@ - + &Methods; diff --git a/reference/mysql_xdevapi/mysql-xdevapi.schema.xml b/reference/mysql_xdevapi/mysql-xdevapi.schema.xml index 7878f026a..00ff9efb0 100644 --- a/reference/mysql_xdevapi/mysql-xdevapi.schema.xml +++ b/reference/mysql_xdevapi/mysql-xdevapi.schema.xml @@ -11,9 +11,9 @@
    &reftitle.intro; - + - +
    @@ -29,7 +29,7 @@ mysql_xdevapi\Schema - + mysql_xdevapi\DatabaseObject @@ -41,7 +41,7 @@ name - + &Methods; @@ -49,7 +49,7 @@
    - +
    &reftitle.properties; @@ -57,7 +57,7 @@ name - + diff --git a/reference/mysql_xdevapi/mysql-xdevapi.schemaobject.xml b/reference/mysql_xdevapi/mysql-xdevapi.schemaobject.xml index 47187ebf3..525912e09 100644 --- a/reference/mysql_xdevapi/mysql-xdevapi.schemaobject.xml +++ b/reference/mysql_xdevapi/mysql-xdevapi.schemaobject.xml @@ -11,9 +11,9 @@
    &reftitle.intro; - + - +
    @@ -29,13 +29,13 @@ mysql_xdevapi\SchemaObject - + mysql_xdevapi\DatabaseObject - + &Methods; diff --git a/reference/mysql_xdevapi/mysql-xdevapi.session.xml b/reference/mysql_xdevapi/mysql-xdevapi.session.xml index a8f951c18..2f0e74a7b 100644 --- a/reference/mysql_xdevapi/mysql-xdevapi.session.xml +++ b/reference/mysql_xdevapi/mysql-xdevapi.session.xml @@ -11,9 +11,9 @@
    &reftitle.intro; - + - +
    @@ -31,7 +31,7 @@ - + &Methods; diff --git a/reference/mysql_xdevapi/mysql-xdevapi.sqlstatement.xml b/reference/mysql_xdevapi/mysql-xdevapi.sqlstatement.xml index 863dec265..e7401c9a4 100644 --- a/reference/mysql_xdevapi/mysql-xdevapi.sqlstatement.xml +++ b/reference/mysql_xdevapi/mysql-xdevapi.sqlstatement.xml @@ -11,9 +11,9 @@
    &reftitle.intro; - + - +
    @@ -67,7 +67,7 @@ statement - + @@ -83,14 +83,14 @@ mysql_xdevapi\SqlStatement::EXECUTE_ASYNC - + mysql_xdevapi\SqlStatement::BUFFERED - + diff --git a/reference/mysql_xdevapi/mysql-xdevapi.sqlstatementresult.xml b/reference/mysql_xdevapi/mysql-xdevapi.sqlstatementresult.xml index f54836f92..bf191622e 100644 --- a/reference/mysql_xdevapi/mysql-xdevapi.sqlstatementresult.xml +++ b/reference/mysql_xdevapi/mysql-xdevapi.sqlstatementresult.xml @@ -11,9 +11,9 @@
    &reftitle.intro; - + - +
    @@ -29,7 +29,7 @@ mysql_xdevapi\SqlStatementResult - + mysql_xdevapi\BaseResult @@ -39,7 +39,7 @@ - + &Methods; diff --git a/reference/mysql_xdevapi/mysql-xdevapi.statement.xml b/reference/mysql_xdevapi/mysql-xdevapi.statement.xml index a10288499..e1f24f7d0 100644 --- a/reference/mysql_xdevapi/mysql-xdevapi.statement.xml +++ b/reference/mysql_xdevapi/mysql-xdevapi.statement.xml @@ -11,9 +11,9 @@
    &reftitle.intro; - + - +
    @@ -60,14 +60,14 @@ mysql_xdevapi\Statement::EXECUTE_ASYNC - + mysql_xdevapi\Statement::BUFFERED - + diff --git a/reference/mysql_xdevapi/mysql-xdevapi.table.xml b/reference/mysql_xdevapi/mysql-xdevapi.table.xml index d11ad5ca3..5949bb6a7 100644 --- a/reference/mysql_xdevapi/mysql-xdevapi.table.xml +++ b/reference/mysql_xdevapi/mysql-xdevapi.table.xml @@ -11,9 +11,9 @@
    &reftitle.intro; - + Provides access to the table through INSERT/SELECT/UPDATE/DELETE statements. - +
    @@ -57,7 +57,7 @@ name - + diff --git a/reference/mysql_xdevapi/mysql-xdevapi.tabledelete.xml b/reference/mysql_xdevapi/mysql-xdevapi.tabledelete.xml index 0c2888c1e..0bbcd70b4 100644 --- a/reference/mysql_xdevapi/mysql-xdevapi.tabledelete.xml +++ b/reference/mysql_xdevapi/mysql-xdevapi.tabledelete.xml @@ -11,9 +11,9 @@
    &reftitle.intro; - + A statement for delete operations on Table. - +
    diff --git a/reference/mysql_xdevapi/mysql-xdevapi.tableinsert.xml b/reference/mysql_xdevapi/mysql-xdevapi.tableinsert.xml index 0753598f7..3afe70c67 100644 --- a/reference/mysql_xdevapi/mysql-xdevapi.tableinsert.xml +++ b/reference/mysql_xdevapi/mysql-xdevapi.tableinsert.xml @@ -11,9 +11,9 @@
    &reftitle.intro; - + A statement for insert operations on Table. - +
    diff --git a/reference/mysql_xdevapi/mysql-xdevapi.tableselect.xml b/reference/mysql_xdevapi/mysql-xdevapi.tableselect.xml index f744208ec..e7215d6f4 100644 --- a/reference/mysql_xdevapi/mysql-xdevapi.tableselect.xml +++ b/reference/mysql_xdevapi/mysql-xdevapi.tableselect.xml @@ -11,9 +11,9 @@
    &reftitle.intro; - + A statement for record retrieval operations on a Table. - +
    diff --git a/reference/mysql_xdevapi/mysql-xdevapi.tableupdate.xml b/reference/mysql_xdevapi/mysql-xdevapi.tableupdate.xml index f7caafbde..5326e7b1b 100644 --- a/reference/mysql_xdevapi/mysql-xdevapi.tableupdate.xml +++ b/reference/mysql_xdevapi/mysql-xdevapi.tableupdate.xml @@ -11,9 +11,9 @@
    &reftitle.intro; - + A statement for record update operations on a Table. - +
    diff --git a/reference/mysql_xdevapi/mysql-xdevapi.warning.xml b/reference/mysql_xdevapi/mysql-xdevapi.warning.xml index eb98f1d00..86ec8b376 100644 --- a/reference/mysql_xdevapi/mysql-xdevapi.warning.xml +++ b/reference/mysql_xdevapi/mysql-xdevapi.warning.xml @@ -11,9 +11,9 @@
    &reftitle.intro; - + - +
    @@ -45,7 +45,7 @@ code - + Constructor @@ -53,7 +53,7 @@
    - +
    &reftitle.properties; @@ -61,19 +61,19 @@ message - + level - + code - + diff --git a/reference/mysql_xdevapi/mysql_xdevapi/baseresult/getwarnings.xml b/reference/mysql_xdevapi/mysql_xdevapi/baseresult/getwarnings.xml index 73a7897ab..3276d5a04 100644 --- a/reference/mysql_xdevapi/mysql_xdevapi/baseresult/getwarnings.xml +++ b/reference/mysql_xdevapi/mysql_xdevapi/baseresult/getwarnings.xml @@ -13,9 +13,9 @@ abstract public arraymysql_xdevapi\BaseResult::getWarnings - + Fetches warnings generated by MySQL server's last operation. - + @@ -26,11 +26,11 @@ &reftitle.returnvalues; - + An array of Warning objects from the last operation. Each object defines an error 'message', error 'level', and error 'code'. An empty array is returned if no errors are present. - + diff --git a/reference/mysql_xdevapi/mysql_xdevapi/baseresult/getwarningscount.xml b/reference/mysql_xdevapi/mysql_xdevapi/baseresult/getwarningscount.xml index ac2818c95..d71bd6222 100644 --- a/reference/mysql_xdevapi/mysql_xdevapi/baseresult/getwarningscount.xml +++ b/reference/mysql_xdevapi/mysql_xdevapi/baseresult/getwarningscount.xml @@ -13,10 +13,10 @@ abstract public intmysql_xdevapi\BaseResult::getWarningsCount - - Returns the number of warnings raised by the last operation. Specifically, + + Returns the number of warnings raised by the last operation. Specifically, these warnings are raised by the MySQL server. - + @@ -27,9 +27,9 @@ &reftitle.returnvalues; - + The number of warnings from the last operation. - + diff --git a/reference/mysql_xdevapi/mysql_xdevapi/client/close.xml b/reference/mysql_xdevapi/mysql_xdevapi/client/close.xml index 3676fb681..7c292cccd 100755 --- a/reference/mysql_xdevapi/mysql_xdevapi/client/close.xml +++ b/reference/mysql_xdevapi/mysql_xdevapi/client/close.xml @@ -13,9 +13,9 @@ public boolmysql_xdevapi\Client::close - + Close all client connections with the server. - + @@ -25,9 +25,9 @@ &reftitle.returnvalues; - + &true; if connections are closed. - + diff --git a/reference/mysql_xdevapi/mysql_xdevapi/client/construct.xml b/reference/mysql_xdevapi/mysql_xdevapi/client/construct.xml index 1726f2f89..efc490c7e 100755 --- a/reference/mysql_xdevapi/mysql_xdevapi/client/construct.xml +++ b/reference/mysql_xdevapi/mysql_xdevapi/client/construct.xml @@ -13,9 +13,9 @@ private mysql_xdevapi\Client::__construct - + Construct a client object. - + diff --git a/reference/mysql_xdevapi/mysql_xdevapi/client/getsession.xml b/reference/mysql_xdevapi/mysql_xdevapi/client/getsession.xml index 8f51fbd2d..d6a6b98ed 100755 --- a/reference/mysql_xdevapi/mysql_xdevapi/client/getsession.xml +++ b/reference/mysql_xdevapi/mysql_xdevapi/client/getsession.xml @@ -13,9 +13,9 @@ public mysql_xdevapi\Sessionmysql_xdevapi\Client::getSession - + Get session associated with the client. - + @@ -25,9 +25,9 @@ &reftitle.returnvalues; - + A Session object. - + diff --git a/reference/mysql_xdevapi/mysql_xdevapi/collection/add.xml b/reference/mysql_xdevapi/mysql_xdevapi/collection/add.xml index 4f31a8815..5454d0074 100644 --- a/reference/mysql_xdevapi/mysql_xdevapi/collection/add.xml +++ b/reference/mysql_xdevapi/mysql_xdevapi/collection/add.xml @@ -13,26 +13,26 @@ public mysql_xdevapi\CollectionAddmysql_xdevapi\Collection::add mixeddocument - - Triggers the insertion of the given document(s) into the collection, and + + Triggers the insertion of the given document(s) into the collection, and multiple variants of this method are supported. Options include: - + - + Add a single document as a JSON string. - + - - Add a single document as an array as: + + Add a single document as an array as: [ 'field' => 'value', 'field2' => 'value2' ... ] - + - + A mix of both, and multiple documents can be added in the same operation. - + @@ -43,15 +43,15 @@ document - - One or multiple documents, and this can be either JSON or an array of fields with + + One or multiple documents, and this can be either JSON or an array of fields with their associated values. This cannot be an empty array. - - + + The MySQL server automatically generates unique _id values for each document (recommended), although this can be manually added as well. This value must be unique as otherwise the add operation will fail. - + @@ -59,11 +59,11 @@ &reftitle.returnvalues; - - A CollectionAdd object. Use execute() to return a Result that can be used to query the number - of affected items, the number warnings generated by the operation, or to fetch a list of + + A CollectionAdd object. Use execute() to return a Result that can be used to query the number + of affected items, the number warnings generated by the operation, or to fetch a list of generated IDs for the inserted documents. - + @@ -117,13 +117,13 @@ Array &reftitle.notes; - - A unique _id is generated by MySQL Server 8.0 or higher, as demonstrated + + A unique _id is generated by MySQL Server 8.0 or higher, as demonstrated in the example. The _id field must be manually defined if using MySQL Server 5.7. - + - + diff --git a/reference/mysql_xdevapi/mysql_xdevapi/collection/addorreplaceone.xml b/reference/mysql_xdevapi/mysql_xdevapi/collection/addorreplaceone.xml index bfc2bbffd..6980b3a22 100644 --- a/reference/mysql_xdevapi/mysql_xdevapi/collection/addorreplaceone.xml +++ b/reference/mysql_xdevapi/mysql_xdevapi/collection/addorreplaceone.xml @@ -14,43 +14,43 @@ stringid stringdoc - + Add a new document, or replace a document if it already exists. - - + + Here are several scenarios for this method: - + - - If neither the id or any unique key values conflict with any document in the collection, + + If neither the id or any unique key values conflict with any document in the collection, then the document is added. - + - - If the id does not match any document but one or more unique key values conflict with a + + If the id does not match any document but one or more unique key values conflict with a document in the collection, then an error is raised. - + - - If id matches an existing document and no unique keys are defined for the collection, + + If id matches an existing document and no unique keys are defined for the collection, then the document is replaced. - + - - If id matches an existing document, and either all unique keys in the replacement document - match that same document or they don't conflict with any other documents in the collection, + + If id matches an existing document, and either all unique keys in the replacement document + match that same document or they don't conflict with any other documents in the collection, then the document is replaced. - + - - If id matches an existing document and one or more unique keys match a different document + + If id matches an existing document and one or more unique keys match a different document from the collection, then an error is raised. - + @@ -62,22 +62,22 @@ id - - This is the filter id. If this id or any other field that has a unique index already + + This is the filter id. If this id or any other field that has a unique index already exists in the collection, then it will update the matching document instead. - - + + By default, this id is automatically generated by MySQL Server when the record was added, and is referenced as a field named '_id'. - + doc - + This is the document to add or replace, which is a JSON string. - + @@ -85,9 +85,9 @@ &reftitle.returnvalues; - + A Result object. - + diff --git a/reference/mysql_xdevapi/mysql_xdevapi/collection/construct.xml b/reference/mysql_xdevapi/mysql_xdevapi/collection/construct.xml index 51e530105..fcd88a3b8 100644 --- a/reference/mysql_xdevapi/mysql_xdevapi/collection/construct.xml +++ b/reference/mysql_xdevapi/mysql_xdevapi/collection/construct.xml @@ -13,9 +13,9 @@ private mysql_xdevapi\Collection::__construct - + Construct a Collection object. - + diff --git a/reference/mysql_xdevapi/mysql_xdevapi/collection/count.xml b/reference/mysql_xdevapi/mysql_xdevapi/collection/count.xml index fc8ce0d3f..6b513bd34 100644 --- a/reference/mysql_xdevapi/mysql_xdevapi/collection/count.xml +++ b/reference/mysql_xdevapi/mysql_xdevapi/collection/count.xml @@ -13,11 +13,11 @@ public intmysql_xdevapi\Collection::count - - This functionality is similar to a SELECT COUNT(*) SQL + + This functionality is similar to a SELECT COUNT(*) SQL operation against the MySQL server for the current schema and collection. In other words, it counts the number of documents in the collection. - + @@ -28,9 +28,9 @@ &reftitle.returnvalues; - + The number of documents in the collection. - + @@ -53,13 +53,13 @@ $result = $collection ->add( '{"name": "Bernie", "jobs": [ - {"title":"Cat Herder","Salary":42000}, + {"title":"Cat Herder","Salary":42000}, {"title":"Father","Salary":0} ], "hobbies": ["Sports","Making cupcakes"]}', '{"name": "Jane", "jobs": [ - {"title":"Scientist","Salary":18000}, + {"title":"Scientist","Salary":18000}, {"title":"Mother","Salary":0} ], "hobbies": ["Walking","Making pies"]}') diff --git a/reference/mysql_xdevapi/mysql_xdevapi/collection/createindex.xml b/reference/mysql_xdevapi/mysql_xdevapi/collection/createindex.xml index c813ce273..1f35dae97 100644 --- a/reference/mysql_xdevapi/mysql_xdevapi/collection/createindex.xml +++ b/reference/mysql_xdevapi/mysql_xdevapi/collection/createindex.xml @@ -14,13 +14,13 @@ stringindex_name stringindex_desc_json - + Creates an index on the collection. - - + + An exception is thrown if an index with the same name already exists, or if index definition is not correctly formed. - + @@ -29,60 +29,60 @@ index_name - - The name of the index that to create. This name must be a valid index name as + + The name of the index that to create. This name must be a valid index name as accepted by the CREATE INDEX SQL query. - + index_desc_json - + Definition of the index to create. It contains an array of IndexField objects, - and each object describes a single document member to include in the index, + and each object describes a single document member to include in the index, and an optional string for the type of index that might be INDEX (default) or SPATIAL. - - + + A single IndexField description consists of the following fields: - + - + field: string, the full document path to the document member or field to be indexed. - + - + type: string, one of the supported SQL column types to map the field into. For numeric types, the optional UNSIGNED keyword may follow. For the TEXT type, the length to consider for indexing may be added. - + - - required: bool, (optional) true if the field is required to exist in the document. + + required: bool, (optional) true if the field is required to exist in the document. Defaults to &false;, except for GEOJSON where it defaults to &true;. - + - - options: integer, (optional) special option flags for use + + options: integer, (optional) special option flags for use when decoding GEOJSON data. - + - - srid: integer, (optional) srid value for use when + + srid: integer, (optional) srid value for use when decoding GEOJSON data. - + - - It is an error to include other fields not described above in + + It is an error to include other fields not described above in IndexDefinition or IndexField documents. - + @@ -90,7 +90,7 @@ &reftitle.returnvalues; - + @@ -109,27 +109,27 @@ $collection = $schema->createCollection("people"); // Creating a text index $collection->createIndex( - 'myindex1', + 'myindex1', '{"fields": [{ - "field": "$.name", - "type": "TEXT(25)", - "required": true}], + "field": "$.name", + "type": "TEXT(25)", + "required": true}], "unique": false}' ); // A spatial index $collection->createIndex( - 'myindex2', + 'myindex2', '{"fields": [{ - "field": "$.home", - "type": "GEOJSON", - "required": true}], + "field": "$.home", + "type": "GEOJSON", + "required": true}], "type": "SPATIAL"}' ); // Index with multiple fields $collection->createIndex( - 'myindex3', + 'myindex3', '{"fields": [ { "field": "$.name", diff --git a/reference/mysql_xdevapi/mysql_xdevapi/collection/dropindex.xml b/reference/mysql_xdevapi/mysql_xdevapi/collection/dropindex.xml index 315db6ac9..adc1c22de 100644 --- a/reference/mysql_xdevapi/mysql_xdevapi/collection/dropindex.xml +++ b/reference/mysql_xdevapi/mysql_xdevapi/collection/dropindex.xml @@ -13,13 +13,13 @@ public boolmysql_xdevapi\Collection::dropIndex stringindex_name - + Drop a collection index. - - + + This operation does not yield an error if the index does not exist, but &false; is returned in that case. - + @@ -28,9 +28,9 @@ index_name - + Name of collection index to drop. - + @@ -38,9 +38,9 @@ &reftitle.returnvalues; - + &true; if the DROP INDEX operation succeeded, otherwise &false;. - + @@ -63,7 +63,7 @@ $create = $schema->createCollection("people"); $collection = $schema->getCollection("people"); $collection->createIndex( - 'myindex', + 'myindex', '{"fields": [{"field": "$.name", "type": "TEXT(25)", "required": true}], "unique": false}' ); diff --git a/reference/mysql_xdevapi/mysql_xdevapi/collection/existsindatabase.xml b/reference/mysql_xdevapi/mysql_xdevapi/collection/existsindatabase.xml index d4899e35a..8c52bdbe7 100644 --- a/reference/mysql_xdevapi/mysql_xdevapi/collection/existsindatabase.xml +++ b/reference/mysql_xdevapi/mysql_xdevapi/collection/existsindatabase.xml @@ -13,9 +13,9 @@ public boolmysql_xdevapi\Collection::existsInDatabase - + Checks if the Collection object refers to a collection in the database (schema). - + @@ -25,14 +25,14 @@ &reftitle.returnvalues; - + Returns &true; if collection exists in the database, else &false; if it does not. - - - A table defined with two columns (doc and _id) is considered a collection, - and a third _json_schema column as of MySQL 8.0.21. + + + A table defined with two columns (doc and _id) is considered a collection, + and a third _json_schema column as of MySQL 8.0.21. Adding an additional column means existsInDatabase() will no longer see it as a collection. - + diff --git a/reference/mysql_xdevapi/mysql_xdevapi/collection/find.xml b/reference/mysql_xdevapi/mysql_xdevapi/collection/find.xml index ecc70a03e..c88c455ba 100644 --- a/reference/mysql_xdevapi/mysql_xdevapi/collection/find.xml +++ b/reference/mysql_xdevapi/mysql_xdevapi/collection/find.xml @@ -13,11 +13,11 @@ public mysql_xdevapi\CollectionFindmysql_xdevapi\Collection::find stringsearch_condition - + Search a database collection for a document or set of documents. The found documents are returned as a CollectionFind object is to further modify or fetch results from. - + @@ -26,15 +26,15 @@ search_condition - + Although optional, normally a condition is defined to limit the results to a subset of documents. - - - Multiple elements might build the condition and the syntax supports parameter binding. + + + Multiple elements might build the condition and the syntax supports parameter binding. The expression used as search condition must be a valid SQL expression. If no search condition is provided (field empty) then find('true') is assumed. - + @@ -42,10 +42,10 @@ &reftitle.returnvalues; - + A CollectionFind object to verify the operation, or fetch the found documents. - + @@ -73,7 +73,7 @@ $find = $collection->find('job LIKE :job AND age > :age'); $result = $find ->bind(['job' => 'Teacher', 'age' => 20]) ->sort('age DESC') - ->limit(2) + ->limit(2) ->execute(); print_r($result->fetchAll()); diff --git a/reference/mysql_xdevapi/mysql_xdevapi/collection/getname.xml b/reference/mysql_xdevapi/mysql_xdevapi/collection/getname.xml index 154832f6f..e08d6eb09 100644 --- a/reference/mysql_xdevapi/mysql_xdevapi/collection/getname.xml +++ b/reference/mysql_xdevapi/mysql_xdevapi/collection/getname.xml @@ -13,9 +13,9 @@ public stringmysql_xdevapi\Collection::getName - + Retrieve the collection's name. - + @@ -25,9 +25,9 @@ &reftitle.returnvalues; - + The collection name, as a string. - + @@ -60,7 +60,7 @@ string(6) "people" - + diff --git a/reference/mysql_xdevapi/mysql_xdevapi/expression/construct.xml b/reference/mysql_xdevapi/mysql_xdevapi/expression/construct.xml index e7578e1bb..5cbe6e3a8 100644 --- a/reference/mysql_xdevapi/mysql_xdevapi/expression/construct.xml +++ b/reference/mysql_xdevapi/mysql_xdevapi/expression/construct.xml @@ -13,9 +13,9 @@ public mysql_xdevapi\Expression::__construct stringexpression - + - + &warn.undocumented.func; @@ -27,9 +27,9 @@ expression - - - + + + @@ -41,7 +41,7 @@ &reftitle.returnvalues; - + --> diff --git a/reference/mysql_xdevapi/mysql_xdevapi/result/construct.xml b/reference/mysql_xdevapi/mysql_xdevapi/result/construct.xml index 27a19c014..e0a6f7e38 100644 --- a/reference/mysql_xdevapi/mysql_xdevapi/result/construct.xml +++ b/reference/mysql_xdevapi/mysql_xdevapi/result/construct.xml @@ -13,10 +13,10 @@ private mysql_xdevapi\Result::__construct - + An object that retrieves generated IDs, AUTO_INCREMENT values, and warnings, for a Result set. - + diff --git a/reference/mysql_xdevapi/mysql_xdevapi/result/getaffecteditemscount.xml b/reference/mysql_xdevapi/mysql_xdevapi/result/getaffecteditemscount.xml index e1fe71a3d..14c551bac 100644 --- a/reference/mysql_xdevapi/mysql_xdevapi/result/getaffecteditemscount.xml +++ b/reference/mysql_xdevapi/mysql_xdevapi/result/getaffecteditemscount.xml @@ -13,9 +13,9 @@ public intmysql_xdevapi\Result::getAffectedItemsCount - + Get the number of affected rows by the previous operation. - + @@ -25,9 +25,9 @@ &reftitle.returnvalues; - + The number (as an integer) of affected rows. - + diff --git a/reference/mysql_xdevapi/mysql_xdevapi/result/getautoincrementvalue.xml b/reference/mysql_xdevapi/mysql_xdevapi/result/getautoincrementvalue.xml index 9b62b24a5..6b8205eb8 100644 --- a/reference/mysql_xdevapi/mysql_xdevapi/result/getautoincrementvalue.xml +++ b/reference/mysql_xdevapi/mysql_xdevapi/result/getautoincrementvalue.xml @@ -13,9 +13,9 @@ public intmysql_xdevapi\Result::getAutoIncrementValue - + Get the last AUTO_INCREMENT value (last insert id). - + @@ -25,9 +25,9 @@ &reftitle.returnvalues; - + The last AUTO_INCREMENT value. - + diff --git a/reference/mysql_xdevapi/mysql_xdevapi/result/getgeneratedids.xml b/reference/mysql_xdevapi/mysql_xdevapi/result/getgeneratedids.xml index f947c36ab..62a5bfc6e 100644 --- a/reference/mysql_xdevapi/mysql_xdevapi/result/getgeneratedids.xml +++ b/reference/mysql_xdevapi/mysql_xdevapi/result/getgeneratedids.xml @@ -13,10 +13,10 @@ public arraymysql_xdevapi\Result::getGeneratedIds - - Fetch the generated _id values from the last operation. + + Fetch the generated _id values from the last operation. The unique _id field is generated by the MySQL server. - + @@ -26,10 +26,10 @@ &reftitle.returnvalues; - - An array of generated _id's from the last operation, + + An array of generated _id's from the last operation, or an empty array if there are none. - + diff --git a/reference/mysql_xdevapi/mysql_xdevapi/result/getwarnings.xml b/reference/mysql_xdevapi/mysql_xdevapi/result/getwarnings.xml index 2271b2633..8b5c8d1b0 100644 --- a/reference/mysql_xdevapi/mysql_xdevapi/result/getwarnings.xml +++ b/reference/mysql_xdevapi/mysql_xdevapi/result/getwarnings.xml @@ -13,9 +13,9 @@ public arraymysql_xdevapi\Result::getWarnings - + Retrieve warnings from the last Result operation. - + @@ -25,11 +25,11 @@ &reftitle.returnvalues; - + An array of Warning objects from the last operation. Each object defines an error 'message', error 'level', and error 'code'. An empty array is returned if no errors are present. - + diff --git a/reference/mysql_xdevapi/mysql_xdevapi/result/getwarningscount.xml b/reference/mysql_xdevapi/mysql_xdevapi/result/getwarningscount.xml index ac7a30777..4b94cf42c 100644 --- a/reference/mysql_xdevapi/mysql_xdevapi/result/getwarningscount.xml +++ b/reference/mysql_xdevapi/mysql_xdevapi/result/getwarningscount.xml @@ -13,9 +13,9 @@ public intmysql_xdevapi\Result::getWarningsCount - + Retrieve the number of warnings from the last Result operation. - + @@ -25,9 +25,9 @@ &reftitle.returnvalues; - + The number of warnings generated by the last operation. - + diff --git a/reference/mysql_xdevapi/mysql_xdevapi/rowresult/construct.xml b/reference/mysql_xdevapi/mysql_xdevapi/rowresult/construct.xml index 8f41e374f..7a07c6a4c 100644 --- a/reference/mysql_xdevapi/mysql_xdevapi/rowresult/construct.xml +++ b/reference/mysql_xdevapi/mysql_xdevapi/rowresult/construct.xml @@ -13,9 +13,9 @@ private mysql_xdevapi\RowResult::__construct - + Represents the result set obtained from querying the database. - + diff --git a/reference/mysql_xdevapi/mysql_xdevapi/rowresult/fetchall.xml b/reference/mysql_xdevapi/mysql_xdevapi/rowresult/fetchall.xml index 44762f8af..eb29b5b18 100644 --- a/reference/mysql_xdevapi/mysql_xdevapi/rowresult/fetchall.xml +++ b/reference/mysql_xdevapi/mysql_xdevapi/rowresult/fetchall.xml @@ -13,9 +13,9 @@ public arraymysql_xdevapi\RowResult::fetchAll - + Fetch all the rows from the result set. - + @@ -25,11 +25,11 @@ &reftitle.returnvalues; - + A numerical array with all results from the query; each result is an associative array. An empty array is returned if no rows are present. - + diff --git a/reference/mysql_xdevapi/mysql_xdevapi/rowresult/fetchone.xml b/reference/mysql_xdevapi/mysql_xdevapi/rowresult/fetchone.xml index 68f29b7c4..62560ab93 100644 --- a/reference/mysql_xdevapi/mysql_xdevapi/rowresult/fetchone.xml +++ b/reference/mysql_xdevapi/mysql_xdevapi/rowresult/fetchone.xml @@ -13,9 +13,9 @@ public arraymysql_xdevapi\RowResult::fetchOne - + Fetch one result from the result set. - + &warn.undocumented.func; @@ -28,10 +28,10 @@ &reftitle.returnvalues; - - The result, as an associative array + + The result, as an associative array or &null; if no results are present. - + diff --git a/reference/mysql_xdevapi/mysql_xdevapi/rowresult/getcolumncount.xml b/reference/mysql_xdevapi/mysql_xdevapi/rowresult/getcolumncount.xml index c52e40489..7eec85c25 100644 --- a/reference/mysql_xdevapi/mysql_xdevapi/rowresult/getcolumncount.xml +++ b/reference/mysql_xdevapi/mysql_xdevapi/rowresult/getcolumncount.xml @@ -13,9 +13,9 @@ public intmysql_xdevapi\RowResult::getColumnsCount - + Retrieve the column count for columns present in the result set. - + @@ -25,9 +25,9 @@ &reftitle.returnvalues; - + The number of columns; 0 if there are none. - + diff --git a/reference/mysql_xdevapi/mysql_xdevapi/rowresult/getcolumnnames.xml b/reference/mysql_xdevapi/mysql_xdevapi/rowresult/getcolumnnames.xml index f33515f7b..72e32d320 100644 --- a/reference/mysql_xdevapi/mysql_xdevapi/rowresult/getcolumnnames.xml +++ b/reference/mysql_xdevapi/mysql_xdevapi/rowresult/getcolumnnames.xml @@ -13,9 +13,9 @@ public arraymysql_xdevapi\RowResult::getColumnNames - + Retrieve column names for columns present in the result set. - + &warn.undocumented.func; @@ -28,10 +28,10 @@ &reftitle.returnvalues; - + A numerical array of table columns names, or an empty array if the result set is empty. - + @@ -51,7 +51,7 @@ $session->sql("INSERT INTO addressbook.names values ('John', 42), ('Sam', 33)")- $sql = $session->sql("SELECT * from addressbook.names")->execute(); $colnames = $sql->getColumnNames(); - + print_r($colnames); ]]> diff --git a/reference/mysql_xdevapi/mysql_xdevapi/rowresult/getcolumns.xml b/reference/mysql_xdevapi/mysql_xdevapi/rowresult/getcolumns.xml index f98ea6854..abe8f2d9e 100644 --- a/reference/mysql_xdevapi/mysql_xdevapi/rowresult/getcolumns.xml +++ b/reference/mysql_xdevapi/mysql_xdevapi/rowresult/getcolumns.xml @@ -13,9 +13,9 @@ public arraymysql_xdevapi\RowResult::getColumns - + Retrieve column metadata for columns present in the result set. - + &warn.undocumented.func; @@ -28,10 +28,10 @@ &reftitle.returnvalues; - - An array of FieldMetadata objects representing the columns in the result, + + An array of FieldMetadata objects representing the columns in the result, or an empty array if the result set is empty. - + @@ -51,7 +51,7 @@ $session->sql("INSERT INTO addressbook.names values ('John', 42), ('Sam', 33)")- $sql = $session->sql("SELECT * from addressbook.names")->execute(); $cols = $sql->getColumns(); - + print_r($cols); ]]> diff --git a/reference/mysql_xdevapi/mysql_xdevapi/rowresult/getwarnings.xml b/reference/mysql_xdevapi/mysql_xdevapi/rowresult/getwarnings.xml index a6bbe8f42..9def74be9 100644 --- a/reference/mysql_xdevapi/mysql_xdevapi/rowresult/getwarnings.xml +++ b/reference/mysql_xdevapi/mysql_xdevapi/rowresult/getwarnings.xml @@ -13,9 +13,9 @@ public arraymysql_xdevapi\RowResult::getWarnings - + Retrieve warnings from the last RowResult operation. - + @@ -25,11 +25,11 @@ &reftitle.returnvalues; - + An array of Warning objects from the last operation. Each object defines an error 'message', error 'level', and error 'code'. An empty array is returned if no errors are present. - + diff --git a/reference/mysql_xdevapi/mysql_xdevapi/rowresult/getwarningscount.xml b/reference/mysql_xdevapi/mysql_xdevapi/rowresult/getwarningscount.xml index 7b4d5daee..f33c88bfd 100644 --- a/reference/mysql_xdevapi/mysql_xdevapi/rowresult/getwarningscount.xml +++ b/reference/mysql_xdevapi/mysql_xdevapi/rowresult/getwarningscount.xml @@ -13,9 +13,9 @@ public intmysql_xdevapi\RowResult::getWarningsCount - + Retrieve the number of warnings from the last RowResult operation. - + @@ -25,9 +25,9 @@ &reftitle.returnvalues; - + The number of warnings generated by the last operation. - + diff --git a/reference/mysql_xdevapi/mysql_xdevapi/schema/construct.xml b/reference/mysql_xdevapi/mysql_xdevapi/schema/construct.xml index c343f3145..6aabce7d7 100644 --- a/reference/mysql_xdevapi/mysql_xdevapi/schema/construct.xml +++ b/reference/mysql_xdevapi/mysql_xdevapi/schema/construct.xml @@ -12,9 +12,9 @@ private mysql_xdevapi\Schema::__construct - + The Schema object provides full access to the schema (database). - + diff --git a/reference/mysql_xdevapi/mysql_xdevapi/schema/createcollection.xml b/reference/mysql_xdevapi/mysql_xdevapi/schema/createcollection.xml index 939f0472e..110c3942f 100644 --- a/reference/mysql_xdevapi/mysql_xdevapi/schema/createcollection.xml +++ b/reference/mysql_xdevapi/mysql_xdevapi/schema/createcollection.xml @@ -13,9 +13,9 @@ stringname stringvalidate - + Create a collection within the schema. - + @@ -24,17 +24,17 @@ name - + Collection name. - + validate - + Validation definition, as a JSON object. - + @@ -42,9 +42,9 @@ &reftitle.returnvalues; - + The Collection object. - + diff --git a/reference/mysql_xdevapi/mysql_xdevapi/schema/dropcollection.xml b/reference/mysql_xdevapi/mysql_xdevapi/schema/dropcollection.xml index faca6cd1b..368d479a6 100644 --- a/reference/mysql_xdevapi/mysql_xdevapi/schema/dropcollection.xml +++ b/reference/mysql_xdevapi/mysql_xdevapi/schema/dropcollection.xml @@ -12,9 +12,9 @@ public boolmysql_xdevapi\Schema::dropCollection stringcollection_name - + - + &warn.undocumented.func; @@ -26,9 +26,9 @@ collection_name - + - + @@ -36,9 +36,9 @@ &reftitle.returnvalues; - + - + diff --git a/reference/mysql_xdevapi/mysql_xdevapi/schema/existsindatabase.xml b/reference/mysql_xdevapi/mysql_xdevapi/schema/existsindatabase.xml index 7ce35ed39..0ba3af13c 100644 --- a/reference/mysql_xdevapi/mysql_xdevapi/schema/existsindatabase.xml +++ b/reference/mysql_xdevapi/mysql_xdevapi/schema/existsindatabase.xml @@ -12,10 +12,10 @@ public boolmysql_xdevapi\Schema::existsInDatabase - + Checks if the current object (schema, table, collection, or view) exists in the schema object. - + @@ -25,9 +25,9 @@ &reftitle.returnvalues; - + &true; if the schema, table, collection, or view still exists in the schema, else &false;. - + diff --git a/reference/mysql_xdevapi/mysql_xdevapi/schema/getcollection.xml b/reference/mysql_xdevapi/mysql_xdevapi/schema/getcollection.xml index aba236ade..b9a3f934b 100644 --- a/reference/mysql_xdevapi/mysql_xdevapi/schema/getcollection.xml +++ b/reference/mysql_xdevapi/mysql_xdevapi/schema/getcollection.xml @@ -12,9 +12,9 @@ public mysql_xdevapi\Collectionmysql_xdevapi\Schema::getCollection stringname - + Get a collection from the schema. - + @@ -23,9 +23,9 @@ name - + Collection name to retrieve. - + @@ -33,9 +33,9 @@ &reftitle.returnvalues; - + The Collection object for the selected collection. - + diff --git a/reference/mysql_xdevapi/mysql_xdevapi/schema/getcollectionastable.xml b/reference/mysql_xdevapi/mysql_xdevapi/schema/getcollectionastable.xml index a5cd83018..73f459a7a 100644 --- a/reference/mysql_xdevapi/mysql_xdevapi/schema/getcollectionastable.xml +++ b/reference/mysql_xdevapi/mysql_xdevapi/schema/getcollectionastable.xml @@ -10,11 +10,11 @@ &reftitle.description; public mysql_xdevapi\Tablemysql_xdevapi\Schema::getCollectionAsTable - stringname + stringname - + Get a collection, but as a Table object instead of a Collection object. - + @@ -23,19 +23,19 @@ name - + Name of the collection to instantiate a Table object from. - + - + &reftitle.returnvalues; - + A mysql_xdevapi\Table object for the collection. - + diff --git a/reference/mysql_xdevapi/mysql_xdevapi/schema/getcollections.xml b/reference/mysql_xdevapi/mysql_xdevapi/schema/getcollections.xml index 5be8091cc..e7deb84c0 100644 --- a/reference/mysql_xdevapi/mysql_xdevapi/schema/getcollections.xml +++ b/reference/mysql_xdevapi/mysql_xdevapi/schema/getcollections.xml @@ -13,9 +13,9 @@ public arraymysql_xdevapi\Schema::getCollections - + Fetch a list of collections for this schema. - + @@ -25,10 +25,10 @@ &reftitle.returnvalues; - + Array of all collections in this schema, where each array element value is a Collection object with the collection name as the key. - + diff --git a/reference/mysql_xdevapi/mysql_xdevapi/schema/getname.xml b/reference/mysql_xdevapi/mysql_xdevapi/schema/getname.xml index d8bd4a925..3d22f2c9c 100644 --- a/reference/mysql_xdevapi/mysql_xdevapi/schema/getname.xml +++ b/reference/mysql_xdevapi/mysql_xdevapi/schema/getname.xml @@ -13,9 +13,9 @@ public stringmysql_xdevapi\Schema::getName - + Get the name of the schema. - + @@ -25,9 +25,9 @@ &reftitle.returnvalues; - + The name of the schema connected to the schema object, as a string. - + diff --git a/reference/mysql_xdevapi/mysql_xdevapi/schema/getsession.xml b/reference/mysql_xdevapi/mysql_xdevapi/schema/getsession.xml index 0e3f40826..a990a6959 100644 --- a/reference/mysql_xdevapi/mysql_xdevapi/schema/getsession.xml +++ b/reference/mysql_xdevapi/mysql_xdevapi/schema/getsession.xml @@ -13,9 +13,9 @@ public mysql_xdevapi\Sessionmysql_xdevapi\Schema::getSession - + Get a new Session object from the Schema object. - + @@ -25,9 +25,9 @@ &reftitle.returnvalues; - + A Session object. - + diff --git a/reference/mysql_xdevapi/mysql_xdevapi/schema/gettable.xml b/reference/mysql_xdevapi/mysql_xdevapi/schema/gettable.xml index 90f765355..4171f7797 100644 --- a/reference/mysql_xdevapi/mysql_xdevapi/schema/gettable.xml +++ b/reference/mysql_xdevapi/mysql_xdevapi/schema/gettable.xml @@ -13,9 +13,9 @@ public mysql_xdevapi\Tablemysql_xdevapi\Schema::getTable stringname - + Fetch a Table object for the provided table in the schema. - + @@ -24,9 +24,9 @@ name - + Name of the table. - + @@ -34,9 +34,9 @@ &reftitle.returnvalues; - + A Table object. - + diff --git a/reference/mysql_xdevapi/mysql_xdevapi/schema/gettables.xml b/reference/mysql_xdevapi/mysql_xdevapi/schema/gettables.xml index 9ae581256..206fce180 100644 --- a/reference/mysql_xdevapi/mysql_xdevapi/schema/gettables.xml +++ b/reference/mysql_xdevapi/mysql_xdevapi/schema/gettables.xml @@ -13,9 +13,9 @@ public arraymysql_xdevapi\Schema::getTables - + - + &warn.undocumented.func; @@ -28,10 +28,10 @@ &reftitle.returnvalues; - + Array of all tables in this schema, where each array element value is a Table object with the table name as the key. - + diff --git a/reference/mysql_xdevapi/mysql_xdevapi/schemaobject/getschema.xml b/reference/mysql_xdevapi/mysql_xdevapi/schemaobject/getschema.xml index 0e5a94a9d..7093a8e55 100644 --- a/reference/mysql_xdevapi/mysql_xdevapi/schemaobject/getschema.xml +++ b/reference/mysql_xdevapi/mysql_xdevapi/schemaobject/getschema.xml @@ -13,9 +13,9 @@ abstract mysql_xdevapi\Schemamysql_xdevapi\SchemaObject::getSchema - + Used by other objects to retrieve a schema object. - + @@ -25,9 +25,9 @@ &reftitle.returnvalues; - + The current Schema object. - + diff --git a/reference/mysql_xdevapi/mysql_xdevapi/session/close.xml b/reference/mysql_xdevapi/mysql_xdevapi/session/close.xml index 61d28582e..1c243cf1e 100644 --- a/reference/mysql_xdevapi/mysql_xdevapi/session/close.xml +++ b/reference/mysql_xdevapi/mysql_xdevapi/session/close.xml @@ -13,9 +13,9 @@ public boolmysql_xdevapi\Session::close - + Close the session with the server. - + @@ -25,9 +25,9 @@ &reftitle.returnvalues; - + &true; if the session closed. - + diff --git a/reference/mysql_xdevapi/mysql_xdevapi/session/commit.xml b/reference/mysql_xdevapi/mysql_xdevapi/session/commit.xml index 5d919b81b..e2556a08b 100644 --- a/reference/mysql_xdevapi/mysql_xdevapi/session/commit.xml +++ b/reference/mysql_xdevapi/mysql_xdevapi/session/commit.xml @@ -13,9 +13,9 @@ public Objectmysql_xdevapi\Session::commit - + Commit the transaction. - + @@ -25,9 +25,9 @@ &reftitle.returnvalues; - + An SqlStatementResult object. - + diff --git a/reference/mysql_xdevapi/mysql_xdevapi/session/construct.xml b/reference/mysql_xdevapi/mysql_xdevapi/session/construct.xml index b923d422e..70e0e6698 100644 --- a/reference/mysql_xdevapi/mysql_xdevapi/session/construct.xml +++ b/reference/mysql_xdevapi/mysql_xdevapi/session/construct.xml @@ -13,9 +13,9 @@ private mysql_xdevapi\Session::__construct - + A Session object, as initiated by getSession(). - + diff --git a/reference/mysql_xdevapi/mysql_xdevapi/session/createschema.xml b/reference/mysql_xdevapi/mysql_xdevapi/session/createschema.xml index 37b0c047f..e2fbf1376 100644 --- a/reference/mysql_xdevapi/mysql_xdevapi/session/createschema.xml +++ b/reference/mysql_xdevapi/mysql_xdevapi/session/createschema.xml @@ -13,9 +13,9 @@ public mysql_xdevapi\Schemamysql_xdevapi\Session::createSchema stringschema_name - + Creates a new schema. - + @@ -24,9 +24,9 @@ schema_name - + Name of the schema to create. - + @@ -35,9 +35,9 @@ &reftitle.returnvalues; - + A Schema object on success, and emits an exception on failure. - + @@ -55,7 +55,7 @@ try { if ($schema = $sess->createSchema('fruit')) { echo "Info: I created a schema named 'fruit'\n"; } - + } catch (Exception $e) { echo $e->getMessage(); diff --git a/reference/mysql_xdevapi/mysql_xdevapi/session/dropschema.xml b/reference/mysql_xdevapi/mysql_xdevapi/session/dropschema.xml index cc5684082..33d2bacbc 100644 --- a/reference/mysql_xdevapi/mysql_xdevapi/session/dropschema.xml +++ b/reference/mysql_xdevapi/mysql_xdevapi/session/dropschema.xml @@ -13,9 +13,9 @@ public boolmysql_xdevapi\Session::dropSchema stringschema_name - + Drop a schema (database). - + @@ -24,9 +24,9 @@ schema_name - + Name of the schema to drop. - + @@ -34,14 +34,14 @@ &reftitle.returnvalues; - + &true; if the schema is dropped, or &false; if it does not exist - or can't be dropped. - - - An E_WARNING level error is generated if the + or can't be dropped. + + + An E_WARNING level error is generated if the schema does not exist. - + diff --git a/reference/mysql_xdevapi/mysql_xdevapi/session/generateuuid.xml b/reference/mysql_xdevapi/mysql_xdevapi/session/generateuuid.xml index 9f52d6c93..ccc081f2b 100644 --- a/reference/mysql_xdevapi/mysql_xdevapi/session/generateuuid.xml +++ b/reference/mysql_xdevapi/mysql_xdevapi/session/generateuuid.xml @@ -13,10 +13,10 @@ public stringmysql_xdevapi\Session::generateUUID - - Generate a Universal Unique IDentifier (UUID) generated according to + + Generate a Universal Unique IDentifier (UUID) generated according to RFC 4122. - + @@ -26,9 +26,9 @@ &reftitle.returnvalues; - + The UUID; a string with a length of 32. - + diff --git a/reference/mysql_xdevapi/mysql_xdevapi/session/getdefaultschema.xml b/reference/mysql_xdevapi/mysql_xdevapi/session/getdefaultschema.xml index ba8c9b4bd..9d8f071ce 100755 --- a/reference/mysql_xdevapi/mysql_xdevapi/session/getdefaultschema.xml +++ b/reference/mysql_xdevapi/mysql_xdevapi/session/getdefaultschema.xml @@ -13,9 +13,9 @@ public mysql_xdevapi\Schemanullmysql_xdevapi\Session::getDefaultSchema - + Retrieve the default schema that's typically set in the connection URI. - + @@ -25,11 +25,11 @@ &reftitle.returnvalues; - + The default schema defined by the connection, or &null; if one was not set. - + - + &reftitle.examples; diff --git a/reference/mysql_xdevapi/mysql_xdevapi/session/getschema.xml b/reference/mysql_xdevapi/mysql_xdevapi/session/getschema.xml index c2a0aea4c..ecf9e41e3 100644 --- a/reference/mysql_xdevapi/mysql_xdevapi/session/getschema.xml +++ b/reference/mysql_xdevapi/mysql_xdevapi/session/getschema.xml @@ -13,9 +13,9 @@ public mysql_xdevapi\Schemamysql_xdevapi\Session::getSchema stringschema_name - + A new Schema object for the provided schema name. - + @@ -24,9 +24,9 @@ schema_name - + Name of the schema (database) to fetch a Schema object for. - + @@ -34,9 +34,9 @@ &reftitle.returnvalues; - + A Schema object. - + diff --git a/reference/mysql_xdevapi/mysql_xdevapi/session/getschemas.xml b/reference/mysql_xdevapi/mysql_xdevapi/session/getschemas.xml index 246337c5b..c6ec22665 100644 --- a/reference/mysql_xdevapi/mysql_xdevapi/session/getschemas.xml +++ b/reference/mysql_xdevapi/mysql_xdevapi/session/getschemas.xml @@ -13,9 +13,9 @@ public arraymysql_xdevapi\Session::getSchemas - + Get schema objects for all schemas available to the session. - + @@ -25,10 +25,10 @@ &reftitle.returnvalues; - - An array containing objects that represent all of the schemas + + An array containing objects that represent all of the schemas available to the session. - + diff --git a/reference/mysql_xdevapi/mysql_xdevapi/session/getserverversion.xml b/reference/mysql_xdevapi/mysql_xdevapi/session/getserverversion.xml index 72abd99be..7b5adca76 100644 --- a/reference/mysql_xdevapi/mysql_xdevapi/session/getserverversion.xml +++ b/reference/mysql_xdevapi/mysql_xdevapi/session/getserverversion.xml @@ -13,9 +13,9 @@ public intmysql_xdevapi\Session::getServerVersion - + Retrieve the MySQL server version for the session. - + @@ -25,9 +25,9 @@ &reftitle.returnvalues; - + The MySQL server version for the session, as an integer such as "80012". - + diff --git a/reference/mysql_xdevapi/mysql_xdevapi/session/listclients.xml b/reference/mysql_xdevapi/mysql_xdevapi/session/listclients.xml index 94b702b2c..a8f7e1986 100644 --- a/reference/mysql_xdevapi/mysql_xdevapi/session/listclients.xml +++ b/reference/mysql_xdevapi/mysql_xdevapi/session/listclients.xml @@ -13,9 +13,9 @@ public arraymysql_xdevapi\Session::listClients - + Get a list of client connections to the session's MySQL server. - + @@ -25,10 +25,10 @@ &reftitle.returnvalues; - + An array containing the currently logged clients. The array elements are "client_id", "user", "host", and "sql_session". - + diff --git a/reference/mysql_xdevapi/mysql_xdevapi/session/quotename.xml b/reference/mysql_xdevapi/mysql_xdevapi/session/quotename.xml index d905a7d15..7e9c35ece 100644 --- a/reference/mysql_xdevapi/mysql_xdevapi/session/quotename.xml +++ b/reference/mysql_xdevapi/mysql_xdevapi/session/quotename.xml @@ -13,11 +13,11 @@ public stringmysql_xdevapi\Session::quoteName stringname - - A quoting function to escape SQL names and identifiers. It escapes the identifier - given in accordance to the settings of the current connection. This escape + + A quoting function to escape SQL names and identifiers. It escapes the identifier + given in accordance to the settings of the current connection. This escape function should not be used to escape values. - + @@ -26,9 +26,9 @@ name - + The string to quote. - + @@ -36,9 +36,9 @@ &reftitle.returnvalues; - + The quoted string. - + diff --git a/reference/mysql_xdevapi/mysql_xdevapi/session/releasesavepoint.xml b/reference/mysql_xdevapi/mysql_xdevapi/session/releasesavepoint.xml index 1a4d01ac7..2fe648f2e 100644 --- a/reference/mysql_xdevapi/mysql_xdevapi/session/releasesavepoint.xml +++ b/reference/mysql_xdevapi/mysql_xdevapi/session/releasesavepoint.xml @@ -13,9 +13,9 @@ public voidmysql_xdevapi\Session::releaseSavepoint stringname - + Release a previously set savepoint. - + @@ -24,9 +24,9 @@ name - + Name of the savepoint to release. - + @@ -35,9 +35,9 @@ &reftitle.returnvalues; - + An SqlStatementResult object. - + diff --git a/reference/mysql_xdevapi/mysql_xdevapi/session/rollback.xml b/reference/mysql_xdevapi/mysql_xdevapi/session/rollback.xml index fdeff7bf2..9e39a57dc 100644 --- a/reference/mysql_xdevapi/mysql_xdevapi/session/rollback.xml +++ b/reference/mysql_xdevapi/mysql_xdevapi/session/rollback.xml @@ -13,9 +13,9 @@ public voidmysql_xdevapi\Session::rollback - + Rollback the transaction. - + @@ -25,9 +25,9 @@ &reftitle.returnvalues; - + An SqlStatementResult object. - + diff --git a/reference/mysql_xdevapi/mysql_xdevapi/session/rollbackto.xml b/reference/mysql_xdevapi/mysql_xdevapi/session/rollbackto.xml index 41fd6f4c9..bb00efd52 100644 --- a/reference/mysql_xdevapi/mysql_xdevapi/session/rollbackto.xml +++ b/reference/mysql_xdevapi/mysql_xdevapi/session/rollbackto.xml @@ -13,9 +13,9 @@ public voidmysql_xdevapi\Session::rollbackTo stringname - + Rollback the transaction back to the savepoint. - + @@ -24,9 +24,9 @@ name - + Name of the savepoint to rollback to; case-insensitive. - + @@ -34,9 +34,9 @@ &reftitle.returnvalues; - + An SqlStatementResult object. - + diff --git a/reference/mysql_xdevapi/mysql_xdevapi/session/setsavepoint.xml b/reference/mysql_xdevapi/mysql_xdevapi/session/setsavepoint.xml index ed49d2061..e80c88089 100644 --- a/reference/mysql_xdevapi/mysql_xdevapi/session/setsavepoint.xml +++ b/reference/mysql_xdevapi/mysql_xdevapi/session/setsavepoint.xml @@ -13,10 +13,10 @@ public stringmysql_xdevapi\Session::setSavepoint stringname - + Create a new savepoint for the transaction. - - + + &warn.undocumented.func; @@ -27,10 +27,10 @@ name - - The name of the savepoint. The name is auto-generated if the optional name + + The name of the savepoint. The name is auto-generated if the optional name parameter is not defined as 'SAVEPOINT1', 'SAVEPOINT2', and so on. - + @@ -38,9 +38,9 @@ &reftitle.returnvalues; - + The name of the save point. - + diff --git a/reference/mysql_xdevapi/mysql_xdevapi/session/sql.xml b/reference/mysql_xdevapi/mysql_xdevapi/session/sql.xml index 54f5e2240..037ae34bf 100644 --- a/reference/mysql_xdevapi/mysql_xdevapi/session/sql.xml +++ b/reference/mysql_xdevapi/mysql_xdevapi/session/sql.xml @@ -13,10 +13,10 @@ public mysql_xdevapi\SqlStatementmysql_xdevapi\Session::sql stringquery - + Create a native SQL statement. Placeholders are supported using the native "?" syntax. Use the execute method to execute the SQL statement. - + @@ -25,9 +25,9 @@ query - + SQL statement to execute. - + @@ -35,9 +35,9 @@ &reftitle.returnvalues; - + An SqlStatement object. - + diff --git a/reference/mysql_xdevapi/mysql_xdevapi/session/starttransaction.xml b/reference/mysql_xdevapi/mysql_xdevapi/session/starttransaction.xml index a78b0fac0..12cdbdbc2 100644 --- a/reference/mysql_xdevapi/mysql_xdevapi/session/starttransaction.xml +++ b/reference/mysql_xdevapi/mysql_xdevapi/session/starttransaction.xml @@ -13,9 +13,9 @@ public voidmysql_xdevapi\Session::startTransaction - + Start a new transaction. - + @@ -25,9 +25,9 @@ &reftitle.returnvalues; - + An SqlStatementResult object. - + diff --git a/reference/mysql_xdevapi/mysql_xdevapi/sqlstatement/bind.xml b/reference/mysql_xdevapi/mysql_xdevapi/sqlstatement/bind.xml index 1abf9b188..002340079 100644 --- a/reference/mysql_xdevapi/mysql_xdevapi/sqlstatement/bind.xml +++ b/reference/mysql_xdevapi/mysql_xdevapi/sqlstatement/bind.xml @@ -13,9 +13,9 @@ public mysql_xdevapi\SqlStatementmysql_xdevapi\SqlStatement::bind stringparam - + - + &warn.undocumented.func; @@ -27,9 +27,9 @@ param - - - + + + @@ -37,9 +37,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/mysql_xdevapi/mysql_xdevapi/sqlstatement/construct.xml b/reference/mysql_xdevapi/mysql_xdevapi/sqlstatement/construct.xml index dfa2682ae..eb513e68e 100644 --- a/reference/mysql_xdevapi/mysql_xdevapi/sqlstatement/construct.xml +++ b/reference/mysql_xdevapi/mysql_xdevapi/sqlstatement/construct.xml @@ -13,9 +13,9 @@ private mysql_xdevapi\SqlStatement::__construct - + - + &warn.undocumented.func; @@ -32,7 +32,7 @@ &reftitle.returnvalues; - + --> diff --git a/reference/mysql_xdevapi/mysql_xdevapi/sqlstatement/execute.xml b/reference/mysql_xdevapi/mysql_xdevapi/sqlstatement/execute.xml index 129a35a9c..bdbf32e78 100644 --- a/reference/mysql_xdevapi/mysql_xdevapi/sqlstatement/execute.xml +++ b/reference/mysql_xdevapi/mysql_xdevapi/sqlstatement/execute.xml @@ -13,10 +13,10 @@ public mysql_xdevapi\Resultmysql_xdevapi\SqlStatement::execute - + + + - - &warn.undocumented.func; @@ -28,9 +28,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/mysql_xdevapi/mysql_xdevapi/sqlstatement/getnextresult.xml b/reference/mysql_xdevapi/mysql_xdevapi/sqlstatement/getnextresult.xml index e2cf22db0..35024efec 100644 --- a/reference/mysql_xdevapi/mysql_xdevapi/sqlstatement/getnextresult.xml +++ b/reference/mysql_xdevapi/mysql_xdevapi/sqlstatement/getnextresult.xml @@ -13,10 +13,10 @@ public mysql_xdevapi\Resultmysql_xdevapi\SqlStatement::getNextResult - + + + - - &warn.undocumented.func; @@ -28,9 +28,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/mysql_xdevapi/mysql_xdevapi/sqlstatement/getresult.xml b/reference/mysql_xdevapi/mysql_xdevapi/sqlstatement/getresult.xml index 20ded52c0..3d31ef940 100644 --- a/reference/mysql_xdevapi/mysql_xdevapi/sqlstatement/getresult.xml +++ b/reference/mysql_xdevapi/mysql_xdevapi/sqlstatement/getresult.xml @@ -13,10 +13,10 @@ public mysql_xdevapi\Resultmysql_xdevapi\SqlStatement::getResult - + + + - - &warn.undocumented.func; @@ -28,9 +28,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/mysql_xdevapi/mysql_xdevapi/sqlstatement/hasmoreresults.xml b/reference/mysql_xdevapi/mysql_xdevapi/sqlstatement/hasmoreresults.xml index b8a77407a..af3de6501 100644 --- a/reference/mysql_xdevapi/mysql_xdevapi/sqlstatement/hasmoreresults.xml +++ b/reference/mysql_xdevapi/mysql_xdevapi/sqlstatement/hasmoreresults.xml @@ -13,10 +13,10 @@ public boolmysql_xdevapi\SqlStatement::hasMoreResults - + + + - - &warn.undocumented.func; @@ -28,9 +28,9 @@ &reftitle.returnvalues; - + &true; if the result set has more objects to fetch. - + diff --git a/reference/mysql_xdevapi/mysql_xdevapi/sqlstatementresult/construct.xml b/reference/mysql_xdevapi/mysql_xdevapi/sqlstatementresult/construct.xml index 9d4f59854..13ec8d348 100644 --- a/reference/mysql_xdevapi/mysql_xdevapi/sqlstatementresult/construct.xml +++ b/reference/mysql_xdevapi/mysql_xdevapi/sqlstatementresult/construct.xml @@ -13,9 +13,9 @@ private mysql_xdevapi\SqlStatementResult::__construct - + - + &warn.undocumented.func; @@ -32,7 +32,7 @@ &reftitle.returnvalues; - + --> diff --git a/reference/mysql_xdevapi/mysql_xdevapi/sqlstatementresult/fetchall.xml b/reference/mysql_xdevapi/mysql_xdevapi/sqlstatementresult/fetchall.xml index daa235de5..a1b084aad 100644 --- a/reference/mysql_xdevapi/mysql_xdevapi/sqlstatementresult/fetchall.xml +++ b/reference/mysql_xdevapi/mysql_xdevapi/sqlstatementresult/fetchall.xml @@ -13,10 +13,10 @@ public arraymysql_xdevapi\SqlStatementResult::fetchAll - + Fetch all the rows from the result set. - - + + &warn.undocumented.func; @@ -28,11 +28,11 @@ &reftitle.returnvalues; - + A numerical array with all results from the query; each result is an associative array. An empty array is returned if no rows are present. - + diff --git a/reference/mysql_xdevapi/mysql_xdevapi/sqlstatementresult/fetchone.xml b/reference/mysql_xdevapi/mysql_xdevapi/sqlstatementresult/fetchone.xml index 86032d0cb..2281f3747 100644 --- a/reference/mysql_xdevapi/mysql_xdevapi/sqlstatementresult/fetchone.xml +++ b/reference/mysql_xdevapi/mysql_xdevapi/sqlstatementresult/fetchone.xml @@ -13,9 +13,9 @@ public arraymysql_xdevapi\SqlStatementResult::fetchOne - + Fetch one row from the result set. - + &warn.undocumented.func; @@ -28,10 +28,10 @@ &reftitle.returnvalues; - + The result, as an associative array. In case there is not any result, null will be returned. - + diff --git a/reference/mysql_xdevapi/mysql_xdevapi/sqlstatementresult/getaffecteditemscount.xml b/reference/mysql_xdevapi/mysql_xdevapi/sqlstatementresult/getaffecteditemscount.xml index 496c70d7d..c17d84b62 100644 --- a/reference/mysql_xdevapi/mysql_xdevapi/sqlstatementresult/getaffecteditemscount.xml +++ b/reference/mysql_xdevapi/mysql_xdevapi/sqlstatementresult/getaffecteditemscount.xml @@ -13,10 +13,10 @@ public intmysql_xdevapi\SqlStatementResult::getAffectedItemsCount - + + + - - &warn.undocumented.func; @@ -28,9 +28,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/mysql_xdevapi/mysql_xdevapi/sqlstatementresult/getcolumncount.xml b/reference/mysql_xdevapi/mysql_xdevapi/sqlstatementresult/getcolumncount.xml index d4b3eef8a..dcc1e186f 100644 --- a/reference/mysql_xdevapi/mysql_xdevapi/sqlstatementresult/getcolumncount.xml +++ b/reference/mysql_xdevapi/mysql_xdevapi/sqlstatementresult/getcolumncount.xml @@ -13,10 +13,10 @@ public intmysql_xdevapi\SqlStatementResult::getColumnsCount - + + + - - &warn.undocumented.func; @@ -28,9 +28,9 @@ &reftitle.returnvalues; - + The number of columns; 0 if there are none. - + diff --git a/reference/mysql_xdevapi/mysql_xdevapi/sqlstatementresult/getcolumnnames.xml b/reference/mysql_xdevapi/mysql_xdevapi/sqlstatementresult/getcolumnnames.xml index 48b0acd1f..66e4a0f33 100644 --- a/reference/mysql_xdevapi/mysql_xdevapi/sqlstatementresult/getcolumnnames.xml +++ b/reference/mysql_xdevapi/mysql_xdevapi/sqlstatementresult/getcolumnnames.xml @@ -13,10 +13,10 @@ public arraymysql_xdevapi\SqlStatementResult::getColumnNames - + + + - - &warn.undocumented.func; @@ -28,9 +28,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/mysql_xdevapi/mysql_xdevapi/sqlstatementresult/getcolumns.xml b/reference/mysql_xdevapi/mysql_xdevapi/sqlstatementresult/getcolumns.xml index 80844578c..02cb8a3ff 100644 --- a/reference/mysql_xdevapi/mysql_xdevapi/sqlstatementresult/getcolumns.xml +++ b/reference/mysql_xdevapi/mysql_xdevapi/sqlstatementresult/getcolumns.xml @@ -13,10 +13,10 @@ public Arraymysql_xdevapi\SqlStatementResult::getColumns - + + + - - &warn.undocumented.func; @@ -28,9 +28,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/mysql_xdevapi/mysql_xdevapi/sqlstatementresult/getgeneratedids.xml b/reference/mysql_xdevapi/mysql_xdevapi/sqlstatementresult/getgeneratedids.xml index 8ee7f7a41..e8ef3a400 100644 --- a/reference/mysql_xdevapi/mysql_xdevapi/sqlstatementresult/getgeneratedids.xml +++ b/reference/mysql_xdevapi/mysql_xdevapi/sqlstatementresult/getgeneratedids.xml @@ -13,10 +13,10 @@ public arraymysql_xdevapi\SqlStatementResult::getGeneratedIds - + + + - - &warn.undocumented.func; @@ -28,10 +28,10 @@ &reftitle.returnvalues; - - An array of generated _id's from the last operation, + + An array of generated _id's from the last operation, or an empty array if there are none. - + diff --git a/reference/mysql_xdevapi/mysql_xdevapi/sqlstatementresult/getlastinsertid.xml b/reference/mysql_xdevapi/mysql_xdevapi/sqlstatementresult/getlastinsertid.xml index e03544717..81c8a6a6b 100644 --- a/reference/mysql_xdevapi/mysql_xdevapi/sqlstatementresult/getlastinsertid.xml +++ b/reference/mysql_xdevapi/mysql_xdevapi/sqlstatementresult/getlastinsertid.xml @@ -13,10 +13,10 @@ public Stringmysql_xdevapi\SqlStatementResult::getLastInsertId - + + + - - &warn.undocumented.func; @@ -28,9 +28,9 @@ &reftitle.returnvalues; - + The ID for the last insert operation. - + diff --git a/reference/mysql_xdevapi/mysql_xdevapi/sqlstatementresult/getwarnings.xml b/reference/mysql_xdevapi/mysql_xdevapi/sqlstatementresult/getwarnings.xml index 5efacb90a..7108c076f 100644 --- a/reference/mysql_xdevapi/mysql_xdevapi/sqlstatementresult/getwarnings.xml +++ b/reference/mysql_xdevapi/mysql_xdevapi/sqlstatementresult/getwarnings.xml @@ -13,10 +13,10 @@ public arraymysql_xdevapi\SqlStatementResult::getWarnings - + + + - - &warn.undocumented.func; @@ -28,11 +28,11 @@ &reftitle.returnvalues; - + An array of Warning objects from the last operation. Each object defines an error 'message', error 'level', and error 'code'. An empty array is returned if no errors are present. - + diff --git a/reference/mysql_xdevapi/mysql_xdevapi/sqlstatementresult/getwarningscount.xml b/reference/mysql_xdevapi/mysql_xdevapi/sqlstatementresult/getwarningscount.xml index 82b4d2e79..679cb1181 100644 --- a/reference/mysql_xdevapi/mysql_xdevapi/sqlstatementresult/getwarningscount.xml +++ b/reference/mysql_xdevapi/mysql_xdevapi/sqlstatementresult/getwarningscount.xml @@ -13,10 +13,10 @@ public intmysql_xdevapi\SqlStatementResult::getWarningCounts - + + + - - &warn.undocumented.func; @@ -28,9 +28,9 @@ &reftitle.returnvalues; - + The number of warnings raised during the last CRUD operation. - + diff --git a/reference/mysql_xdevapi/mysql_xdevapi/sqlstatementresult/hasdata.xml b/reference/mysql_xdevapi/mysql_xdevapi/sqlstatementresult/hasdata.xml index 528e5912a..19d2c9b88 100644 --- a/reference/mysql_xdevapi/mysql_xdevapi/sqlstatementresult/hasdata.xml +++ b/reference/mysql_xdevapi/mysql_xdevapi/sqlstatementresult/hasdata.xml @@ -13,10 +13,10 @@ public boolmysql_xdevapi\SqlStatementResult::hasData - + + + - - &warn.undocumented.func; @@ -28,9 +28,9 @@ &reftitle.returnvalues; - + &true; if the result set has data. - + diff --git a/reference/mysql_xdevapi/mysql_xdevapi/sqlstatementresult/nextresult.xml b/reference/mysql_xdevapi/mysql_xdevapi/sqlstatementresult/nextresult.xml index 581961120..317255ae0 100644 --- a/reference/mysql_xdevapi/mysql_xdevapi/sqlstatementresult/nextresult.xml +++ b/reference/mysql_xdevapi/mysql_xdevapi/sqlstatementresult/nextresult.xml @@ -13,10 +13,10 @@ public mysql_xdevapi\Resultmysql_xdevapi\SqlStatementResult::nextResult - + + + - - &warn.undocumented.func; @@ -28,9 +28,9 @@ &reftitle.returnvalues; - + The next Result object from the result set. - + diff --git a/reference/mysql_xdevapi/mysql_xdevapi/statement/construct.xml b/reference/mysql_xdevapi/mysql_xdevapi/statement/construct.xml index e235fa52b..4dfeadcf0 100644 --- a/reference/mysql_xdevapi/mysql_xdevapi/statement/construct.xml +++ b/reference/mysql_xdevapi/mysql_xdevapi/statement/construct.xml @@ -13,9 +13,9 @@ private mysql_xdevapi\Statement::__construct - + - + &warn.undocumented.func; @@ -32,7 +32,7 @@ &reftitle.returnvalues; - + --> diff --git a/reference/mysql_xdevapi/mysql_xdevapi/statement/getnextresult.xml b/reference/mysql_xdevapi/mysql_xdevapi/statement/getnextresult.xml index 72e560545..352f6f9c1 100644 --- a/reference/mysql_xdevapi/mysql_xdevapi/statement/getnextresult.xml +++ b/reference/mysql_xdevapi/mysql_xdevapi/statement/getnextresult.xml @@ -13,10 +13,10 @@ public mysql_xdevapi\Resultmysql_xdevapi\Statement::getNextResult - + + + - - &warn.undocumented.func; @@ -28,9 +28,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/mysql_xdevapi/mysql_xdevapi/statement/getresult.xml b/reference/mysql_xdevapi/mysql_xdevapi/statement/getresult.xml index 928cf7cf9..f40b5b4e3 100644 --- a/reference/mysql_xdevapi/mysql_xdevapi/statement/getresult.xml +++ b/reference/mysql_xdevapi/mysql_xdevapi/statement/getresult.xml @@ -13,10 +13,10 @@ public mysql_xdevapi\Resultmysql_xdevapi\Statement::getResult - + + + - - &warn.undocumented.func; @@ -28,9 +28,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/mysql_xdevapi/mysql_xdevapi/statement/hasmoreresults.xml b/reference/mysql_xdevapi/mysql_xdevapi/statement/hasmoreresults.xml index 3c02231f0..b16d4a049 100644 --- a/reference/mysql_xdevapi/mysql_xdevapi/statement/hasmoreresults.xml +++ b/reference/mysql_xdevapi/mysql_xdevapi/statement/hasmoreresults.xml @@ -13,10 +13,10 @@ public boolmysql_xdevapi\Statement::hasMoreResults - + + + - - &warn.undocumented.func; @@ -28,9 +28,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/mysql_xdevapi/mysql_xdevapi/table/construct.xml b/reference/mysql_xdevapi/mysql_xdevapi/table/construct.xml index 95ede0175..510a99844 100644 --- a/reference/mysql_xdevapi/mysql_xdevapi/table/construct.xml +++ b/reference/mysql_xdevapi/mysql_xdevapi/table/construct.xml @@ -13,9 +13,9 @@ private mysql_xdevapi\Table::__construct - + Construct a table object. - + diff --git a/reference/mysql_xdevapi/mysql_xdevapi/table/count.xml b/reference/mysql_xdevapi/mysql_xdevapi/table/count.xml index d1d3bf03f..b1e784235 100644 --- a/reference/mysql_xdevapi/mysql_xdevapi/table/count.xml +++ b/reference/mysql_xdevapi/mysql_xdevapi/table/count.xml @@ -13,9 +13,9 @@ public intmysql_xdevapi\Table::count - + Fetch the number of rows in the table. - + @@ -26,9 +26,9 @@ &reftitle.returnvalues; - + The total number of rows in the table. - + diff --git a/reference/mysql_xdevapi/mysql_xdevapi/table/delete.xml b/reference/mysql_xdevapi/mysql_xdevapi/table/delete.xml index ca0b3a3c9..90857bc12 100644 --- a/reference/mysql_xdevapi/mysql_xdevapi/table/delete.xml +++ b/reference/mysql_xdevapi/mysql_xdevapi/table/delete.xml @@ -13,9 +13,9 @@ public mysql_xdevapi\TableDeletemysql_xdevapi\Table::delete - + Deletes rows from a table. - + @@ -25,9 +25,9 @@ &reftitle.returnvalues; - + A TableDelete object; use the execute() method to execute the delete query. - + diff --git a/reference/mysql_xdevapi/mysql_xdevapi/table/existsindatabase.xml b/reference/mysql_xdevapi/mysql_xdevapi/table/existsindatabase.xml index 78c75506c..60718b1c8 100644 --- a/reference/mysql_xdevapi/mysql_xdevapi/table/existsindatabase.xml +++ b/reference/mysql_xdevapi/mysql_xdevapi/table/existsindatabase.xml @@ -13,9 +13,9 @@ public boolmysql_xdevapi\Table::existsInDatabase - + Verifies if this table exists in the database. - + @@ -25,9 +25,9 @@ &reftitle.returnvalues; - + Returns &true; if table exists in the database, else &false; if it does not. - + diff --git a/reference/mysql_xdevapi/mysql_xdevapi/table/getname.xml b/reference/mysql_xdevapi/mysql_xdevapi/table/getname.xml index 0da195809..ab2f7ce18 100644 --- a/reference/mysql_xdevapi/mysql_xdevapi/table/getname.xml +++ b/reference/mysql_xdevapi/mysql_xdevapi/table/getname.xml @@ -13,9 +13,9 @@ public stringmysql_xdevapi\Table::getName - + Returns the name of this database object. - + @@ -26,9 +26,9 @@ &reftitle.returnvalues; - + The name of this database object. - + diff --git a/reference/mysql_xdevapi/mysql_xdevapi/table/getschema.xml b/reference/mysql_xdevapi/mysql_xdevapi/table/getschema.xml index 950f21c72..655beed30 100644 --- a/reference/mysql_xdevapi/mysql_xdevapi/table/getschema.xml +++ b/reference/mysql_xdevapi/mysql_xdevapi/table/getschema.xml @@ -13,9 +13,9 @@ public mysql_xdevapi\Schemamysql_xdevapi\Table::getSchema - + Fetch the schema associated with the table. - + @@ -26,9 +26,9 @@ &reftitle.returnvalues; - + A Schema object. - + diff --git a/reference/mysql_xdevapi/mysql_xdevapi/table/getsession.xml b/reference/mysql_xdevapi/mysql_xdevapi/table/getsession.xml index 96ac3e99f..e596c9152 100644 --- a/reference/mysql_xdevapi/mysql_xdevapi/table/getsession.xml +++ b/reference/mysql_xdevapi/mysql_xdevapi/table/getsession.xml @@ -13,9 +13,9 @@ public mysql_xdevapi\Sessionmysql_xdevapi\Table::getSession - + Get session associated with the table. - + @@ -26,9 +26,9 @@ &reftitle.returnvalues; - + A Session object. - + diff --git a/reference/mysql_xdevapi/mysql_xdevapi/table/insert.xml b/reference/mysql_xdevapi/mysql_xdevapi/table/insert.xml index 04ba68055..7be70f77c 100644 --- a/reference/mysql_xdevapi/mysql_xdevapi/table/insert.xml +++ b/reference/mysql_xdevapi/mysql_xdevapi/table/insert.xml @@ -14,9 +14,9 @@ mixedcolumns mixedmore_columns - + Inserts rows into a table. - + @@ -26,18 +26,18 @@ columns - + The columns to insert data into. Can be an array with one or more values, or a string. - + more_columns - + Additional columns definitions. - + @@ -45,9 +45,9 @@ &reftitle.returnvalues; - + A TableInsert object; use the execute() method to execute the insert statement. - + diff --git a/reference/mysql_xdevapi/mysql_xdevapi/table/isview.xml b/reference/mysql_xdevapi/mysql_xdevapi/table/isview.xml index 1c59136ab..09c0d8d73 100644 --- a/reference/mysql_xdevapi/mysql_xdevapi/table/isview.xml +++ b/reference/mysql_xdevapi/mysql_xdevapi/table/isview.xml @@ -12,9 +12,9 @@ public boolmysql_xdevapi\Table::isView - + Determine if the underlying object is a view or not. - + @@ -24,9 +24,9 @@ &reftitle.returnvalues; - + &true; if the underlying object is a view, otherwise &false;. - + diff --git a/reference/mysql_xdevapi/mysql_xdevapi/table/select.xml b/reference/mysql_xdevapi/mysql_xdevapi/table/select.xml index 5fd93814a..f47077128 100644 --- a/reference/mysql_xdevapi/mysql_xdevapi/table/select.xml +++ b/reference/mysql_xdevapi/mysql_xdevapi/table/select.xml @@ -14,9 +14,9 @@ mixedcolumns mixedmore_columns - + Fetches data from a table. - + @@ -26,18 +26,18 @@ columns - + The columns to select data from. Can be an array with one or more values, or a string. - + more_columns - + Additional columns parameter definitions. - + @@ -45,10 +45,10 @@ &reftitle.returnvalues; - + A TableSelect object; use the execute() method to execute the select and return a RowResult object. - + diff --git a/reference/mysql_xdevapi/mysql_xdevapi/table/update.xml b/reference/mysql_xdevapi/mysql_xdevapi/table/update.xml index 7c5f0d243..ed73d4d2c 100644 --- a/reference/mysql_xdevapi/mysql_xdevapi/table/update.xml +++ b/reference/mysql_xdevapi/mysql_xdevapi/table/update.xml @@ -13,9 +13,9 @@ public mysql_xdevapi\TableUpdatemysql_xdevapi\Table::update - + Updates columns in a table. - + @@ -26,9 +26,9 @@ &reftitle.returnvalues; - + A TableUpdate object; use the execute() method to execute the update statement. - + diff --git a/reference/mysql_xdevapi/mysql_xdevapi/tabledelete/bind.xml b/reference/mysql_xdevapi/mysql_xdevapi/tabledelete/bind.xml index e71bdb52e..5d3aa3364 100644 --- a/reference/mysql_xdevapi/mysql_xdevapi/tabledelete/bind.xml +++ b/reference/mysql_xdevapi/mysql_xdevapi/tabledelete/bind.xml @@ -13,9 +13,9 @@ public mysql_xdevapi\TableDeletemysql_xdevapi\TableDelete::bind arrayplaceholder_values - + Binds a value to a specific placeholder. - + @@ -25,9 +25,9 @@ placeholder_values - + The name of the placeholder and the value to bind. - + @@ -35,9 +35,9 @@ &reftitle.returnvalues; - + A TableDelete object. - + diff --git a/reference/mysql_xdevapi/mysql_xdevapi/tabledelete/construct.xml b/reference/mysql_xdevapi/mysql_xdevapi/tabledelete/construct.xml index 0979fb01e..5d9562e6b 100644 --- a/reference/mysql_xdevapi/mysql_xdevapi/tabledelete/construct.xml +++ b/reference/mysql_xdevapi/mysql_xdevapi/tabledelete/construct.xml @@ -13,9 +13,9 @@ private mysql_xdevapi\TableDelete::__construct - + Initiated by using the delete() method. - + diff --git a/reference/mysql_xdevapi/mysql_xdevapi/tabledelete/execute.xml b/reference/mysql_xdevapi/mysql_xdevapi/tabledelete/execute.xml index 4f394cf20..720ffe81f 100644 --- a/reference/mysql_xdevapi/mysql_xdevapi/tabledelete/execute.xml +++ b/reference/mysql_xdevapi/mysql_xdevapi/tabledelete/execute.xml @@ -13,9 +13,9 @@ public mysql_xdevapi\Resultmysql_xdevapi\TableDelete::execute - + Execute the delete query. - + @@ -26,9 +26,9 @@ &reftitle.returnvalues; - + A Result object. - + diff --git a/reference/mysql_xdevapi/mysql_xdevapi/tabledelete/limit.xml b/reference/mysql_xdevapi/mysql_xdevapi/tabledelete/limit.xml index 3b4a1fb1a..8459133db 100644 --- a/reference/mysql_xdevapi/mysql_xdevapi/tabledelete/limit.xml +++ b/reference/mysql_xdevapi/mysql_xdevapi/tabledelete/limit.xml @@ -13,9 +13,9 @@ public mysql_xdevapi\TableDeletemysql_xdevapi\TableDelete::limit introws - + Sets the maximum number of records or documents to delete. - + @@ -25,9 +25,9 @@ rows - + The maximum number of records or documents to delete. - + @@ -35,9 +35,9 @@ &reftitle.returnvalues; - + TableDelete object. - + diff --git a/reference/mysql_xdevapi/mysql_xdevapi/tabledelete/orderby.xml b/reference/mysql_xdevapi/mysql_xdevapi/tabledelete/orderby.xml index 4492f2b1a..e58f89a7a 100644 --- a/reference/mysql_xdevapi/mysql_xdevapi/tabledelete/orderby.xml +++ b/reference/mysql_xdevapi/mysql_xdevapi/tabledelete/orderby.xml @@ -13,9 +13,9 @@ public mysql_xdevapi\TableDeletemysql_xdevapi\TableDelete::orderby stringorderby_expr - + Set the order options for a result set. - + @@ -25,9 +25,9 @@ orderby_expr - + The sort definition. - + @@ -35,9 +35,9 @@ &reftitle.returnvalues; - + A TableDelete object. - + diff --git a/reference/mysql_xdevapi/mysql_xdevapi/tabledelete/where.xml b/reference/mysql_xdevapi/mysql_xdevapi/tabledelete/where.xml index b76a80049..adebdc6b5 100644 --- a/reference/mysql_xdevapi/mysql_xdevapi/tabledelete/where.xml +++ b/reference/mysql_xdevapi/mysql_xdevapi/tabledelete/where.xml @@ -13,9 +13,9 @@ public mysql_xdevapi\TableDeletemysql_xdevapi\TableDelete::where stringwhere_expr - + Sets the search condition to filter. - + @@ -25,9 +25,9 @@ where_expr - + Define the search condition to filter documents or records. - + @@ -35,9 +35,9 @@ &reftitle.returnvalues; - + TableDelete object. - + diff --git a/reference/mysql_xdevapi/mysql_xdevapi/tableinsert/construct.xml b/reference/mysql_xdevapi/mysql_xdevapi/tableinsert/construct.xml index 0053cb98d..1f7dab7a3 100644 --- a/reference/mysql_xdevapi/mysql_xdevapi/tableinsert/construct.xml +++ b/reference/mysql_xdevapi/mysql_xdevapi/tableinsert/construct.xml @@ -13,9 +13,9 @@ private mysql_xdevapi\TableInsert::__construct - + Initiated by using the insert() method. - + diff --git a/reference/mysql_xdevapi/mysql_xdevapi/tableinsert/execute.xml b/reference/mysql_xdevapi/mysql_xdevapi/tableinsert/execute.xml index 6c609b190..33e77924f 100644 --- a/reference/mysql_xdevapi/mysql_xdevapi/tableinsert/execute.xml +++ b/reference/mysql_xdevapi/mysql_xdevapi/tableinsert/execute.xml @@ -13,9 +13,9 @@ public mysql_xdevapi\Resultmysql_xdevapi\TableInsert::execute - + Execute the statement. - + @@ -26,9 +26,9 @@ &reftitle.returnvalues; - + A Result object. - + diff --git a/reference/mysql_xdevapi/mysql_xdevapi/tableinsert/values.xml b/reference/mysql_xdevapi/mysql_xdevapi/tableinsert/values.xml index 1ee3fd174..8adc507f1 100644 --- a/reference/mysql_xdevapi/mysql_xdevapi/tableinsert/values.xml +++ b/reference/mysql_xdevapi/mysql_xdevapi/tableinsert/values.xml @@ -13,9 +13,9 @@ public mysql_xdevapi\TableInsertmysql_xdevapi\TableInsert::values arrayrow_values - + Set the values to be inserted. - + @@ -25,9 +25,9 @@ row_values - + Values (an array) of columns to insert. - + @@ -35,9 +35,9 @@ &reftitle.returnvalues; - + A TableInsert object. - + diff --git a/reference/mysql_xdevapi/mysql_xdevapi/tableselect/bind.xml b/reference/mysql_xdevapi/mysql_xdevapi/tableselect/bind.xml index 236e6d40a..8f05fb956 100644 --- a/reference/mysql_xdevapi/mysql_xdevapi/tableselect/bind.xml +++ b/reference/mysql_xdevapi/mysql_xdevapi/tableselect/bind.xml @@ -13,9 +13,9 @@ public mysql_xdevapi\TableSelectmysql_xdevapi\TableSelect::bind arrayplaceholder_values - + Binds a value to a specific placeholder. - + @@ -25,9 +25,9 @@ placeholder_values - + The name of the placeholder, and the value to bind. - + @@ -35,9 +35,9 @@ &reftitle.returnvalues; - + A TableSelect object. - + diff --git a/reference/mysql_xdevapi/mysql_xdevapi/tableselect/construct.xml b/reference/mysql_xdevapi/mysql_xdevapi/tableselect/construct.xml index 490854d50..85c4cdeb7 100644 --- a/reference/mysql_xdevapi/mysql_xdevapi/tableselect/construct.xml +++ b/reference/mysql_xdevapi/mysql_xdevapi/tableselect/construct.xml @@ -13,10 +13,10 @@ private mysql_xdevapi\TableSelect::__construct - - An object returned by the select() method; use execute() to + + An object returned by the select() method; use execute() to execute the query. - + diff --git a/reference/mysql_xdevapi/mysql_xdevapi/tableselect/execute.xml b/reference/mysql_xdevapi/mysql_xdevapi/tableselect/execute.xml index a7ddab57d..e3628326d 100644 --- a/reference/mysql_xdevapi/mysql_xdevapi/tableselect/execute.xml +++ b/reference/mysql_xdevapi/mysql_xdevapi/tableselect/execute.xml @@ -13,9 +13,9 @@ public mysql_xdevapi\RowResultmysql_xdevapi\TableSelect::execute - + Execute the select statement by chaining it with the execute() method. - + @@ -26,9 +26,9 @@ &reftitle.returnvalues; - + A RowResult object. - + diff --git a/reference/mysql_xdevapi/mysql_xdevapi/tableselect/groupby.xml b/reference/mysql_xdevapi/mysql_xdevapi/tableselect/groupby.xml index 89de849eb..d3d40d641 100644 --- a/reference/mysql_xdevapi/mysql_xdevapi/tableselect/groupby.xml +++ b/reference/mysql_xdevapi/mysql_xdevapi/tableselect/groupby.xml @@ -13,9 +13,9 @@ public mysql_xdevapi\TableSelectmysql_xdevapi\TableSelect::groupBy mixedsort_expr - + Sets a grouping criteria for the result set. - + @@ -25,9 +25,9 @@ sort_expr - + The grouping criteria. - + @@ -35,9 +35,9 @@ &reftitle.returnvalues; - + A TableSelect object. - + diff --git a/reference/mysql_xdevapi/mysql_xdevapi/tableselect/having.xml b/reference/mysql_xdevapi/mysql_xdevapi/tableselect/having.xml index ac26f2b12..9699b079a 100644 --- a/reference/mysql_xdevapi/mysql_xdevapi/tableselect/having.xml +++ b/reference/mysql_xdevapi/mysql_xdevapi/tableselect/having.xml @@ -13,9 +13,9 @@ public mysql_xdevapi\TableSelectmysql_xdevapi\TableSelect::having stringsort_expr - + Sets a condition for records to consider in aggregate function operations. - + @@ -24,9 +24,9 @@ sort_expr - + A condition on the aggregate functions used on the grouping criteria. - + @@ -34,9 +34,9 @@ &reftitle.returnvalues; - + A TableSelect object. - + diff --git a/reference/mysql_xdevapi/mysql_xdevapi/tableselect/limit.xml b/reference/mysql_xdevapi/mysql_xdevapi/tableselect/limit.xml index d3a4270f7..cf642c874 100644 --- a/reference/mysql_xdevapi/mysql_xdevapi/tableselect/limit.xml +++ b/reference/mysql_xdevapi/mysql_xdevapi/tableselect/limit.xml @@ -13,9 +13,9 @@ public mysql_xdevapi\TableSelectmysql_xdevapi\TableSelect::limit introws - + Sets the maximum number of records or documents to return. - + @@ -25,9 +25,9 @@ rows - + The maximum number of records or documents. - + @@ -35,9 +35,9 @@ &reftitle.returnvalues; - + A TableSelect object. - + diff --git a/reference/mysql_xdevapi/mysql_xdevapi/tableselect/lockexclusive.xml b/reference/mysql_xdevapi/mysql_xdevapi/tableselect/lockexclusive.xml index 72625d33e..c4620c859 100644 --- a/reference/mysql_xdevapi/mysql_xdevapi/tableselect/lockexclusive.xml +++ b/reference/mysql_xdevapi/mysql_xdevapi/tableselect/lockexclusive.xml @@ -13,9 +13,9 @@ public mysql_xdevapi\TableSelectmysql_xdevapi\TableSelect::lockExclusive intlock_waiting_option - + Execute a read operation with EXCLUSIVE LOCK. Only one lock can be active at a time. - + @@ -25,14 +25,14 @@ lock_waiting_option - + The optional waiting option that defaults to MYSQLX_LOCK_DEFAULT. Valid values are: - + - MYSQLX_LOCK_DEFAULT - MYSQLX_LOCK_NOWAIT - MYSQLX_LOCK_SKIP_LOCKED + MYSQLX_LOCK_DEFAULT + MYSQLX_LOCK_NOWAIT + MYSQLX_LOCK_SKIP_LOCKED @@ -41,9 +41,9 @@ &reftitle.returnvalues; - + TableSelect object. - + diff --git a/reference/mysql_xdevapi/mysql_xdevapi/tableselect/lockshared.xml b/reference/mysql_xdevapi/mysql_xdevapi/tableselect/lockshared.xml index eeb9a03a2..fde94245e 100644 --- a/reference/mysql_xdevapi/mysql_xdevapi/tableselect/lockshared.xml +++ b/reference/mysql_xdevapi/mysql_xdevapi/tableselect/lockshared.xml @@ -13,9 +13,9 @@ public mysql_xdevapi\TableSelectmysql_xdevapi\TableSelect::lockShared intlock_waiting_option - + Execute a read operation with SHARED LOCK. Only one lock can be active at a time. - + @@ -25,14 +25,14 @@ lock_waiting_option - - The optional waiting option that defaults to MYSQLX_LOCK_DEFAULT. + + The optional waiting option that defaults to MYSQLX_LOCK_DEFAULT. Valid values are: - + - MYSQLX_LOCK_DEFAULT - MYSQLX_LOCK_NOWAIT - MYSQLX_LOCK_SKIP_LOCKED + MYSQLX_LOCK_DEFAULT + MYSQLX_LOCK_NOWAIT + MYSQLX_LOCK_SKIP_LOCKED @@ -41,9 +41,9 @@ &reftitle.returnvalues; - + A TableSelect object. - + diff --git a/reference/mysql_xdevapi/mysql_xdevapi/tableselect/offset.xml b/reference/mysql_xdevapi/mysql_xdevapi/tableselect/offset.xml index 1eb802653..7181fe1e8 100644 --- a/reference/mysql_xdevapi/mysql_xdevapi/tableselect/offset.xml +++ b/reference/mysql_xdevapi/mysql_xdevapi/tableselect/offset.xml @@ -13,9 +13,9 @@ public mysql_xdevapi\TableSelectmysql_xdevapi\TableSelect::offset intposition - + Skip given number of rows in result. - + @@ -25,9 +25,9 @@ position - + The limit offset. - + @@ -35,9 +35,9 @@ &reftitle.returnvalues; - + A TableSelect object. - + diff --git a/reference/mysql_xdevapi/mysql_xdevapi/tableselect/orderby.xml b/reference/mysql_xdevapi/mysql_xdevapi/tableselect/orderby.xml index 908e1537a..74df64203 100644 --- a/reference/mysql_xdevapi/mysql_xdevapi/tableselect/orderby.xml +++ b/reference/mysql_xdevapi/mysql_xdevapi/tableselect/orderby.xml @@ -14,9 +14,9 @@ mixedsort_expr mixedsort_exprs - + Sets the order by criteria. - + @@ -26,18 +26,18 @@ sort_expr - + The expressions that define the order by criteria. Can be an array with one or more expressions, or a string. - + sort_exprs - + Additional sort_expr parameters. - + @@ -45,9 +45,9 @@ &reftitle.returnvalues; - + A TableSelect object. - + diff --git a/reference/mysql_xdevapi/mysql_xdevapi/tableselect/where.xml b/reference/mysql_xdevapi/mysql_xdevapi/tableselect/where.xml index e0d062c73..1a55450b2 100644 --- a/reference/mysql_xdevapi/mysql_xdevapi/tableselect/where.xml +++ b/reference/mysql_xdevapi/mysql_xdevapi/tableselect/where.xml @@ -13,9 +13,9 @@ public mysql_xdevapi\TableSelectmysql_xdevapi\TableSelect::where stringwhere_expr - + Sets the search condition to filter. - + @@ -25,9 +25,9 @@ where_expr - + Define the search condition to filter documents or records. - + @@ -35,9 +35,9 @@ &reftitle.returnvalues; - + A TableSelect object. - + diff --git a/reference/mysql_xdevapi/mysql_xdevapi/tableupdate/bind.xml b/reference/mysql_xdevapi/mysql_xdevapi/tableupdate/bind.xml index c18830221..bc27dc38e 100644 --- a/reference/mysql_xdevapi/mysql_xdevapi/tableupdate/bind.xml +++ b/reference/mysql_xdevapi/mysql_xdevapi/tableupdate/bind.xml @@ -13,9 +13,9 @@ public mysql_xdevapi\TableUpdatemysql_xdevapi\TableUpdate::bind arrayplaceholder_values - + Binds a value to a specific placeholder. - + @@ -25,10 +25,10 @@ placeholder_values - + The name of the placeholder, and the value to bind, defined as a JSON array. - + @@ -36,9 +36,9 @@ &reftitle.returnvalues; - + A TableUpdate object. - + diff --git a/reference/mysql_xdevapi/mysql_xdevapi/tableupdate/construct.xml b/reference/mysql_xdevapi/mysql_xdevapi/tableupdate/construct.xml index baec3abb0..4543531db 100644 --- a/reference/mysql_xdevapi/mysql_xdevapi/tableupdate/construct.xml +++ b/reference/mysql_xdevapi/mysql_xdevapi/tableupdate/construct.xml @@ -13,9 +13,9 @@ private mysql_xdevapi\TableUpdate::__construct - + Initiated by using the update() method. - + diff --git a/reference/mysql_xdevapi/mysql_xdevapi/tableupdate/execute.xml b/reference/mysql_xdevapi/mysql_xdevapi/tableupdate/execute.xml index 65b78d235..a973ac426 100644 --- a/reference/mysql_xdevapi/mysql_xdevapi/tableupdate/execute.xml +++ b/reference/mysql_xdevapi/mysql_xdevapi/tableupdate/execute.xml @@ -13,9 +13,9 @@ public mysql_xdevapi\TableUpdatemysql_xdevapi\TableUpdate::execute - + Executes the update statement. - + @@ -26,9 +26,9 @@ &reftitle.returnvalues; - + A TableUpdate object. - + diff --git a/reference/mysql_xdevapi/mysql_xdevapi/tableupdate/limit.xml b/reference/mysql_xdevapi/mysql_xdevapi/tableupdate/limit.xml index 4140162ed..6e9ad6df2 100644 --- a/reference/mysql_xdevapi/mysql_xdevapi/tableupdate/limit.xml +++ b/reference/mysql_xdevapi/mysql_xdevapi/tableupdate/limit.xml @@ -13,9 +13,9 @@ public mysql_xdevapi\TableUpdatemysql_xdevapi\TableUpdate::limit introws - + Set the maximum number of records or documents update. - + @@ -25,9 +25,9 @@ rows - + The maximum number of records or documents to update. - + @@ -35,9 +35,9 @@ &reftitle.returnvalues; - + A TableUpdate object. - + diff --git a/reference/mysql_xdevapi/mysql_xdevapi/tableupdate/orderby.xml b/reference/mysql_xdevapi/mysql_xdevapi/tableupdate/orderby.xml index fa41d2f9e..8aff56e38 100644 --- a/reference/mysql_xdevapi/mysql_xdevapi/tableupdate/orderby.xml +++ b/reference/mysql_xdevapi/mysql_xdevapi/tableupdate/orderby.xml @@ -14,9 +14,9 @@ mixedorderby_expr mixedorderby_exprs - + Sets the sorting criteria. - + @@ -26,18 +26,18 @@ orderby_expr - + The expressions that define the order by criteria. Can be an array with one or more expressions, or a string. - + orderby_exprs - + Additional sort_expr parameters. - + @@ -45,9 +45,9 @@ &reftitle.returnvalues; - + TableUpdate object. - + diff --git a/reference/mysql_xdevapi/mysql_xdevapi/tableupdate/set.xml b/reference/mysql_xdevapi/mysql_xdevapi/tableupdate/set.xml index 684f5b8e1..3a06698fd 100644 --- a/reference/mysql_xdevapi/mysql_xdevapi/tableupdate/set.xml +++ b/reference/mysql_xdevapi/mysql_xdevapi/tableupdate/set.xml @@ -14,9 +14,9 @@ stringtable_field stringexpression_or_literal - + Updates the column value on records in a table. - + @@ -26,17 +26,17 @@ table_field - + The column name to be updated. - + expression_or_literal - + The value to be set on the specified column. - + @@ -44,9 +44,9 @@ &reftitle.returnvalues; - + TableUpdate object. - + diff --git a/reference/mysql_xdevapi/mysql_xdevapi/tableupdate/where.xml b/reference/mysql_xdevapi/mysql_xdevapi/tableupdate/where.xml index 7b967c6ea..f82a60dcd 100644 --- a/reference/mysql_xdevapi/mysql_xdevapi/tableupdate/where.xml +++ b/reference/mysql_xdevapi/mysql_xdevapi/tableupdate/where.xml @@ -13,9 +13,9 @@ public mysql_xdevapi\TableUpdatemysql_xdevapi\TableUpdate::where stringwhere_expr - + Set the search condition to filter. - + @@ -25,9 +25,9 @@ where_expr - + The search condition to filter documents or records. - + @@ -35,9 +35,9 @@ &reftitle.returnvalues; - + A TableUpdate object. - + diff --git a/reference/mysql_xdevapi/mysql_xdevapi/warning/construct.xml b/reference/mysql_xdevapi/mysql_xdevapi/warning/construct.xml index 3f7cbd9e4..877cbbe8f 100644 --- a/reference/mysql_xdevapi/mysql_xdevapi/warning/construct.xml +++ b/reference/mysql_xdevapi/mysql_xdevapi/warning/construct.xml @@ -13,9 +13,9 @@ private mysql_xdevapi\Warning::__construct - + - + &warn.undocumented.func; @@ -32,7 +32,7 @@ &reftitle.returnvalues; - + --> diff --git a/reference/mysql_xdevapi/setup.xml b/reference/mysql_xdevapi/setup.xml index 7905ccee8..bec37767b 100644 --- a/reference/mysql_xdevapi/setup.xml +++ b/reference/mysql_xdevapi/setup.xml @@ -6,27 +6,27 @@
    &reftitle.required; - - This extension requires a MySQL 8+ server with the X plugin + + This extension requires a MySQL 8+ server with the X plugin enabled (default). - - - Prerequisite libraries for compiling this extension are: + + + Prerequisite libraries for compiling this extension are: Boost (1.53.0 or higher), OpenSSL, and Protobuf. - +
    &reftitle.install; - + &pecl.moved; - + - + An example installation procedure on Ubuntu 18.04 with PHP 7.2: - + - + The pecl install command does not enable PHP extensions (by default) - and enabling PHP extensions can be done in several ways. + and enabling PHP extensions can be done in several ways. Another PHP 7.2 on Ubuntu 18.04 example: - + - + &pecl.info; &url.pecl.package;mysql_xdevapi. - +
    @@ -79,67 +79,67 @@ pdo_mysql
    Building / Compiling From Source - + Considerations for compiling this extension from source. - + - + The extension name is 'mysql_xdevapi', so use --enable-mysql-xdevapi. - + - + Boost: required, optionally use the --with-boost=DIR configure option or set the MYSQL_XDEVAPI_BOOST_ROOT environment variable. Only the boost header files are required; not the binaries. - + - + Google Protocol Buffers (protobuf): required, optionally use the --with-protobuf=DIR configure option or set the MYSQL_XDEVAPI_PROTOBUF_ROOT environment variable. - - + + Optionally use make protobufs to generate protobuf files (*.pb.cc/.h), and make clean-protobufs to delete generate protobuf files. - - + + Windows specific protobuf note: depending on your environment, the static library with a multi-threaded DLL runtime may be needed. To prepare, use the following options: -Dprotobuf_MSVC_STATIC_RUNTIME=OFF -Dprotobuf_BUILD_SHARED_LIBS=OFF - + - + Google Protocol Buffers / protocol compiler (protoc): required, ensure that proper 'protoc' is available in the PATH while building. It is especially important as Windows PHP SDK batch scripts may overwrite the environment. - + - + Bison: required, and available from the PATH. - - + + Windows specific bison note: we strongly recommended that bison delivered with the chosen PHP SDKis used else an error similar to "zend_globals_macros.h(39): error C2375: 'zendparse': redefinition; different linkage Zend/zend_language_parser.h(214): note: see declaration of 'zendparse'" may be the result. Also, Windows PHP SDK batch scripts may overwrite the environment. - + - + Windows Specific Notes: To prepare the environment, see the official - Windows build documentation for + Windows build documentation for the current SDK. - - + + We recommend using the backslash '\\' instead of a slash '/' for all paths. - +
    diff --git a/reference/oauth/book.xml b/reference/oauth/book.xml index ab305ef48..9d8bb7406 100644 --- a/reference/oauth/book.xml +++ b/reference/oauth/book.xml @@ -1,6 +1,6 @@ - + OAuth diff --git a/reference/oauth/configure.xml b/reference/oauth/configure.xml index 96dd50dff..29cb218c3 100644 --- a/reference/oauth/configure.xml +++ b/reference/oauth/configure.xml @@ -1,6 +1,6 @@ -
    +
    &reftitle.install; &pecl.info; diff --git a/reference/oauth/constants.xml b/reference/oauth/constants.xml index 60a9b0684..1382ecd41 100644 --- a/reference/oauth/constants.xml +++ b/reference/oauth/constants.xml @@ -1,6 +1,6 @@ - + &reftitle.constants; &extension.constants; diff --git a/reference/oauth/examples.xml b/reference/oauth/examples.xml index cd18f296a..2b5a50df2 100644 --- a/reference/oauth/examples.xml +++ b/reference/oauth/examples.xml @@ -1,6 +1,6 @@ - + &reftitle.examples;
    diff --git a/reference/oauth/functions/oauth-get-sbs.xml b/reference/oauth/functions/oauth-get-sbs.xml index 1f214dcd0..3ec985649 100644 --- a/reference/oauth/functions/oauth-get-sbs.xml +++ b/reference/oauth/functions/oauth-get-sbs.xml @@ -1,6 +1,6 @@ - + oauth_get_sbs Generate a Signature Base String diff --git a/reference/oauth/functions/oauth-urlencode.xml b/reference/oauth/functions/oauth-urlencode.xml index ed1bb5fbe..910bb917b 100644 --- a/reference/oauth/functions/oauth-urlencode.xml +++ b/reference/oauth/functions/oauth-urlencode.xml @@ -1,6 +1,6 @@ - + oauth_urlencode Encode a URI to RFC 3986 diff --git a/reference/oauth/oauth.xml b/reference/oauth/oauth.xml index 27bef25ec..732e29be8 100644 --- a/reference/oauth/oauth.xml +++ b/reference/oauth/oauth.xml @@ -1,6 +1,6 @@ - + The OAuth class OAuth diff --git a/reference/oauth/oauth/construct.xml b/reference/oauth/oauth/construct.xml index 503795e67..4d7a6ab6b 100644 --- a/reference/oauth/oauth/construct.xml +++ b/reference/oauth/oauth/construct.xml @@ -1,6 +1,6 @@ - + OAuth::__construct Create a new OAuth object diff --git a/reference/oauth/oauth/destruct.xml b/reference/oauth/oauth/destruct.xml index 65e73865b..247d92ce1 100644 --- a/reference/oauth/oauth/destruct.xml +++ b/reference/oauth/oauth/destruct.xml @@ -1,6 +1,6 @@ - + OAuth::__destruct The destructor diff --git a/reference/oauth/oauth/disabledebug.xml b/reference/oauth/oauth/disabledebug.xml index 6e6950d3e..7235171f8 100644 --- a/reference/oauth/oauth/disabledebug.xml +++ b/reference/oauth/oauth/disabledebug.xml @@ -1,6 +1,6 @@ - + OAuth::disableDebug Turn off verbose debugging diff --git a/reference/oauth/oauth/disableredirects.xml b/reference/oauth/oauth/disableredirects.xml index b04b4bc8c..97a0e6eed 100644 --- a/reference/oauth/oauth/disableredirects.xml +++ b/reference/oauth/oauth/disableredirects.xml @@ -1,6 +1,6 @@ - + OAuth::disableRedirects Turn off redirects diff --git a/reference/oauth/oauth/disablesslchecks.xml b/reference/oauth/oauth/disablesslchecks.xml index a5955ba1f..c8c19b29c 100644 --- a/reference/oauth/oauth/disablesslchecks.xml +++ b/reference/oauth/oauth/disablesslchecks.xml @@ -1,6 +1,6 @@ - + OAuth::disableSSLChecks Turn off SSL checks diff --git a/reference/oauth/oauth/enabledebug.xml b/reference/oauth/oauth/enabledebug.xml index 20a5517b8..31b5ea564 100644 --- a/reference/oauth/oauth/enabledebug.xml +++ b/reference/oauth/oauth/enabledebug.xml @@ -1,6 +1,6 @@ - + OAuth::enableDebug Turn on verbose debugging diff --git a/reference/oauth/oauth/enableredirects.xml b/reference/oauth/oauth/enableredirects.xml index 49575da8a..deb26faba 100644 --- a/reference/oauth/oauth/enableredirects.xml +++ b/reference/oauth/oauth/enableredirects.xml @@ -1,6 +1,6 @@ - + OAuth::enableRedirects Turn on redirects diff --git a/reference/oauth/oauth/enablesslchecks.xml b/reference/oauth/oauth/enablesslchecks.xml index 46840ac1e..7e9975198 100644 --- a/reference/oauth/oauth/enablesslchecks.xml +++ b/reference/oauth/oauth/enablesslchecks.xml @@ -1,6 +1,6 @@ - + OAuth::enableSSLChecks Turn on SSL checks diff --git a/reference/oauth/oauth/fetch.xml b/reference/oauth/oauth/fetch.xml index 5508d8ffc..611a27301 100644 --- a/reference/oauth/oauth/fetch.xml +++ b/reference/oauth/oauth/fetch.xml @@ -1,6 +1,6 @@ - + OAuth::fetch Fetch an OAuth protected resource diff --git a/reference/oauth/oauth/generatesignature.xml b/reference/oauth/oauth/generatesignature.xml index 62c21cfc2..95a8bdf65 100644 --- a/reference/oauth/oauth/generatesignature.xml +++ b/reference/oauth/oauth/generatesignature.xml @@ -1,6 +1,6 @@ - + OAuth::generateSignature Generate a signature diff --git a/reference/oauth/oauth/getaccesstoken.xml b/reference/oauth/oauth/getaccesstoken.xml index a89a5e4d1..c4aa60689 100644 --- a/reference/oauth/oauth/getaccesstoken.xml +++ b/reference/oauth/oauth/getaccesstoken.xml @@ -1,6 +1,6 @@ - + OAuth::getAccessToken Fetch an access token diff --git a/reference/oauth/oauth/getcapath.xml b/reference/oauth/oauth/getcapath.xml index 22f2513f0..764a06102 100644 --- a/reference/oauth/oauth/getcapath.xml +++ b/reference/oauth/oauth/getcapath.xml @@ -1,6 +1,6 @@ - + OAuth::getCAPath Gets CA information diff --git a/reference/oauth/oauth/getlastresponse.xml b/reference/oauth/oauth/getlastresponse.xml index 333e20e93..394abf5bf 100644 --- a/reference/oauth/oauth/getlastresponse.xml +++ b/reference/oauth/oauth/getlastresponse.xml @@ -1,6 +1,6 @@ - + OAuth::getLastResponse Get the last response diff --git a/reference/oauth/oauth/getlastresponseheaders.xml b/reference/oauth/oauth/getlastresponseheaders.xml index 1a1df9e29..0c10c33e9 100644 --- a/reference/oauth/oauth/getlastresponseheaders.xml +++ b/reference/oauth/oauth/getlastresponseheaders.xml @@ -1,6 +1,6 @@ - + OAuth::getLastResponseHeaders Get headers for last response diff --git a/reference/oauth/oauth/getlastresponseinfo.xml b/reference/oauth/oauth/getlastresponseinfo.xml index 221990d77..c62ecab97 100644 --- a/reference/oauth/oauth/getlastresponseinfo.xml +++ b/reference/oauth/oauth/getlastresponseinfo.xml @@ -1,6 +1,6 @@ - + OAuth::getLastResponseInfo Get HTTP information about the last response diff --git a/reference/oauth/oauth/getrequestheader.xml b/reference/oauth/oauth/getrequestheader.xml index df39f8f7a..fd8884d8f 100644 --- a/reference/oauth/oauth/getrequestheader.xml +++ b/reference/oauth/oauth/getrequestheader.xml @@ -1,6 +1,6 @@ - + OAuth::getRequestHeader Generate OAuth header string signature diff --git a/reference/oauth/oauth/getrequesttoken.xml b/reference/oauth/oauth/getrequesttoken.xml index e3fb021df..2d03dd490 100644 --- a/reference/oauth/oauth/getrequesttoken.xml +++ b/reference/oauth/oauth/getrequesttoken.xml @@ -1,6 +1,6 @@ - + OAuth::getRequestToken Fetch a request token diff --git a/reference/oauth/oauth/setauthtype.xml b/reference/oauth/oauth/setauthtype.xml index 2c7c1fbba..317771b94 100644 --- a/reference/oauth/oauth/setauthtype.xml +++ b/reference/oauth/oauth/setauthtype.xml @@ -1,6 +1,6 @@ - + OAuth::setAuthType Set authorization type diff --git a/reference/oauth/oauth/setcapath.xml b/reference/oauth/oauth/setcapath.xml index 4b15758c2..0e288c141 100644 --- a/reference/oauth/oauth/setcapath.xml +++ b/reference/oauth/oauth/setcapath.xml @@ -1,6 +1,6 @@ - + OAuth::setCAPath Set CA path and info diff --git a/reference/oauth/oauth/setnonce.xml b/reference/oauth/oauth/setnonce.xml index 342028afc..b37aea888 100644 --- a/reference/oauth/oauth/setnonce.xml +++ b/reference/oauth/oauth/setnonce.xml @@ -1,6 +1,6 @@ - + OAuth::setNonce Set the nonce for subsequent requests diff --git a/reference/oauth/oauth/setrequestengine.xml b/reference/oauth/oauth/setrequestengine.xml index 48f0e6cf2..5e96b1f38 100644 --- a/reference/oauth/oauth/setrequestengine.xml +++ b/reference/oauth/oauth/setrequestengine.xml @@ -1,6 +1,6 @@ - + OAuth::setRequestEngine The setRequestEngine purpose @@ -46,7 +46,7 @@ &reftitle.errors; - Emits an OAuthException exception if an invalid + Emits an OAuthException exception if an invalid request engine is chosen. @@ -72,7 +72,7 @@ $consumer->setRequestEngine(OAUTH_REQENGINE_STREAMS); Curl PHP streams - OAuthException + OAuthException diff --git a/reference/oauth/oauth/setrsacertificate.xml b/reference/oauth/oauth/setrsacertificate.xml index e05891e16..7e74ca231 100644 --- a/reference/oauth/oauth/setrsacertificate.xml +++ b/reference/oauth/oauth/setrsacertificate.xml @@ -1,6 +1,6 @@ - + OAuth::setRSACertificate Set the RSA certificate diff --git a/reference/oauth/oauth/setsslchecks.xml b/reference/oauth/oauth/setsslchecks.xml index 2a736bf9d..ab394d469 100644 --- a/reference/oauth/oauth/setsslchecks.xml +++ b/reference/oauth/oauth/setsslchecks.xml @@ -1,6 +1,6 @@ - + OAuth::setSSLChecks Tweak specific SSL checks for requests diff --git a/reference/oauth/oauth/settimestamp.xml b/reference/oauth/oauth/settimestamp.xml index 1d2c405c8..b5a6fad17 100644 --- a/reference/oauth/oauth/settimestamp.xml +++ b/reference/oauth/oauth/settimestamp.xml @@ -1,6 +1,6 @@ - + OAuth::setTimestamp Set the timestamp diff --git a/reference/oauth/oauth/settoken.xml b/reference/oauth/oauth/settoken.xml index c895962a9..da4f3c941 100644 --- a/reference/oauth/oauth/settoken.xml +++ b/reference/oauth/oauth/settoken.xml @@ -1,6 +1,6 @@ - + OAuth::setToken Sets the token and secret diff --git a/reference/oauth/oauth/setversion.xml b/reference/oauth/oauth/setversion.xml index 7f96fcce6..0a13ad8b0 100644 --- a/reference/oauth/oauth/setversion.xml +++ b/reference/oauth/oauth/setversion.xml @@ -1,6 +1,6 @@ - + OAuth::setVersion Set the OAuth version diff --git a/reference/oauth/oauthexception.xml b/reference/oauth/oauthexception.xml index 8f380b17d..b925e7475 100644 --- a/reference/oauth/oauthexception.xml +++ b/reference/oauth/oauthexception.xml @@ -1,6 +1,6 @@ - + OAuthException class OAuthException diff --git a/reference/oauth/oauthprovider.xml b/reference/oauth/oauthprovider.xml index 903528600..997b2d1a3 100644 --- a/reference/oauth/oauthprovider.xml +++ b/reference/oauth/oauthprovider.xml @@ -1,6 +1,6 @@ - + The OAuthProvider class OAuthProvider diff --git a/reference/oauth/oauthprovider/addrequiredparameter.xml b/reference/oauth/oauthprovider/addrequiredparameter.xml index ec694b532..e92229ae4 100644 --- a/reference/oauth/oauthprovider/addrequiredparameter.xml +++ b/reference/oauth/oauthprovider/addrequiredparameter.xml @@ -1,6 +1,6 @@ - + OAuthProvider::addRequiredParameter Add required parameters diff --git a/reference/oauth/oauthprovider/callconsumerhandler.xml b/reference/oauth/oauthprovider/callconsumerhandler.xml index 3df61cf04..b27f71124 100644 --- a/reference/oauth/oauthprovider/callconsumerhandler.xml +++ b/reference/oauth/oauthprovider/callconsumerhandler.xml @@ -1,6 +1,6 @@ - + OAuthProvider::callconsumerHandler Calls the consumerNonceHandler callback diff --git a/reference/oauth/oauthprovider/calltimestampnoncehandler.xml b/reference/oauth/oauthprovider/calltimestampnoncehandler.xml index 6b19bb822..e9dd15d21 100644 --- a/reference/oauth/oauthprovider/calltimestampnoncehandler.xml +++ b/reference/oauth/oauthprovider/calltimestampnoncehandler.xml @@ -1,6 +1,6 @@ - + OAuthProvider::callTimestampNonceHandler Calls the timestampNonceHandler callback diff --git a/reference/oauth/oauthprovider/calltokenhandler.xml b/reference/oauth/oauthprovider/calltokenhandler.xml index 050d3a9b0..8d2c89d5c 100644 --- a/reference/oauth/oauthprovider/calltokenhandler.xml +++ b/reference/oauth/oauthprovider/calltokenhandler.xml @@ -1,6 +1,6 @@ - + OAuthProvider::calltokenHandler Calls the tokenNonceHandler callback diff --git a/reference/oauth/oauthprovider/checkoauthrequest.xml b/reference/oauth/oauthprovider/checkoauthrequest.xml index 8b06ac3a8..0d648794c 100644 --- a/reference/oauth/oauthprovider/checkoauthrequest.xml +++ b/reference/oauth/oauthprovider/checkoauthrequest.xml @@ -1,6 +1,6 @@ - + OAuthProvider::checkOAuthRequest Check an oauth request diff --git a/reference/oauth/oauthprovider/construct.xml b/reference/oauth/oauthprovider/construct.xml index 466d414eb..c0f6bfd7f 100644 --- a/reference/oauth/oauthprovider/construct.xml +++ b/reference/oauth/oauthprovider/construct.xml @@ -1,6 +1,6 @@ - + OAuthProvider::__construct Constructs a new OAuthProvider object diff --git a/reference/oauth/oauthprovider/consumerhandler.xml b/reference/oauth/oauthprovider/consumerhandler.xml index 092d54172..6235a9d78 100644 --- a/reference/oauth/oauthprovider/consumerhandler.xml +++ b/reference/oauth/oauthprovider/consumerhandler.xml @@ -1,6 +1,6 @@ - + OAuthProvider::consumerHandler Set the consumerHandler handler callback diff --git a/reference/oauth/oauthprovider/generatetoken.xml b/reference/oauth/oauthprovider/generatetoken.xml index 344ccebb3..ee14c013d 100644 --- a/reference/oauth/oauthprovider/generatetoken.xml +++ b/reference/oauth/oauthprovider/generatetoken.xml @@ -1,6 +1,6 @@ - + OAuthProvider::generateToken Generate a random token diff --git a/reference/oauth/oauthprovider/is2leggedendpoint.xml b/reference/oauth/oauthprovider/is2leggedendpoint.xml index 5b02a339d..4e87f3f70 100644 --- a/reference/oauth/oauthprovider/is2leggedendpoint.xml +++ b/reference/oauth/oauthprovider/is2leggedendpoint.xml @@ -1,6 +1,6 @@ - + OAuthProvider::is2LeggedEndpoint is2LeggedEndpoint diff --git a/reference/oauth/oauthprovider/isrequesttokenendpoint.xml b/reference/oauth/oauthprovider/isrequesttokenendpoint.xml index 7b192c9fa..108e16531 100644 --- a/reference/oauth/oauthprovider/isrequesttokenendpoint.xml +++ b/reference/oauth/oauthprovider/isrequesttokenendpoint.xml @@ -1,6 +1,6 @@ - + OAuthProvider::isRequestTokenEndpoint Sets isRequestTokenEndpoint diff --git a/reference/oauth/oauthprovider/removerequiredparameter.xml b/reference/oauth/oauthprovider/removerequiredparameter.xml index b13fd4679..b6f255ea0 100644 --- a/reference/oauth/oauthprovider/removerequiredparameter.xml +++ b/reference/oauth/oauthprovider/removerequiredparameter.xml @@ -1,6 +1,6 @@ - + OAuthProvider::removeRequiredParameter Remove a required parameter diff --git a/reference/oauth/oauthprovider/reportproblem.xml b/reference/oauth/oauthprovider/reportproblem.xml index 109eab1a6..8b08dee13 100644 --- a/reference/oauth/oauthprovider/reportproblem.xml +++ b/reference/oauth/oauthprovider/reportproblem.xml @@ -1,6 +1,6 @@ - + OAuthProvider::reportProblem Report a problem @@ -14,7 +14,7 @@ boolsend_headers&true; - Pass in a problem as an OAuthException, with possible problems listed + Pass in a problem as an OAuthException, with possible problems listed in the OAuth constants section. @@ -29,7 +29,7 @@ oauthexception - The OAuthException. + The OAuthException. diff --git a/reference/oauth/oauthprovider/setparam.xml b/reference/oauth/oauthprovider/setparam.xml index 9504da506..b7e10ac97 100644 --- a/reference/oauth/oauthprovider/setparam.xml +++ b/reference/oauth/oauthprovider/setparam.xml @@ -1,6 +1,6 @@ - + OAuthProvider::setParam Set a parameter diff --git a/reference/oauth/oauthprovider/setrequesttokenpath.xml b/reference/oauth/oauthprovider/setrequesttokenpath.xml index 60aa80684..9bf690ddb 100644 --- a/reference/oauth/oauthprovider/setrequesttokenpath.xml +++ b/reference/oauth/oauthprovider/setrequesttokenpath.xml @@ -1,6 +1,6 @@ - + OAuthProvider::setRequestTokenPath Set request token path diff --git a/reference/oauth/oauthprovider/timestampnoncehandler.xml b/reference/oauth/oauthprovider/timestampnoncehandler.xml index ee8887666..3fd78fb96 100644 --- a/reference/oauth/oauthprovider/timestampnoncehandler.xml +++ b/reference/oauth/oauthprovider/timestampnoncehandler.xml @@ -1,6 +1,6 @@ - + OAuthProvider::timestampNonceHandler Set the timestampNonceHandler handler callback diff --git a/reference/oauth/oauthprovider/tokenhandler.xml b/reference/oauth/oauthprovider/tokenhandler.xml index 57093cc09..1ef86a462 100644 --- a/reference/oauth/oauthprovider/tokenhandler.xml +++ b/reference/oauth/oauthprovider/tokenhandler.xml @@ -1,6 +1,6 @@ - + OAuthProvider::tokenHandler Set the tokenHandler handler callback diff --git a/reference/oauth/setup.xml b/reference/oauth/setup.xml index e7f20effd..dec84ae31 100644 --- a/reference/oauth/setup.xml +++ b/reference/oauth/setup.xml @@ -1,6 +1,6 @@ - + &reftitle.setup;
    diff --git a/reference/openal/book.xml b/reference/openal/book.xml index a99175c2c..f79fb48c0 100644 --- a/reference/openal/book.xml +++ b/reference/openal/book.xml @@ -1,6 +1,6 @@ - + OpenAL Audio Bindings OpenAL diff --git a/reference/openal/configure.xml b/reference/openal/configure.xml index 3e9790e51..dacf20612 100644 --- a/reference/openal/configure.xml +++ b/reference/openal/configure.xml @@ -1,6 +1,6 @@ -
    +
    &reftitle.install; &pecl.moved; diff --git a/reference/openal/functions/openal-buffer-create.xml b/reference/openal/functions/openal-buffer-create.xml index 88a38b0d3..77625a09f 100644 --- a/reference/openal/functions/openal-buffer-create.xml +++ b/reference/openal/functions/openal-buffer-create.xml @@ -1,6 +1,6 @@ - + openal_buffer_create diff --git a/reference/openal/functions/openal-buffer-data.xml b/reference/openal/functions/openal-buffer-data.xml index ad23e7bec..d6dce3102 100644 --- a/reference/openal/functions/openal-buffer-data.xml +++ b/reference/openal/functions/openal-buffer-data.xml @@ -1,6 +1,6 @@ - + openal_buffer_data diff --git a/reference/openal/functions/openal-buffer-destroy.xml b/reference/openal/functions/openal-buffer-destroy.xml index 091b44905..482ffc5ff 100644 --- a/reference/openal/functions/openal-buffer-destroy.xml +++ b/reference/openal/functions/openal-buffer-destroy.xml @@ -1,6 +1,6 @@ - + openal_buffer_destroy diff --git a/reference/openal/functions/openal-buffer-get.xml b/reference/openal/functions/openal-buffer-get.xml index 1eb1523bc..62a663df0 100644 --- a/reference/openal/functions/openal-buffer-get.xml +++ b/reference/openal/functions/openal-buffer-get.xml @@ -1,6 +1,6 @@ - + openal_buffer_get diff --git a/reference/openal/functions/openal-buffer-loadwav.xml b/reference/openal/functions/openal-buffer-loadwav.xml index de0b68d02..1087456c5 100644 --- a/reference/openal/functions/openal-buffer-loadwav.xml +++ b/reference/openal/functions/openal-buffer-loadwav.xml @@ -1,6 +1,6 @@ - + openal_buffer_loadwav diff --git a/reference/openal/functions/openal-context-create.xml b/reference/openal/functions/openal-context-create.xml index 58c838897..00660728b 100644 --- a/reference/openal/functions/openal-context-create.xml +++ b/reference/openal/functions/openal-context-create.xml @@ -1,6 +1,6 @@ - + openal_context_create diff --git a/reference/openal/functions/openal-context-current.xml b/reference/openal/functions/openal-context-current.xml index 1dd4ea11d..6f8445f27 100644 --- a/reference/openal/functions/openal-context-current.xml +++ b/reference/openal/functions/openal-context-current.xml @@ -1,6 +1,6 @@ - + openal_context_current diff --git a/reference/openal/functions/openal-context-destroy.xml b/reference/openal/functions/openal-context-destroy.xml index 69dd09e25..c06938003 100644 --- a/reference/openal/functions/openal-context-destroy.xml +++ b/reference/openal/functions/openal-context-destroy.xml @@ -1,6 +1,6 @@ - + openal_context_destroy diff --git a/reference/openal/functions/openal-context-process.xml b/reference/openal/functions/openal-context-process.xml index 864e2fc8e..9337152b8 100644 --- a/reference/openal/functions/openal-context-process.xml +++ b/reference/openal/functions/openal-context-process.xml @@ -1,6 +1,6 @@ - + openal_context_process diff --git a/reference/openal/functions/openal-context-suspend.xml b/reference/openal/functions/openal-context-suspend.xml index 6733c13a1..932c466df 100644 --- a/reference/openal/functions/openal-context-suspend.xml +++ b/reference/openal/functions/openal-context-suspend.xml @@ -1,6 +1,6 @@ - + openal_context_suspend diff --git a/reference/openal/functions/openal-device-close.xml b/reference/openal/functions/openal-device-close.xml index 6b92a01c6..20c240a12 100644 --- a/reference/openal/functions/openal-device-close.xml +++ b/reference/openal/functions/openal-device-close.xml @@ -1,6 +1,6 @@ - + openal_device_close diff --git a/reference/openal/functions/openal-device-open.xml b/reference/openal/functions/openal-device-open.xml index 0582af84f..1d100df46 100644 --- a/reference/openal/functions/openal-device-open.xml +++ b/reference/openal/functions/openal-device-open.xml @@ -1,6 +1,6 @@ - + openal_device_open diff --git a/reference/openal/functions/openal-listener-get.xml b/reference/openal/functions/openal-listener-get.xml index bad4dba33..bdb162d63 100644 --- a/reference/openal/functions/openal-listener-get.xml +++ b/reference/openal/functions/openal-listener-get.xml @@ -1,6 +1,6 @@ - + openal_listener_get diff --git a/reference/openal/functions/openal-listener-set.xml b/reference/openal/functions/openal-listener-set.xml index 4b453cb3d..b5b9affc0 100644 --- a/reference/openal/functions/openal-listener-set.xml +++ b/reference/openal/functions/openal-listener-set.xml @@ -1,6 +1,6 @@ - + openal_listener_set diff --git a/reference/openal/functions/openal-source-create.xml b/reference/openal/functions/openal-source-create.xml index 6534db392..3c8e2b3f1 100644 --- a/reference/openal/functions/openal-source-create.xml +++ b/reference/openal/functions/openal-source-create.xml @@ -1,6 +1,6 @@ - + openal_source_create diff --git a/reference/openal/functions/openal-source-destroy.xml b/reference/openal/functions/openal-source-destroy.xml index ec0b7d69c..c304a3f0a 100644 --- a/reference/openal/functions/openal-source-destroy.xml +++ b/reference/openal/functions/openal-source-destroy.xml @@ -1,6 +1,6 @@ - + openal_source_destroy diff --git a/reference/openal/functions/openal-source-get.xml b/reference/openal/functions/openal-source-get.xml index 9cf9bb3e4..f4f2dbe99 100644 --- a/reference/openal/functions/openal-source-get.xml +++ b/reference/openal/functions/openal-source-get.xml @@ -1,6 +1,6 @@ - + openal_source_get diff --git a/reference/openal/functions/openal-source-pause.xml b/reference/openal/functions/openal-source-pause.xml index f6b600204..30d708d1c 100644 --- a/reference/openal/functions/openal-source-pause.xml +++ b/reference/openal/functions/openal-source-pause.xml @@ -1,6 +1,6 @@ - + openal_source_pause diff --git a/reference/openal/functions/openal-source-play.xml b/reference/openal/functions/openal-source-play.xml index ae999d7e4..8cee20655 100644 --- a/reference/openal/functions/openal-source-play.xml +++ b/reference/openal/functions/openal-source-play.xml @@ -1,6 +1,6 @@ - + openal_source_play diff --git a/reference/openal/functions/openal-source-rewind.xml b/reference/openal/functions/openal-source-rewind.xml index ccec745de..0abed9152 100644 --- a/reference/openal/functions/openal-source-rewind.xml +++ b/reference/openal/functions/openal-source-rewind.xml @@ -1,6 +1,6 @@ - + openal_source_rewind diff --git a/reference/openal/functions/openal-source-set.xml b/reference/openal/functions/openal-source-set.xml index 3ab6b5f85..77666dfa7 100644 --- a/reference/openal/functions/openal-source-set.xml +++ b/reference/openal/functions/openal-source-set.xml @@ -1,6 +1,6 @@ - + openal_source_set diff --git a/reference/openal/functions/openal-source-stop.xml b/reference/openal/functions/openal-source-stop.xml index a2ffd49c2..0afc28a68 100644 --- a/reference/openal/functions/openal-source-stop.xml +++ b/reference/openal/functions/openal-source-stop.xml @@ -1,6 +1,6 @@ - + openal_source_stop diff --git a/reference/openal/functions/openal-stream.xml b/reference/openal/functions/openal-stream.xml index 4c5dc9eea..afa35e5b1 100644 --- a/reference/openal/functions/openal-stream.xml +++ b/reference/openal/functions/openal-stream.xml @@ -1,6 +1,6 @@ - + openal_stream diff --git a/reference/openal/resources.xml b/reference/openal/resources.xml index a45474e9d..926b7b737 100644 --- a/reference/openal/resources.xml +++ b/reference/openal/resources.xml @@ -1,6 +1,6 @@ -
    +
    &reftitle.resources; diff --git a/reference/parallel/book.xml b/reference/parallel/book.xml index 923c45b7f..434899f95 100644 --- a/reference/parallel/book.xml +++ b/reference/parallel/book.xml @@ -1,6 +1,6 @@ - + parallel parallel diff --git a/reference/parallel/configure.xml b/reference/parallel/configure.xml index d170437eb..7e21336b8 100644 --- a/reference/parallel/configure.xml +++ b/reference/parallel/configure.xml @@ -1,6 +1,6 @@ -
    +
    &reftitle.install; diff --git a/reference/parallel/functional.xml b/reference/parallel/functional.xml index 1d0ae5251..0977a12fe 100644 --- a/reference/parallel/functional.xml +++ b/reference/parallel/functional.xml @@ -1,6 +1,6 @@ - + Functional API diff --git a/reference/parallel/functions/parallel.bootstrap.xml b/reference/parallel/functions/parallel.bootstrap.xml index 75473bd1f..991848dea 100644 --- a/reference/parallel/functions/parallel.bootstrap.xml +++ b/reference/parallel/functions/parallel.bootstrap.xml @@ -1,6 +1,6 @@ - + parallel\bootstrap Bootstrapping diff --git a/reference/parallel/functions/parallel.run.xml b/reference/parallel/functions/parallel.run.xml index 32c5e6cf3..46b86bd72 100644 --- a/reference/parallel/functions/parallel.run.xml +++ b/reference/parallel/functions/parallel.run.xml @@ -1,6 +1,6 @@ - + parallel\run Execution diff --git a/reference/parallel/parallel.channel.xml b/reference/parallel/parallel.channel.xml index 0867e97a8..8f54d2363 100644 --- a/reference/parallel/parallel.channel.xml +++ b/reference/parallel/parallel.channel.xml @@ -1,6 +1,6 @@ - + The parallel\Channel class parallel\Channel diff --git a/reference/parallel/parallel.events.event.xml b/reference/parallel/parallel.events.event.xml index 869fda5f4..b9052005c 100644 --- a/reference/parallel/parallel.events.event.xml +++ b/reference/parallel/parallel.events.event.xml @@ -1,6 +1,6 @@ - + The parallel\Events\Event class parallel\Events\Event diff --git a/reference/parallel/parallel.events.input.xml b/reference/parallel/parallel.events.input.xml index dd2e24a8a..543e43494 100644 --- a/reference/parallel/parallel.events.input.xml +++ b/reference/parallel/parallel.events.input.xml @@ -1,6 +1,6 @@ - + The parallel\Events\Input class parallel\Events\Input diff --git a/reference/parallel/parallel.events.xml b/reference/parallel/parallel.events.xml index b45d5e9f5..3ac851366 100644 --- a/reference/parallel/parallel.events.xml +++ b/reference/parallel/parallel.events.xml @@ -1,6 +1,6 @@ - + The parallel\Events class parallel\Events diff --git a/reference/parallel/parallel.future.xml b/reference/parallel/parallel.future.xml index 34204f3bf..2003e1d5f 100644 --- a/reference/parallel/parallel.future.xml +++ b/reference/parallel/parallel.future.xml @@ -1,6 +1,6 @@ - + The parallel\Future class parallel\Future diff --git a/reference/parallel/parallel.runtime.xml b/reference/parallel/parallel.runtime.xml index 2fe9d3574..c7cea934b 100644 --- a/reference/parallel/parallel.runtime.xml +++ b/reference/parallel/parallel.runtime.xml @@ -1,6 +1,6 @@ - + The parallel\Runtime class parallel\Runtime diff --git a/reference/parallel/parallel.sync.xml b/reference/parallel/parallel.sync.xml index 226ce0093..420518484 100644 --- a/reference/parallel/parallel.sync.xml +++ b/reference/parallel/parallel.sync.xml @@ -1,6 +1,6 @@ - + The parallel\Sync class parallel\Sync diff --git a/reference/parallel/parallel/channel/close.xml b/reference/parallel/parallel/channel/close.xml index 81abefb52..aee2c5317 100644 --- a/reference/parallel/parallel/channel/close.xml +++ b/reference/parallel/parallel/channel/close.xml @@ -1,6 +1,6 @@ - + parallel\Channel::close Closing diff --git a/reference/parallel/parallel/channel/construct.xml b/reference/parallel/parallel/channel/construct.xml index 69bd16713..68b22a973 100644 --- a/reference/parallel/parallel/channel/construct.xml +++ b/reference/parallel/parallel/channel/construct.xml @@ -1,6 +1,6 @@ - + parallel\Channel::__construct Channel Construction diff --git a/reference/parallel/parallel/channel/make.xml b/reference/parallel/parallel/channel/make.xml index 2559bf8c1..b75a59bc0 100644 --- a/reference/parallel/parallel/channel/make.xml +++ b/reference/parallel/parallel/channel/make.xml @@ -1,6 +1,6 @@ - + parallel\Channel::make Access diff --git a/reference/parallel/parallel/channel/open.xml b/reference/parallel/parallel/channel/open.xml index 1a117d431..1800e997f 100644 --- a/reference/parallel/parallel/channel/open.xml +++ b/reference/parallel/parallel/channel/open.xml @@ -1,6 +1,6 @@ - + parallel\Channel::open Access diff --git a/reference/parallel/parallel/channel/recv.xml b/reference/parallel/parallel/channel/recv.xml index 245a8de6e..e954ef89d 100644 --- a/reference/parallel/parallel/channel/recv.xml +++ b/reference/parallel/parallel/channel/recv.xml @@ -1,6 +1,6 @@ - + parallel\Channel::recv Sharing diff --git a/reference/parallel/parallel/channel/send.xml b/reference/parallel/parallel/channel/send.xml index fde8399f9..d22978a6d 100644 --- a/reference/parallel/parallel/channel/send.xml +++ b/reference/parallel/parallel/channel/send.xml @@ -1,6 +1,6 @@ - + parallel\Channel::send Sharing diff --git a/reference/parallel/parallel/events/addchannel.xml b/reference/parallel/parallel/events/addchannel.xml index ea780221d..dd4c98992 100644 --- a/reference/parallel/parallel/events/addchannel.xml +++ b/reference/parallel/parallel/events/addchannel.xml @@ -1,6 +1,6 @@ - + parallel\Events::addChannel Targets diff --git a/reference/parallel/parallel/events/addfuture.xml b/reference/parallel/parallel/events/addfuture.xml index 44365caa5..49651cce0 100644 --- a/reference/parallel/parallel/events/addfuture.xml +++ b/reference/parallel/parallel/events/addfuture.xml @@ -1,6 +1,6 @@ - + parallel\Events::addFuture Targets diff --git a/reference/parallel/parallel/events/poll.xml b/reference/parallel/parallel/events/poll.xml index 86074a52a..0cecc7a01 100644 --- a/reference/parallel/parallel/events/poll.xml +++ b/reference/parallel/parallel/events/poll.xml @@ -1,6 +1,6 @@ - + parallel\Events::poll Polling diff --git a/reference/parallel/parallel/events/remove.xml b/reference/parallel/parallel/events/remove.xml index 306f00f4c..021d6986d 100644 --- a/reference/parallel/parallel/events/remove.xml +++ b/reference/parallel/parallel/events/remove.xml @@ -1,6 +1,6 @@ - + parallel\Events::remove Targets diff --git a/reference/parallel/parallel/events/setblocking.xml b/reference/parallel/parallel/events/setblocking.xml index ef6bcee77..5e4b65179 100644 --- a/reference/parallel/parallel/events/setblocking.xml +++ b/reference/parallel/parallel/events/setblocking.xml @@ -1,6 +1,6 @@ - + parallel\Events::setBlocking Behaviour diff --git a/reference/parallel/parallel/events/setinput.xml b/reference/parallel/parallel/events/setinput.xml index df0324f75..695332e9a 100644 --- a/reference/parallel/parallel/events/setinput.xml +++ b/reference/parallel/parallel/events/setinput.xml @@ -1,6 +1,6 @@ - + parallel\Events::setInput Input diff --git a/reference/parallel/parallel/events/settimeout.xml b/reference/parallel/parallel/events/settimeout.xml index 6f4123b27..334369ab9 100644 --- a/reference/parallel/parallel/events/settimeout.xml +++ b/reference/parallel/parallel/events/settimeout.xml @@ -1,6 +1,6 @@ - + parallel\Events::setTimeout Behaviour diff --git a/reference/parallel/parallel/future/cancel.xml b/reference/parallel/parallel/future/cancel.xml index a658dd01c..4ea039b34 100644 --- a/reference/parallel/parallel/future/cancel.xml +++ b/reference/parallel/parallel/future/cancel.xml @@ -1,6 +1,6 @@ - + parallel\Future::cancel Cancellation diff --git a/reference/parallel/parallel/future/cancelled.xml b/reference/parallel/parallel/future/cancelled.xml index 855b2a7ff..1cc882146 100644 --- a/reference/parallel/parallel/future/cancelled.xml +++ b/reference/parallel/parallel/future/cancelled.xml @@ -1,6 +1,6 @@ - + parallel\Future::cancelled State Detection diff --git a/reference/parallel/parallel/future/done.xml b/reference/parallel/parallel/future/done.xml index ad17c3894..732d3ad8f 100644 --- a/reference/parallel/parallel/future/done.xml +++ b/reference/parallel/parallel/future/done.xml @@ -1,6 +1,6 @@ - + parallel\Future::done State Detection diff --git a/reference/parallel/parallel/future/value.xml b/reference/parallel/parallel/future/value.xml index d3f1e77f3..b9bb71a2f 100644 --- a/reference/parallel/parallel/future/value.xml +++ b/reference/parallel/parallel/future/value.xml @@ -1,6 +1,6 @@ - + parallel\Future::value Resolution diff --git a/reference/parallel/parallel/input/add.xml b/reference/parallel/parallel/input/add.xml index 618477679..904f6de98 100644 --- a/reference/parallel/parallel/input/add.xml +++ b/reference/parallel/parallel/input/add.xml @@ -1,6 +1,6 @@ - + parallel\Events\Input::add Inputs diff --git a/reference/parallel/parallel/input/clear.xml b/reference/parallel/parallel/input/clear.xml index af70b6762..1a1b7c520 100644 --- a/reference/parallel/parallel/input/clear.xml +++ b/reference/parallel/parallel/input/clear.xml @@ -1,6 +1,6 @@ - + parallel\Events\Input::clear Inputs diff --git a/reference/parallel/parallel/input/remove.xml b/reference/parallel/parallel/input/remove.xml index 23444d774..016190cce 100644 --- a/reference/parallel/parallel/input/remove.xml +++ b/reference/parallel/parallel/input/remove.xml @@ -1,6 +1,6 @@ - + parallel\Events\Input::remove Inputs diff --git a/reference/parallel/parallel/runtime/close.xml b/reference/parallel/parallel/runtime/close.xml index ab42e072d..b9b4c7f1a 100644 --- a/reference/parallel/parallel/runtime/close.xml +++ b/reference/parallel/parallel/runtime/close.xml @@ -1,6 +1,6 @@ - + parallel\Runtime::close Runtime Graceful Join diff --git a/reference/parallel/parallel/runtime/construct.xml b/reference/parallel/parallel/runtime/construct.xml index 1d4028352..33a4792a4 100644 --- a/reference/parallel/parallel/runtime/construct.xml +++ b/reference/parallel/parallel/runtime/construct.xml @@ -1,6 +1,6 @@ - + parallel\Runtime::__construct Runtime Construction diff --git a/reference/parallel/parallel/runtime/kill.xml b/reference/parallel/parallel/runtime/kill.xml index 69948af15..1c698f092 100644 --- a/reference/parallel/parallel/runtime/kill.xml +++ b/reference/parallel/parallel/runtime/kill.xml @@ -1,6 +1,6 @@ - + parallel\Runtime::kill Runtime Join diff --git a/reference/parallel/parallel/runtime/run.xml b/reference/parallel/parallel/runtime/run.xml index 39b06180a..9945fc2d7 100644 --- a/reference/parallel/parallel/runtime/run.xml +++ b/reference/parallel/parallel/runtime/run.xml @@ -1,6 +1,6 @@ - + parallel\Runtime::run Execution diff --git a/reference/parallel/parallel/sync/construct.xml b/reference/parallel/parallel/sync/construct.xml index 637f799ff..bfdf87458 100644 --- a/reference/parallel/parallel/sync/construct.xml +++ b/reference/parallel/parallel/sync/construct.xml @@ -1,6 +1,6 @@ - + parallel\Sync::__construct Construction diff --git a/reference/parallel/parallel/sync/get.xml b/reference/parallel/parallel/sync/get.xml index 8a40daf29..af9dcd918 100644 --- a/reference/parallel/parallel/sync/get.xml +++ b/reference/parallel/parallel/sync/get.xml @@ -1,6 +1,6 @@ - + parallel\Sync::get Access diff --git a/reference/parallel/parallel/sync/invoke.xml b/reference/parallel/parallel/sync/invoke.xml index 6903f5a17..7f758f895 100644 --- a/reference/parallel/parallel/sync/invoke.xml +++ b/reference/parallel/parallel/sync/invoke.xml @@ -1,6 +1,6 @@ - + parallel\Sync::__invoke Synchronization diff --git a/reference/parallel/parallel/sync/notify.xml b/reference/parallel/parallel/sync/notify.xml index 91adea8cc..9d4c04762 100644 --- a/reference/parallel/parallel/sync/notify.xml +++ b/reference/parallel/parallel/sync/notify.xml @@ -1,6 +1,6 @@ - + parallel\Sync::notify Synchronization diff --git a/reference/parallel/parallel/sync/set.xml b/reference/parallel/parallel/sync/set.xml index 543b6a634..b3a6d44cc 100644 --- a/reference/parallel/parallel/sync/set.xml +++ b/reference/parallel/parallel/sync/set.xml @@ -1,6 +1,6 @@ - + parallel\Sync::set Access diff --git a/reference/parallel/parallel/sync/wait.xml b/reference/parallel/parallel/sync/wait.xml index df573818f..f6ce79ee8 100644 --- a/reference/parallel/parallel/sync/wait.xml +++ b/reference/parallel/parallel/sync/wait.xml @@ -1,6 +1,6 @@ - + parallel\Sync::wait Synchronization diff --git a/reference/parallel/philosophy.xml b/reference/parallel/philosophy.xml index 28eebbfd3..079b22471 100644 --- a/reference/parallel/philosophy.xml +++ b/reference/parallel/philosophy.xml @@ -1,6 +1,6 @@ - + Philosophy This section contains philosophies important to writing parallel code and some details about the internal implementation of parallel. diff --git a/reference/parallel/setup.xml b/reference/parallel/setup.xml index 17b6c65b6..cf0d2b11e 100644 --- a/reference/parallel/setup.xml +++ b/reference/parallel/setup.xml @@ -1,6 +1,6 @@ - + Installation diff --git a/reference/parle/book.xml b/reference/parle/book.xml index 2e870489e..ae0807cfa 100644 --- a/reference/parle/book.xml +++ b/reference/parle/book.xml @@ -10,15 +10,15 @@ &reftitle.intro; &warn.experimental; - + The parle extension provides general purpose lexing and parsing facilities. The implementation is based on these libraries and requires a C++14 capable compiler. The lexer is based on the regex matching, the parser is LALR(1). Lexers and parsers are generated on the fly and can be used immediately after they've been finalized. Parle deals with parsing and lexing, the appropriate data structures representation and processing are the implementer's task. Serialization and code generation are not supported by the extension, yet. - - + + Lexer analysis is a process of splitting a character sequence into a list of lexemes. The lexeme list can be then used for the syntax analysis against a formal grammar. These operations are also known as lexing and parsing. This documentation doesn't aim to provide an exhaustive information on lexing and parsing. Good information in this regard is available on the numerous resources on the net. Several usage examples are included, to show the functionality. The extension is useful for PHP programmers both willing to learn or to utilize parsing and lexing. State machines and grammar parsing don't have to be implemented manually, these complex tasks are taken away by parle. Thanks to that, the development can be focused on the actual problem solving. - - + + The common use case for parle is, when a data format is too complex to be handled by the regex matching with PCRE. The practical application is herewith wide. Be it a specific data format, a behavior modification of existing functions, even an own programming language and beyond. The helper methods such as Parle\Lexer::dump to inspect the generated state machine, or Parle\Parser::dump to inspect the generated grammar, are useful. The method Parle\Parser::trace can also be used to track the parsing operation. - + &reference.parle.setup; diff --git a/reference/parle/configure.xml b/reference/parle/configure.xml index 8ff3be4a7..52fdb32ae 100644 --- a/reference/parle/configure.xml +++ b/reference/parle/configure.xml @@ -4,12 +4,12 @@
    &reftitle.install; - + &pecl.info; &url.pecl.package;parle - + + -
    diff --git a/reference/parle/examples.xml b/reference/parle/examples.xml index 62f8544fc..1c2bbb3c0 100644 --- a/reference/parle/examples.xml +++ b/reference/parle/examples.xml @@ -83,7 +83,7 @@ do { Simple calculator
    &reftitle.intro; - + The class represents detailed error information as supplied by Parle\Parser::errorInfo - +
    @@ -48,7 +48,7 @@ token - + &Methods; @@ -57,7 +57,7 @@
    - +
    &reftitle.properties; @@ -65,19 +65,19 @@ id - Error id. + Error id. position - Position in the input, where the error occurred. + Position in the input, where the error occurred. token - If applicable - the Parle\Token related to the error, otherwise &null;. + If applicable - the Parle\Token related to the error, otherwise &null;. diff --git a/reference/parle/parle.lexer.xml b/reference/parle/parle.lexer.xml index 33f51b8c2..47f0006ce 100644 --- a/reference/parle/parle.lexer.xml +++ b/reference/parle/parle.lexer.xml @@ -11,9 +11,9 @@
    &reftitle.intro; - + Single state lexer class. Lexemes can be defined on the fly. If the particular lexer instance is meant to be used with Parle\Parser, the token IDs need to be taken from there. Otherwise, arbitrary token IDs can be supplied. This lexer can give a certain performance advantage over Parle\RLexer, if no multiple states are required. Note, that Parle\RParser is not compatible with this lexer. - +
    @@ -110,35 +110,35 @@ Parle\Lexer::ICASE - + Parle\Lexer::DOT_NOT_LF - + Parle\Lexer::DOT_NOT_CRLF - + Parle\Lexer::SKIP_WS - + Parle\Lexer::MATCH_ZERO_LEN - + @@ -153,31 +153,31 @@ bol - Start of input flag. + Start of input flag. flags - Lexer flags. + Lexer flags. state - Current lexer state, readonly. + Current lexer state, readonly. marker - Position of the latest token match, readonly. + Position of the latest token match, readonly. cursor - Current input offset, readonly. + Current input offset, readonly. diff --git a/reference/parle/parle.lexerexception.xml b/reference/parle/parle.lexerexception.xml index 0dbdabfe4..f86f26790 100644 --- a/reference/parle/parle.lexerexception.xml +++ b/reference/parle/parle.lexerexception.xml @@ -11,9 +11,9 @@
    &reftitle.intro; - + - +
    @@ -29,12 +29,12 @@ Parle\LexerException - + extends Exception - + Throwable @@ -43,11 +43,11 @@ &InheritedProperties; - + &Methods; - + &InheritedMethods; diff --git a/reference/parle/parle.parser.xml b/reference/parle/parle.parser.xml index 192732ef8..2889c96a9 100644 --- a/reference/parle/parle.parser.xml +++ b/reference/parle/parle.parser.xml @@ -11,9 +11,9 @@
    &reftitle.intro; - + Parser class. Rules can be defined on the fly. Once finalized, a Parle\Lexer instance is required to deliver the token stream. - +
    @@ -110,56 +110,56 @@ Parle\Parser::ACTION_ERROR - + Parle\Parser::ACTION_SHIFT - + Parle\Parser::ACTION_REDUCE - + Parle\Parser::ACTION_GOTO - + Parle\Parser::ACTION_ACCEPT - + Parle\Parser::ERROR_SYNTAX - + Parle\Parser::ERROR_NON_ASSOCIATIVE - + Parle\Parser::ERROR_UNKNOWN_TOKEN - + @@ -174,13 +174,13 @@ action - Current parser action that matches one of the action class constants, readonly. + Current parser action that matches one of the action class constants, readonly. reduceId - Grammar rule id just processed in the reduce action. The value corresponds either to a token or to a production id. Readonly. + Grammar rule id just processed in the reduce action. The value corresponds either to a token or to a production id. Readonly. diff --git a/reference/parle/parle.parserexception.xml b/reference/parle/parle.parserexception.xml index 42e227b98..00fafc03a 100644 --- a/reference/parle/parle.parserexception.xml +++ b/reference/parle/parle.parserexception.xml @@ -11,9 +11,9 @@
    &reftitle.intro; - + - +
    @@ -29,12 +29,12 @@ Parle\ParserException - + extends Exception - + Throwable @@ -43,11 +43,11 @@ &InheritedProperties; - + &Methods; - + &InheritedMethods; diff --git a/reference/parle/parle.rlexer.xml b/reference/parle/parle.rlexer.xml index 7f476c66d..8748728b5 100644 --- a/reference/parle/parle.rlexer.xml +++ b/reference/parle/parle.rlexer.xml @@ -11,9 +11,9 @@
    &reftitle.intro; - + Multistate lexer class. Lexemes can be defined on the fly. If the particular lexer instance is meant to be used with Parle\RParser, the token IDs need to be taken from there. Otherwise, arbitrary token IDs can be supplied. Note, that Parle\Parser is not compatible with this lexer. - +
    @@ -110,35 +110,35 @@ Parle\RLexer::ICASE - + Parle\RLexer::DOT_NOT_LF - + Parle\RLexer::DOT_NOT_CRLF - + Parle\RLexer::SKIP_WS - + Parle\RLexer::MATCH_ZERO_LEN - + @@ -153,31 +153,31 @@ bol - Start of input flag. + Start of input flag. flags - Lexer flags. + Lexer flags. state - Current lexer state, readonly. + Current lexer state, readonly. marker - Position of the latest token match, readonly. + Position of the latest token match, readonly. cursor - Current input offset, readonly. + Current input offset, readonly. diff --git a/reference/parle/parle.rparser.xml b/reference/parle/parle.rparser.xml index 8f3cf28d7..9351c8a50 100644 --- a/reference/parle/parle.rparser.xml +++ b/reference/parle/parle.rparser.xml @@ -11,9 +11,9 @@
    &reftitle.intro; - + Parser class. Rules can be defined on the fly. Once finalized, a Parle\RLexer instance is required to deliver the token stream. - +
    @@ -110,56 +110,56 @@ Parle\RParser::ACTION_ERROR - + Parle\RParser::ACTION_SHIFT - + Parle\RParser::ACTION_REDUCE - + Parle\RParser::ACTION_GOTO - + Parle\RParser::ACTION_ACCEPT - + Parle\RParser::ERROR_SYNTAX - + Parle\RParser::ERROR_NON_ASSOCIATIVE - + Parle\RParser::ERROR_UNKNOWN_TOKEN - + @@ -174,13 +174,13 @@ action - Current parser action that matches one of the action class constants, readonly. + Current parser action that matches one of the action class constants, readonly. reduceId - Grammar rule id just processed in the reduce action. The value corresponds either to a token or to a production id. Readonly. + Grammar rule id just processed in the reduce action. The value corresponds either to a token or to a production id. Readonly. diff --git a/reference/parle/parle.stack.xml b/reference/parle/parle.stack.xml index 928abfa10..03ab3258e 100644 --- a/reference/parle/parle.stack.xml +++ b/reference/parle/parle.stack.xml @@ -11,9 +11,9 @@
    &reftitle.intro; - + Parle\Stack is a LIFO stack. The elements are inserted and removed only from one end. - +
    @@ -31,7 +31,7 @@ - + &Properties; public @@ -65,19 +65,19 @@ empty - Whether the stack is empty, readonly. + Whether the stack is empty, readonly. size - Stack size, readonly. + Stack size, readonly. top - Element on the top of the stack. + Element on the top of the stack. diff --git a/reference/parle/parle.token.xml b/reference/parle/parle.token.xml index d938c0413..99f322561 100644 --- a/reference/parle/parle.token.xml +++ b/reference/parle/parle.token.xml @@ -11,9 +11,9 @@
    &reftitle.intro; - + This class represents a token. Lexer returns instances of this class. - +
    @@ -80,13 +80,13 @@ id - Token id. + Token id. value - Token value. + Token value. @@ -102,21 +102,21 @@ Parle\Token::EOI - End of input token id. + End of input token id. Parle\Token::UNKNOWN - Unknown token id. + Unknown token id. Parle\Token::SKIP - Skip token id. + Skip token id. diff --git a/reference/parle/parle/lexer/advance.xml b/reference/parle/parle/lexer/advance.xml index 051a9c5e7..1bdca65be 100644 --- a/reference/parle/parle/lexer/advance.xml +++ b/reference/parle/parle/lexer/advance.xml @@ -13,9 +13,9 @@ public voidParle\Lexer::advance - + Processes the next rule and prepares the resulting token data. - + @@ -26,9 +26,9 @@ &reftitle.returnvalues; - - &return.void; - + + &return.void; + diff --git a/reference/parle/parle/lexer/build.xml b/reference/parle/parle/lexer/build.xml index 9575e551d..cd2e2e177 100644 --- a/reference/parle/parle/lexer/build.xml +++ b/reference/parle/parle/lexer/build.xml @@ -13,9 +13,9 @@ public voidParle\Lexer::build - + Rules, previously added with Parle\Lexer::push are finalized. This method call has to be done after all the necessary rules was pushed. The rule set becomes read only. The lexing can begin. - + @@ -25,9 +25,9 @@ &reftitle.returnvalues; - - &return.void; - + + &return.void; + diff --git a/reference/parle/parle/lexer/callout.xml b/reference/parle/parle/lexer/callout.xml index 989c6b3b3..d60b0b41d 100644 --- a/reference/parle/parle/lexer/callout.xml +++ b/reference/parle/parle/lexer/callout.xml @@ -14,9 +14,9 @@ intid callablecallback - + Define a callback to be invoked once lexer encounters a particular token. - + @@ -25,17 +25,17 @@ id - + Token id. - + callback - + Callable to be invoked. The callable doesn't receive any arguments and its return value is ignored. - + @@ -43,9 +43,9 @@ &reftitle.returnvalues; - - &return.void; - + + &return.void; + diff --git a/reference/parle/parle/lexer/consume.xml b/reference/parle/parle/lexer/consume.xml index 2018cf6a3..c36884ead 100644 --- a/reference/parle/parle/lexer/consume.xml +++ b/reference/parle/parle/lexer/consume.xml @@ -13,9 +13,9 @@ public voidParle\Lexer::consume stringdata - - Consume the data for lexing. - + + Consume the data for lexing. + @@ -24,9 +24,9 @@ data - - Data to be lexed. - + + Data to be lexed. + @@ -34,9 +34,9 @@ &reftitle.returnvalues; - - &return.void; - + + &return.void; + diff --git a/reference/parle/parle/lexer/dump.xml b/reference/parle/parle/lexer/dump.xml index 63f52ef62..165d2ade6 100644 --- a/reference/parle/parle/lexer/dump.xml +++ b/reference/parle/parle/lexer/dump.xml @@ -13,9 +13,9 @@ public voidParle\Lexer::dump - - Dump the current state machine to stdout. - + + Dump the current state machine to stdout. + @@ -25,9 +25,9 @@ &reftitle.returnvalues; - - &return.void; - + + &return.void; + diff --git a/reference/parle/parle/lexer/gettoken.xml b/reference/parle/parle/lexer/gettoken.xml index 79f1374eb..cd0e5440f 100644 --- a/reference/parle/parle/lexer/gettoken.xml +++ b/reference/parle/parle/lexer/gettoken.xml @@ -13,9 +13,9 @@ public Parle\TokenParle\Lexer::getToken - + Retrieve the current token. - + @@ -25,9 +25,9 @@ &reftitle.returnvalues; - - Returns an instance of Parle\Token. - + + Returns an instance of Parle\Token. + diff --git a/reference/parle/parle/lexer/insertmacro.xml b/reference/parle/parle/lexer/insertmacro.xml index 979dd723d..f746f3100 100644 --- a/reference/parle/parle/lexer/insertmacro.xml +++ b/reference/parle/parle/lexer/insertmacro.xml @@ -14,9 +14,9 @@ stringname stringregex - + Insert a regex macro, that can be later used as a shortcut and included in other regular expressions. - + @@ -25,17 +25,17 @@ name - + Name of the macros. - + regex - + Regular expression. - + @@ -43,9 +43,9 @@ &reftitle.returnvalues; - - &return.void; - + + &return.void; + diff --git a/reference/parle/parle/lexer/push.xml b/reference/parle/parle/lexer/push.xml index ee0e8519a..5b5f8f5d2 100644 --- a/reference/parle/parle/lexer/push.xml +++ b/reference/parle/parle/lexer/push.xml @@ -15,9 +15,9 @@ intid - + Push a pattern for lexeme recognition. - + @@ -26,17 +26,17 @@ regex - + Regular expression used for token matching. - + id - + Token id. If the lexer instance is meant to be used standalone, this can be an arbitrary number. If the lexer instance is going to be passed to the parser, it has to be an id returned by Parle\Parser::tokenid. - + -
    +
    &reftitle.install; To build the PDO_CUBRID extension, the CUBRID DBMS must be installed on the diff --git a/reference/pdo_cubrid/pdo_overloaded/cubrid-schema.xml b/reference/pdo_cubrid/pdo_overloaded/cubrid-schema.xml index b2339b268..101e886c8 100644 --- a/reference/pdo_cubrid/pdo_overloaded/cubrid-schema.xml +++ b/reference/pdo_cubrid/pdo_overloaded/cubrid-schema.xml @@ -1,7 +1,7 @@ - + PDO::cubrid_schema Get the requested schema information diff --git a/reference/pdo_cubrid/reference.xml b/reference/pdo_cubrid/reference.xml index 106d90496..409e67de0 100644 --- a/reference/pdo_cubrid/reference.xml +++ b/reference/pdo_cubrid/reference.xml @@ -1,5 +1,5 @@ - + CUBRID PDO Driver (PDO_CUBRID) CUBRID PDO Driver @@ -250,9 +250,9 @@ var_Dump($ret); DSN prefix - + The DSN prefix is cubrid:. - + diff --git a/reference/pdo_ibm/configure.xml b/reference/pdo_ibm/configure.xml index 1f62f321d..dd21f5094 100644 --- a/reference/pdo_ibm/configure.xml +++ b/reference/pdo_ibm/configure.xml @@ -2,23 +2,23 @@
    &reftitle.install; - - To build the PDO_IBM extension, the DB2 Client v9.1 or later must be - installed on the same system as PHP. The DB2 Client can be downloaded - from the IBM Application Development + + To build the PDO_IBM extension, the DB2 Client v9.1 or later must be + installed on the same system as PHP. The DB2 Client can be downloaded + from the IBM Application Development Site. - + Note - - The DB2 Client v9.1 or later supports direct access to DB2 for Linux, + + The DB2 Client v9.1 or later supports direct access to DB2 for Linux, UNIX, and Windows v8 and v9.1 servers. - - - The DB2 Client v9.1 also supports access to DB2 UDB for i5 and DB2 UDB - for z/OS servers using the separately purchased DB2 + + + The DB2 Client v9.1 also supports access to DB2 UDB for i5 and DB2 UDB + for z/OS servers using the separately purchased DB2 Connect product. - + PDO_IBM is a &link.pecl; extension, so follow the instructions in @@ -30,7 +30,7 @@ bash$ ./configure --with-pdo-ibm=/path/to/sqllib[,shared] ]]> - The configure command defaults to the value of the + The configure command defaults to the value of the DB2DIR environment variable.
    diff --git a/reference/pdo_ibm/ini.xml b/reference/pdo_ibm/ini.xml index f036a85b1..1406288b4 100644 --- a/reference/pdo_ibm/ini.xml +++ b/reference/pdo_ibm/ini.xml @@ -53,14 +53,14 @@ UTF-8 sequences), but may be needed if truncated data is returned. - + 0 - Minimum size buffers are allocated. - + - + 1 - Larger size buffers are allocated. - +     @@ -72,15 +72,15 @@ int - + The ASCII CCSID to use for conversion from EBCDIC on IBM i. Setting this to 1208 will use UTF-8. By default, this is 0, which will select the default ASCII job CCSID. - - + + To learn more about CCSIDs on IBM i, consult the IBM documentation. - + diff --git a/reference/pdo_ibm/reference.xml b/reference/pdo_ibm/reference.xml index 2af541fa5..38fdf652e 100644 --- a/reference/pdo_ibm/reference.xml +++ b/reference/pdo_ibm/reference.xml @@ -7,10 +7,10 @@
    &reftitle.intro; - + PDO_IBM is a driver that implements the PHP Data Objects (PDO) interface to enable access from PHP to IBM databases. - +
    @@ -35,9 +35,9 @@ DSN prefix - + The DSN prefix is ibm:. - + @@ -47,16 +47,16 @@ The DSN can be any of the following: - + a) Data source setup using db2cli.ini or odbc.ini - + - + b) Catalogued database name i.e. database alias in the DB2 client catalog - + @@ -67,43 +67,43 @@ database - + The name of the database. - + hostname - + The hostname or IP address of the database server. - + port - + The TCP/IP port on which the database is listening for requests. - + username - + The username with which you are connecting to the database. - + password - + The password with which you are connecting to the database. - + diff --git a/reference/pdo_informix/configure.xml b/reference/pdo_informix/configure.xml index 0137a6d14..cd05347cd 100644 --- a/reference/pdo_informix/configure.xml +++ b/reference/pdo_informix/configure.xml @@ -2,12 +2,12 @@
    &reftitle.install; - + To build the PDO_INFORMIX extension, the Informix Client SDK 2.81 UC1 or higher must be installed on the same system as PHP. The Informix Client SDK is available from the IBM Informix Support Site. - + PDO_INFORMIX is a &link.pecl; extension, so follow the instructions in to install the PDO_INFORMIX extension. diff --git a/reference/pdo_informix/reference.xml b/reference/pdo_informix/reference.xml index 6f82a5b61..c5c1335b1 100644 --- a/reference/pdo_informix/reference.xml +++ b/reference/pdo_informix/reference.xml @@ -7,10 +7,10 @@
    &reftitle.intro; - + PDO_INFORMIX is a driver that implements the PHP Data Objects (PDO) interface to enable access from PHP to Informix databases. - +
    @@ -18,14 +18,14 @@
    Scrollable cursors - + PDO_INFORMIX supports scrollable cursors; however, they are not enabled by default. To enable scrollable cursor support, you must either set ENABLESCROLLABLECURSORS=1 in the corresponding ODBC connection settings in odbc.ini or pass the EnableScrollableCursors=1 clause in the DSN connection string. - +
    @@ -47,19 +47,19 @@ DSN prefix - + The DSN prefix is informix:. - + DSN - + The DSN can be either a data source setup using odbc.ini or a complete connection string. - + diff --git a/reference/pdo_sqlsrv/configure.xml b/reference/pdo_sqlsrv/configure.xml index 7a2cbbaa3..79fb17e2d 100644 --- a/reference/pdo_sqlsrv/configure.xml +++ b/reference/pdo_sqlsrv/configure.xml @@ -1,6 +1,6 @@ -
    +
    &reftitle.install; The most recent version of the driver is available for download here: diff --git a/reference/pdo_sqlsrv/constants.xml b/reference/pdo_sqlsrv/constants.xml index 8258a7db1..0e756dded 100644 --- a/reference/pdo_sqlsrv/constants.xml +++ b/reference/pdo_sqlsrv/constants.xml @@ -11,8 +11,8 @@ - This constant is an acceptable value for the SQLSRV DSN key TransactionIsolation. - This constant sets the transaction isolation level for the connection to + This constant is an acceptable value for the SQLSRV DSN key TransactionIsolation. + This constant sets the transaction isolation level for the connection to Read Uncommitted. @@ -24,8 +24,8 @@ - This constant is an acceptable value for the SQLSRV DSN key TransactionIsolation. - This constant sets the transaction isolation level for the connection to + This constant is an acceptable value for the SQLSRV DSN key TransactionIsolation. + This constant sets the transaction isolation level for the connection to Read Committed. @@ -37,8 +37,8 @@ - This constant is an acceptable value for the SQLSRV DSN key TransactionIsolation. - This constant sets the transaction isolation level for the connection to + This constant is an acceptable value for the SQLSRV DSN key TransactionIsolation. + This constant sets the transaction isolation level for the connection to Repeateable Read. @@ -50,7 +50,7 @@ - This constant is an acceptable value for the SQLSRV DSN key TransactionIsolation. + This constant is an acceptable value for the SQLSRV DSN key TransactionIsolation. This constant sets the transaction isolation level for the connection to Snapshot. @@ -62,8 +62,8 @@ - This constant is an acceptable value for the SQLSRV DSN key TransactionIsolation. - This constant sets the transaction isolation level for the connection to + This constant is an acceptable value for the SQLSRV DSN key TransactionIsolation. + This constant sets the transaction isolation level for the connection to Serializable. @@ -75,9 +75,9 @@ - Specifies that data is sent/retrieved as a raw byte stream to/from the server - without performing encoding or translation. This constant can be passed to - PDOStatement::setAttribute, PDO::prepare, PDOStatement::bindColumn, and + Specifies that data is sent/retrieved as a raw byte stream to/from the server + without performing encoding or translation. This constant can be passed to + PDOStatement::setAttribute, PDO::prepare, PDOStatement::bindColumn, and PDOStatement::bindParam. @@ -89,11 +89,11 @@ - Specifies that data is sent/retrieved to/from the server as 8-bit characters - as specified in the code page of the Windows locale that is set on the system. - Any multi-byte characters or characters that do not map into this code page - are substituted with a single byte question mark (?) character. This constant - can be passed to PDOStatement::setAttribute, PDO::setAttribute, PDO::prepare, + Specifies that data is sent/retrieved to/from the server as 8-bit characters + as specified in the code page of the Windows locale that is set on the system. + Any multi-byte characters or characters that do not map into this code page + are substituted with a single byte question mark (?) character. This constant + can be passed to PDOStatement::setAttribute, PDO::setAttribute, PDO::prepare, PDOStatement::bindColumn, and PDOStatement::bindParam. @@ -105,9 +105,9 @@ - Specifies that data is sent/retrieved to/from the server in UTF-8 encoding. - This is the default encoding. This constant can be passed to - PDOStatement::setAttribute, PDO::setAttribute, PDO::prepare, + Specifies that data is sent/retrieved to/from the server in UTF-8 encoding. + This is the default encoding. This constant can be passed to + PDOStatement::setAttribute, PDO::setAttribute, PDO::prepare, PDOStatement::bindColumn, and PDOStatement::bindParam. @@ -119,10 +119,10 @@ - Specifies that data is sent/retrieved to/from the server according to - PDO::SQLSRV_ENCODING_SYSTEM if specified during connection. The connection's - encoding is used if specified in a prepare statement. This constant can be - passed to PDOStatement::setAttribute, PDO::setAttribute, PDO::prepare, + Specifies that data is sent/retrieved to/from the server according to + PDO::SQLSRV_ENCODING_SYSTEM if specified during connection. The connection's + encoding is used if specified in a prepare statement. This constant can be + passed to PDOStatement::setAttribute, PDO::setAttribute, PDO::prepare, PDOStatement::bindColumn, and PDOStatement::bindParam. @@ -134,8 +134,8 @@ - A non-negative integer representing the timeout period, in seconds. Zero (0) - is the default and means no timeout. This constant can be passed to + A non-negative integer representing the timeout period, in seconds. Zero (0) + is the default and means no timeout. This constant can be passed to PDOStatement::setAttribute, PDO::setAttribute, and PDO::prepare. @@ -147,9 +147,9 @@ - Indicates that a query should be executed directly, without being prepared. - This constant can be passed to PDO::setAttribute, and PDO::prepare. For more - information, see + Indicates that a query should be executed directly, without being prepared. + This constant can be passed to PDO::setAttribute, and PDO::prepare. For more + information, see Direct and Prepared Statement Execution. diff --git a/reference/pdo_sqlsrv/reference.xml b/reference/pdo_sqlsrv/reference.xml index f54186f2b..5e5a0b68f 100644 --- a/reference/pdo_sqlsrv/reference.xml +++ b/reference/pdo_sqlsrv/reference.xml @@ -1,5 +1,5 @@ - + Microsoft SQL Server PDO Driver (PDO_SQLSRV) MS SQL Server PDO Driver @@ -32,9 +32,9 @@ DSN prefix - + The DSN prefix is sqlsrv:. - + diff --git a/reference/ps/book.xml b/reference/ps/book.xml index ae6d2cba9..c54d0a8a9 100644 --- a/reference/ps/book.xml +++ b/reference/ps/book.xml @@ -1,31 +1,31 @@ - + PostScript document creation PS - + &reftitle.intro; - + This module allows to create PostScript documents. It has many similarities with the pdf extension. Actually the API is almost identical and one can in many cases just replace the prefix of each function from pdf_ to ps_. This also works for functions which has no meaning in the PostScript document (like adding hyperlinks) but will have an effect if the document is converted to PDF. - - Documents created by this extension are sometimes even superior + + Documents created by this extension are sometimes even superior to documents created with the pdf extension, because pslib's text rendering functions can handle kerning, hyphenation and ligatures which results in much better output of boxed text. - + - + &reference.ps.setup; &reference.ps.constants; &reference.ps.reference; diff --git a/reference/ps/configure.xml b/reference/ps/configure.xml index 63b384c73..c5c46e3bc 100644 --- a/reference/ps/configure.xml +++ b/reference/ps/configure.xml @@ -2,10 +2,10 @@
    &reftitle.install; - + &pecl.info; &url.pecl.package;ps. - +
    diff --git a/reference/ps/functions/ps-add-bookmark.xml b/reference/ps/functions/ps-add-bookmark.xml index 8ef8002e2..1c63bc9db 100644 --- a/reference/ps/functions/ps-add-bookmark.xml +++ b/reference/ps/functions/ps-add-bookmark.xml @@ -16,11 +16,11 @@ intparent0 intopen0 - + Adds a bookmark for the current page. Bookmarks usually appear in PDF-Viewers left of the page in a hierarchical tree. Clicking on a bookmark will jump to the given page. - + &ps.note.visible; @@ -31,36 +31,36 @@ psdoc - + Resource identifier of the postscript file as returned by ps_new. - + text - + The text used for displaying the bookmark. - + parent - + A bookmark previously created by this function which is used as the parent of the new bookmark. - + open - + If open is unequal to zero the bookmark will be shown open by the pdf viewer. - + @@ -69,12 +69,12 @@ &reftitle.returnvalues; - + The returned value is a reference for the bookmark. It is only used if the bookmark shall be used as a parent. The value is greater zero if the function succeeds. In case of an error zero will be returned. - + diff --git a/reference/ps/functions/ps-add-launchlink.xml b/reference/ps/functions/ps-add-launchlink.xml index ff860b67f..0e8cb49d3 100644 --- a/reference/ps/functions/ps-add-launchlink.xml +++ b/reference/ps/functions/ps-add-launchlink.xml @@ -18,13 +18,13 @@ floatury stringfilename - + Places a hyperlink at the given position pointing to a file program which is being started when clicked on. The hyperlink's source position is a rectangle with its lower left corner at (llx, lly) and its upper right corner at (urx, ury). The rectangle has by default a thin blue border. - + &ps.note.visible; @@ -35,50 +35,50 @@ psdoc - + Resource identifier of the postscript file as returned by ps_new. - + llx - + The x-coordinate of the lower left corner. - + lly - + The y-coordinate of the lower left corner. - + urx - + The x-coordinate of the upper right corner. - + ury - + The y-coordinate of the upper right corner. - + filename - + The path of the program to be started, when the link is clicked on. - + @@ -87,9 +87,9 @@ &reftitle.returnvalues; - + &return.success; - + diff --git a/reference/ps/functions/ps-add-locallink.xml b/reference/ps/functions/ps-add-locallink.xml index 99ca817bd..d28b65703 100644 --- a/reference/ps/functions/ps-add-locallink.xml +++ b/reference/ps/functions/ps-add-locallink.xml @@ -19,17 +19,17 @@ intpage stringdest - + Places a hyperlink at the given position pointing to a page in the same document. Clicking on the link will jump to the given page. The first page in a document has number 1. - - + + The hyperlink's source position is a rectangle with its lower left corner at (llx, lly) and its upper right corner at (urx, ury). The rectangle has by default a thin blue border. - + &ps.note.visible; @@ -40,61 +40,61 @@ psdoc - + Resource identifier of the postscript file as returned by ps_new. - + llx - + The x-coordinate of the lower left corner. - + lly - + The y-coordinate of the lower left corner. - + urx - + The x-coordinate of the upper right corner. - + ury - + The y-coordinate of the upper right corner. - + page - + The number of the page displayed when clicking on the link. - + dest - + The parameter dest determines how the document is being viewed. It can be fitpage, fitwidth, fitheight, or fitbbox. - + @@ -103,9 +103,9 @@ &reftitle.returnvalues; - + &return.success; - + diff --git a/reference/ps/functions/ps-add-note.xml b/reference/ps/functions/ps-add-note.xml index 36d345428..c22366029 100644 --- a/reference/ps/functions/ps-add-note.xml +++ b/reference/ps/functions/ps-add-note.xml @@ -21,13 +21,13 @@ stringicon intopen - + Adds a note at a certain position on the page. Notes are like little rectangular sheets with text on it, which can be placed anywhere on a page. They are shown either folded or unfolded. If folded, the specified icon is used as a placeholder. - + &ps.note.visible; @@ -38,79 +38,79 @@ psdoc - + Resource identifier of the postscript file as returned by ps_new. - + llx - + The x-coordinate of the lower left corner. - + lly - + The y-coordinate of the lower left corner. - + urx - + The x-coordinate of the upper right corner. - + ury - + The y-coordinate of the upper right corner. - + contents - + The text of the note. - + title - + The title of the note as displayed in the header of the note. - + icon - + The icon shown if the note is folded. This parameter can be set to comment, insert, note, paragraph, newparagraph, key, or help. - + open - + If open is unequal to zero the note will be shown unfolded after opening the document with a pdf viewer. - + @@ -119,9 +119,9 @@ &reftitle.returnvalues; - + &return.success; - + diff --git a/reference/ps/functions/ps-add-pdflink.xml b/reference/ps/functions/ps-add-pdflink.xml index c5243bf37..be0d53619 100644 --- a/reference/ps/functions/ps-add-pdflink.xml +++ b/reference/ps/functions/ps-add-pdflink.xml @@ -20,17 +20,17 @@ intpage stringdest - + Places a hyperlink at the given position pointing to a second pdf document. Clicking on the link will branch to the document at the given page. The first page in a document has number 1. - - + + The hyperlink's source position is a rectangle with its lower left corner at (llx, lly) and its upper right corner at (urx, ury). The rectangle has by default a thin blue border. - + &ps.note.visible; @@ -41,70 +41,70 @@ psdoc - + Resource identifier of the postscript file as returned by ps_new. - + llx - + The x-coordinate of the lower left corner. - + lly - + The y-coordinate of the lower left corner. - + urx - + The x-coordinate of the upper right corner. - + ury - + The y-coordinate of the upper right corner. - + filename - + The name of the pdf document to be opened when clicking on this link. - + page - + The page number of the destination pdf document - + dest - + The parameter dest determines how the document is being viewed. It can be fitpage, fitwidth, fitheight, or fitbbox. - + @@ -113,9 +113,9 @@ &reftitle.returnvalues; - + &return.success; - + diff --git a/reference/ps/functions/ps-add-weblink.xml b/reference/ps/functions/ps-add-weblink.xml index 16078990f..6f8f6d738 100644 --- a/reference/ps/functions/ps-add-weblink.xml +++ b/reference/ps/functions/ps-add-weblink.xml @@ -18,14 +18,14 @@ floatury stringurl - - Places a hyperlink at the given position pointing to a web page. The + + Places a hyperlink at the given position pointing to a web page. The hyperlink's source position is a rectangle with its lower left corner at (llx, lly) and its upper right corner at (urx, ury). The rectangle has by default a thin blue border. - + &ps.note.visible; @@ -36,51 +36,51 @@ psdoc - + Resource identifier of the postscript file as returned by ps_new. - + llx - + The x-coordinate of the lower left corner. - + lly - + The y-coordinate of the lower left corner. - + urx - + The x-coordinate of the upper right corner. - + ury - + The y-coordinate of the upper right corner. - + url - + The url of the hyperlink to be opened when clicking on this link, e.g. http://www.php.net. - + @@ -89,9 +89,9 @@ &reftitle.returnvalues; - + &return.success; - + diff --git a/reference/ps/functions/ps-arc.xml b/reference/ps/functions/ps-arc.xml index 0d0bc013a..3916b11d5 100644 --- a/reference/ps/functions/ps-arc.xml +++ b/reference/ps/functions/ps-arc.xml @@ -18,7 +18,7 @@ floatalpha floatbeta - + Draws a portion of a circle with at middle point at (x, y). The arc starts at an angle of alpha and ends at an angle of @@ -26,7 +26,7 @@ ps_arcn to draw clockwise). The subpath added to the current path starts on the arc at angle alpha and ends on the arc at angle beta. - + @@ -36,50 +36,50 @@ psdoc - + Resource identifier of the postscript file as returned by ps_new. - + x - + The x-coordinate of the circle's middle point. - + y - + The y-coordinate of the circle's middle point. - + radius - - The radius of the circle - + + The radius of the circle + alpha - + The start angle given in degrees. - + beta - + The end angle given in degrees. - + @@ -88,9 +88,9 @@ &reftitle.returnvalues; - + &return.success; - + diff --git a/reference/ps/functions/ps-arcn.xml b/reference/ps/functions/ps-arcn.xml index 0a6e83467..d9caf7f7d 100644 --- a/reference/ps/functions/ps-arcn.xml +++ b/reference/ps/functions/ps-arcn.xml @@ -18,7 +18,7 @@ floatalpha floatbeta - + Draws a portion of a circle with at middle point at (x, y). The arc starts at an angle of alpha and ends at an angle of @@ -26,7 +26,7 @@ ps_arc to draw counterclockwise). The subpath added to the current path starts on the arc at angle beta and ends on the arc at angle alpha. - + @@ -36,50 +36,50 @@ psdoc - + Resource identifier of the postscript file as returned by ps_new. - + x - + The x-coordinate of the circle's middle point. - + y - + The y-coordinate of the circle's middle point. - + radius - - The radius of the circle - + + The radius of the circle + alpha - + The starting angle given in degrees. - + beta - + The end angle given in degrees. - + @@ -88,9 +88,9 @@ &reftitle.returnvalues; - + &return.success; - + diff --git a/reference/ps/functions/ps-begin-page.xml b/reference/ps/functions/ps-begin-page.xml index 084c18edf..023520534 100644 --- a/reference/ps/functions/ps-begin-page.xml +++ b/reference/ps/functions/ps-begin-page.xml @@ -15,7 +15,7 @@ floatwidth floatheight - + Starts a new page. Although the parameters width and height imply a different page size for each page, this is not possible in PostScript. The first call of @@ -25,8 +25,8 @@ document into PDF. This function places pdfmarks into the document which can set the size for each page indiviually. The resulting PDF document will have different page sizes. - - + + Though PostScript does not know different page sizes, pslib places a bounding box for each page into the document. This size is evaluated by some PostScript viewers and will have precedence over the BoundingBox @@ -34,12 +34,12 @@ you set a BoundingBox whose lower left corner is not (0, 0), because the bounding box of the page will always have a lower left corner (0, 0) and overwrites the global setting. - - + + Each page is encapsulated into save/restore. This means, that most of the settings made on one page will not be retained on the next page. - - + + If there is up to the first call of ps_begin_page no call of ps_findfont, then the header of the PostScript document will be output and the bounding box will be set to the size of @@ -51,14 +51,14 @@ BoundingBox and possibly Orientation before any ps_findfont or ps_begin_page calls. - + - + Up to version 0.2.6 of pslib, this function will always overwrite the BoundingBox and Orientation, if it has been set before with ps_set_info and ps_findfont has not been called before. - + @@ -69,26 +69,26 @@ psdoc - + Resource identifier of the postscript file as returned by ps_new. - + width - + The width of the page in pixel, e.g. 596 for A4 format. - + height - + The height of the page in pixel, e.g. 842 for A4 format. - + @@ -97,9 +97,9 @@ &reftitle.returnvalues; - + &return.success; - + diff --git a/reference/ps/functions/ps-begin-pattern.xml b/reference/ps/functions/ps-begin-pattern.xml index fe9c63352..d4e9914d6 100644 --- a/reference/ps/functions/ps-begin-pattern.xml +++ b/reference/ps/functions/ps-begin-pattern.xml @@ -18,12 +18,12 @@ floatystep intpainttype - + Starts a new pattern. A pattern is like a page containing e.g. a drawing which can be used for filling areas. It is used like a color by calling ps_setcolor and setting the color space to pattern. - + @@ -33,52 +33,52 @@ psdoc - + Resource identifier of the postscript file as returned by ps_new. - + width - + The width of the pattern in pixel. - + height - + The height of the pattern in pixel. - + xstep - + The distance in pixel of placements of the pattern in horizontal direction. - + ystep - + The distance in pixel of placements of the pattern in vertical direction. - + painttype - + Must be 1 or 2. - + @@ -87,9 +87,9 @@ &reftitle.returnvalues; - + The identifier of the pattern &return.falseforfailure;. - + diff --git a/reference/ps/functions/ps-begin-template.xml b/reference/ps/functions/ps-begin-template.xml index b131a6767..ad3d1fe4b 100644 --- a/reference/ps/functions/ps-begin-template.xml +++ b/reference/ps/functions/ps-begin-template.xml @@ -15,14 +15,14 @@ floatwidth floatheight - + Starts a new template. A template is called a form in the postscript language. It is created similar to a pattern but used like an image. Templates are often used for drawings which are placed several times through out the document, e.g. like a company logo. All drawing functions may be used within a template. The template will not be drawn until it is placed by ps_place_image. - + @@ -32,26 +32,26 @@ psdoc - + Resource identifier of the postscript file as returned by ps_new. - + width - + The width of the template in pixel. - + height - + The height of the template in pixel. - + @@ -60,9 +60,9 @@ &reftitle.returnvalues; - + &return.success; - + diff --git a/reference/ps/functions/ps-circle.xml b/reference/ps/functions/ps-circle.xml index 530ba9a24..369ab645f 100644 --- a/reference/ps/functions/ps-circle.xml +++ b/reference/ps/functions/ps-circle.xml @@ -16,7 +16,7 @@ floaty floatradius - + Draws a circle with its middle point at (x, y). The circle starts and ends at position (x+radius, @@ -25,7 +25,7 @@ as a subpath. If the last drawing operation does not end in point (x+radius, y) then there will be a gap in the path. - + @@ -35,34 +35,34 @@ psdoc - + Resource identifier of the postscript file as returned by ps_new. - + x - + The x-coordinate of the circle's middle point. - + y - + The y-coordinate of the circle's middle point. - + radius - - The radius of the circle - + + The radius of the circle + @@ -71,9 +71,9 @@ &reftitle.returnvalues; - + &return.success; - + diff --git a/reference/ps/functions/ps-clip.xml b/reference/ps/functions/ps-clip.xml index 5d293e96d..1dacc7263 100644 --- a/reference/ps/functions/ps-clip.xml +++ b/reference/ps/functions/ps-clip.xml @@ -13,10 +13,10 @@ boolps_clip resourcepsdoc - + Takes the current path and uses it to define the border of a clipping area. Everything drawn outside of that area will not be visible. - + @@ -26,10 +26,10 @@ psdoc - + Resource identifier of the postscript file as returned by ps_new. - + @@ -38,9 +38,9 @@ &reftitle.returnvalues; - + &return.success; - + diff --git a/reference/ps/functions/ps-close-image.xml b/reference/ps/functions/ps-close-image.xml index 608452b68..c2f1c3f21 100644 --- a/reference/ps/functions/ps-close-image.xml +++ b/reference/ps/functions/ps-close-image.xml @@ -14,10 +14,10 @@ resourcepsdoc intimageid - + Closes an image and frees its resources. Once an image is closed it cannot be used anymore. - + @@ -27,20 +27,20 @@ psdoc - + Resource identifier of the postscript file as returned by ps_new. - + imageid - + Resource identifier of the image as returned by ps_open_image or ps_open_image_file. - + @@ -49,9 +49,9 @@ &reftitle.returnvalues; - + Returns &null; on success&return.falseforfailure;. - + diff --git a/reference/ps/functions/ps-close.xml b/reference/ps/functions/ps-close.xml index b9d021007..2fcb4d711 100644 --- a/reference/ps/functions/ps-close.xml +++ b/reference/ps/functions/ps-close.xml @@ -13,18 +13,18 @@ boolps_close resourcepsdoc - + Closes the PostScript document. - - + + This function writes the trailer of the PostScript document. It also writes the bookmark tree. ps_close does not free any resources, which is done by ps_delete. - - + + This function is also called by ps_delete if it has not been called before. - + @@ -34,10 +34,10 @@ psdoc - + Resource identifier of the postscript file as returned by ps_new. - + @@ -46,9 +46,9 @@ &reftitle.returnvalues; - + &return.success; - + diff --git a/reference/ps/functions/ps-closepath-stroke.xml b/reference/ps/functions/ps-closepath-stroke.xml index 19d9c6322..3a3321335 100644 --- a/reference/ps/functions/ps-closepath-stroke.xml +++ b/reference/ps/functions/ps-closepath-stroke.xml @@ -13,10 +13,10 @@ boolps_closepath_stroke resourcepsdoc - + Connects the last point with first point of a path and draws the resulting closed line. - + @@ -26,10 +26,10 @@ psdoc - + Resource identifier of the postscript file as returned by ps_new. - + @@ -38,9 +38,9 @@ &reftitle.returnvalues; - + &return.success; - + diff --git a/reference/ps/functions/ps-closepath.xml b/reference/ps/functions/ps-closepath.xml index b3638daa3..939eb154e 100644 --- a/reference/ps/functions/ps-closepath.xml +++ b/reference/ps/functions/ps-closepath.xml @@ -13,10 +13,10 @@ boolps_closepath resourcepsdoc - + Connects the last point with the first point of a path. The resulting path can be used for stroking, filling, clipping, etc.. - + @@ -26,10 +26,10 @@ psdoc - + Resource identifier of the postscript file as returned by ps_new. - + @@ -38,9 +38,9 @@ &reftitle.returnvalues; - + &return.success; - + diff --git a/reference/ps/functions/ps-continue-text.xml b/reference/ps/functions/ps-continue-text.xml index 2bf1aded0..5bef3a8de 100644 --- a/reference/ps/functions/ps-continue-text.xml +++ b/reference/ps/functions/ps-continue-text.xml @@ -14,13 +14,13 @@ resourcepsdoc stringtext - + Output a text one line below the last line. The line spacing is taken from the value "leading" which must be set with ps_set_value. The actual position of the text is determined by the values "textx" and "texty" which can be requested with ps_get_value - + @@ -30,18 +30,18 @@ psdoc - + Resource identifier of the postscript file as returned by ps_new. - + text - + The text to output. - + @@ -50,9 +50,9 @@ &reftitle.returnvalues; - + &return.success; - + diff --git a/reference/ps/functions/ps-curveto.xml b/reference/ps/functions/ps-curveto.xml index 453127f27..39ac6c410 100644 --- a/reference/ps/functions/ps-curveto.xml +++ b/reference/ps/functions/ps-curveto.xml @@ -19,10 +19,10 @@ floatx3 floaty3 - + Add a section of a cubic Bézier curve described by the three given control points to the current path. - + @@ -32,58 +32,58 @@ psdoc - + Resource identifier of the postscript file as returned by ps_new. - + x1 - + x-coordinate of first control point. - + y1 - + y-coordinate of first control point. - + x2 - + x-coordinate of second control point. - + y2 - + y-coordinate of second control point. - + x3 - + x-coordinate of third control point. - + y3 - + y-coordinate of third control point. - + @@ -92,9 +92,9 @@ &reftitle.returnvalues; - + &return.success; - + diff --git a/reference/ps/functions/ps-delete.xml b/reference/ps/functions/ps-delete.xml index 40ec9eefc..6a59dd1c9 100644 --- a/reference/ps/functions/ps-delete.xml +++ b/reference/ps/functions/ps-delete.xml @@ -13,14 +13,14 @@ boolps_delete resourcepsdoc - + Mainly frees memory used by the document. Also closes a file, if it was not closed before with ps_close. You should in any case close the file with ps_close before, because ps_close not just closes the file but also outputs a trailor containing PostScript comments like the number of pages in the document and adding the bookmark hierarchy. - + @@ -30,10 +30,10 @@ psdoc - + Resource identifier of the postscript file as returned by ps_new. - + @@ -42,9 +42,9 @@ &reftitle.returnvalues; - + &return.success; - + diff --git a/reference/ps/functions/ps-end-page.xml b/reference/ps/functions/ps-end-page.xml index 496fc9dc6..8e08f3e06 100644 --- a/reference/ps/functions/ps-end-page.xml +++ b/reference/ps/functions/ps-end-page.xml @@ -13,12 +13,12 @@ boolps_end_page resourcepsdoc - + Ends a page which was started with ps_begin_page. Ending a page will leave the current drawing context, which e.g. requires to reload fonts if they were loading within the page, and to set many other drawing parameters like the line width, or color. - + @@ -28,10 +28,10 @@ psdoc - + Resource identifier of the postscript file as returned by ps_new. - + @@ -40,9 +40,9 @@ &reftitle.returnvalues; - + &return.success; - + diff --git a/reference/ps/functions/ps-end-pattern.xml b/reference/ps/functions/ps-end-pattern.xml index 6ee2ab204..eb70895db 100644 --- a/reference/ps/functions/ps-end-pattern.xml +++ b/reference/ps/functions/ps-end-pattern.xml @@ -13,11 +13,11 @@ boolps_end_pattern resourcepsdoc - + Ends a pattern which was started with ps_begin_pattern. Once a pattern has been ended, it can be used like a color to fill areas. - + @@ -27,10 +27,10 @@ psdoc - + Resource identifier of the postscript file as returned by ps_new. - + @@ -39,9 +39,9 @@ &reftitle.returnvalues; - + &return.success; - + diff --git a/reference/ps/functions/ps-end-template.xml b/reference/ps/functions/ps-end-template.xml index 72fadedca..ce369ed01 100644 --- a/reference/ps/functions/ps-end-template.xml +++ b/reference/ps/functions/ps-end-template.xml @@ -13,10 +13,10 @@ boolps_end_template resourcepsdoc - + Ends a template which was started with ps_begin_template. Once a template has been ended, it can be used like an image. - + @@ -26,10 +26,10 @@ psdoc - + Resource identifier of the postscript file as returned by ps_new. - + @@ -38,9 +38,9 @@ &reftitle.returnvalues; - + &return.success; - + diff --git a/reference/ps/functions/ps-fill-stroke.xml b/reference/ps/functions/ps-fill-stroke.xml index c81d44da8..cd74144ea 100644 --- a/reference/ps/functions/ps-fill-stroke.xml +++ b/reference/ps/functions/ps-fill-stroke.xml @@ -11,12 +11,12 @@ &reftitle.description; boolps_fill_stroke - resourcepsdoc + resourcepsdoc - + Fills and draws the path constructed with previously called drawing functions like ps_lineto. - + @@ -26,10 +26,10 @@ psdoc - + Resource identifier of the postscript file as returned by ps_new. - + @@ -38,9 +38,9 @@ &reftitle.returnvalues; - + &return.success; - + diff --git a/reference/ps/functions/ps-fill.xml b/reference/ps/functions/ps-fill.xml index b263334d9..42b0fc7fb 100644 --- a/reference/ps/functions/ps-fill.xml +++ b/reference/ps/functions/ps-fill.xml @@ -13,10 +13,10 @@ boolps_fill resourcepsdoc - + Fills the path constructed with previously called drawing functions like ps_lineto. - + @@ -26,10 +26,10 @@ psdoc - + Resource identifier of the postscript file as returned by ps_new. - + @@ -38,9 +38,9 @@ &reftitle.returnvalues; - + &return.success; - + diff --git a/reference/ps/functions/ps-findfont.xml b/reference/ps/functions/ps-findfont.xml index 288334c5b..2e7a4d475 100644 --- a/reference/ps/functions/ps-findfont.xml +++ b/reference/ps/functions/ps-findfont.xml @@ -16,7 +16,7 @@ stringencoding boolembed&false; - + Loads a font for later use. Before text is output with a loaded font it must be set with ps_setfont. This function needs the adobe font metric file in order to calculate the space used up by the @@ -25,15 +25,15 @@ loaded before the first call of ps_begin_page. Calling ps_findfont between pages will make that font available for all following pages. - - + + The name of the afm file must be fontname.afm. If the font shall be embedded the file fontname.pfb containing the font outline must be present as well. - - + + Calling ps_findfont before the first page requires to output the postscript header which includes the BoundingBox for the whole document. Usually the BoundingBox is set with the first call @@ -43,7 +43,7 @@ is called. In order to prevent this situation, one should call ps_set_parameter to set the BoundingBox before ps_findfont is called. - + @@ -53,49 +53,49 @@ psdoc - + Resource identifier of the postscript file as returned by ps_new. - + fontname - + The name of the font. - + encoding - + ps_findfont will try to load the file passed in the parameter encoding. Encoding files are of the same syntax as those used by dvips(1). They contain a font encoding vector (which is currently not used but must be present) and a list of extra ligatures to extend the list of ligatures derived from the afm file. - - + + encoding can be &null; or the empty string if the default encoding (TeXBase1) shall be used. - - + + If the encoding is set to builtin then there will be no reencoding and the font specific encoding will be used. This is very useful with symbol fonts. - + embed - + If set to a value >0 the font will be embedded into the document. This requires the font outline (.pfb file) to be present. - + @@ -104,10 +104,10 @@ &reftitle.returnvalues; - + Returns the identifier of the font or zero in case of an error. The identifier is a positive number. - + diff --git a/reference/ps/functions/ps-get-buffer.xml b/reference/ps/functions/ps-get-buffer.xml index 1c37fb54b..dee6520b6 100644 --- a/reference/ps/functions/ps-get-buffer.xml +++ b/reference/ps/functions/ps-get-buffer.xml @@ -13,13 +13,13 @@ stringps_get_buffer resourcepsdoc - This function is not implemented yet. It will always return an empty + This function is not implemented yet. It will always return an empty string. The idea for a later implementation is to write the contents of the postscript file into an internal buffer if in memory creation is requested, and retrieve the buffer content with this function. Currently, documents created in memory are send to the browser without buffering. - + &warn.undocumented.func; @@ -30,10 +30,10 @@ psdoc - + Resource identifier of the postscript file as returned by ps_new. - + diff --git a/reference/ps/functions/ps-get-parameter.xml b/reference/ps/functions/ps-get-parameter.xml index 39cd9947f..60bdfc022 100644 --- a/reference/ps/functions/ps-get-parameter.xml +++ b/reference/ps/functions/ps-get-parameter.xml @@ -15,120 +15,120 @@ stringname floatmodifier - + Gets several parameters which were directly set by ps_set_parameter or indirectly by one of the other functions. Parameters are by definition string values. This function cannot be used to retrieve resources which were also set by ps_set_parameter. - - + + The parameter name can have the following values. - + fontname - + The name of the currently active font or the font whose identifier is passed in parameter modifier. - + fontencoding - + The encoding of the currently active font. - + dottedversion - + The version of the underlying pslib library in the format <major>.<minor>.<subminor> - + scope - + The current drawing scope. Can be object, document, null, page, pattern, path, template, prolog, font, glyph. - + ligaturedisolvechar - + The character which dissolves a ligature. If your are using a font which contains the ligature `ff' and `|' is the char to dissolve the ligature, then `f|f' will result in two `f' instead of the ligature `ff'. - + imageencoding - + The encoding used for encoding images. Can be either hex or 85. hex encoding uses two bytes in the postscript file each byte in the image. 85 stand for Ascii85 encoding. - + linenumbermode - + Set to paragraph if lines are numbered within a paragraph or box if they are numbered within the surrounding box. - + linebreak - + Only used if text is output with ps_show_boxed. If set to &true; a carriage return will add a line break. - + parbreak - + Only used if text is output with ps_show_boxed. If set to &true; a carriage return will start a new paragraph. - + hyphenation - + Only used if text is output with ps_show_boxed. If set to &true; the paragraph will be hyphenated if a hypen dictionary is set and exists. - + hyphendict - + Filename of the dictionary used for hyphenation pattern. - + @@ -142,28 +142,28 @@ psdoc - + Resource identifier of the postscript file as returned by ps_new. - + name - + Name of the parameter. - + modifier - + An identifier needed if a parameter of a resource is requested, e.g. the size of an image. In such a case the resource id is passed. - + @@ -172,9 +172,9 @@ &reftitle.returnvalues; - + Returns the value of the parameter &return.falseforfailure;. - + diff --git a/reference/ps/functions/ps-get-value.xml b/reference/ps/functions/ps-get-value.xml index 798acdcb1..1a85c920f 100644 --- a/reference/ps/functions/ps-get-value.xml +++ b/reference/ps/functions/ps-get-value.xml @@ -15,236 +15,236 @@ stringname floatmodifier - Gets several values which were set by + Gets several values which were set by ps_set_value. Values are by definition float values. - - + + The parameter name can have the following values. - + fontsize - + The size of the currently active font or the font whose identifier is passed in parameter modifier. - + font - + The currently active font itself. - + imagewidth - + The width of the image whose id is passed in the parameter modifier. - + imageheight - + The height of the image whose id is passed in the parameter modifier. - + capheight - + The height of a capital M in the currently active font or the font whose identifier is passed in parameter modifier. - + ascender - + The ascender of the currently active font or the font whose identifier is passed in parameter modifier. - + descender - + The descender of the currently active font or the font whose identifier is passed in parameter modifier. - + italicangle - + The italicangle of the currently active font or the font whose identifier is passed in parameter modifier. - + underlineposition - + The underlineposition of the currently active font or the font whose identifier is passed in parameter modifier. - + underlinethickness - + The underlinethickness of the currently active font or the font whose identifier is passed in parameter modifier. - + textx - + The current x-position for text output. - + texty - + The current y-position for text output. - + textrendering - + The current mode for text rendering. - + textrise - + The space by which text is risen above the base line. - + leading - + The distance between text lines in points. - + wordspacing - + The space between words as a multiple of the width of a space char. - + charspacing - + The space between chars. If charspacing is != 0.0 ligatures will always be dissolved. - + hyphenminchars - + Minimum number of chars hyphenated at the end of a word. - + parindent - + Indention of the first n line in a paragraph. - + numindentlines - + Number of line in a paragraph to indent if parindent != 0.0. - + parskip - + Distance between paragraphs. - + linenumberspace - + Overall space in front of each line for the line number. - + linenumbersep - + Space between the line and the line number. - + major - + The major version number of pslib. - + minor - + The minor version number of pslib. - + subminor, revision - + The subminor version number of pslib. - + @@ -258,28 +258,28 @@ psdoc - + Resource identifier of the postscript file as returned by ps_new. - + name - + Name of the value. - + modifier - + The parameter modifier specifies the resource for which the value is to be retrieved. This can be the id of a font or an image. - + @@ -288,9 +288,9 @@ &reftitle.returnvalues; - + Returns the value of the parameter or &false;. - + diff --git a/reference/ps/functions/ps-hyphenate.xml b/reference/ps/functions/ps-hyphenate.xml index 0d8fbe27d..7767f5f0a 100644 --- a/reference/ps/functions/ps-hyphenate.xml +++ b/reference/ps/functions/ps-hyphenate.xml @@ -14,17 +14,17 @@ resourcepsdoc stringtext - + Hyphenates the passed word. ps_hyphenate evaluates the value hyphenminchars (set by ps_set_value) and the parameter hyphendict (set by ps_set_parameter). hyphendict must be set before calling this function. - - + + This function requires the locale category LC_CTYPE to be set properly. This is done when the extension is initialized by using the environment variables. On Unix systems read the man page of locale for more information. - + @@ -34,10 +34,10 @@ psdoc - + Resource identifier of the postscript file as returned by ps_new. - + @@ -57,10 +57,10 @@ &reftitle.returnvalues; - + An array of integers indicating the position of possible breaks in the text &return.falseforfailure;. - + diff --git a/reference/ps/functions/ps-include-file.xml b/reference/ps/functions/ps-include-file.xml index 893a2e45f..285cc4433 100644 --- a/reference/ps/functions/ps-include-file.xml +++ b/reference/ps/functions/ps-include-file.xml @@ -22,17 +22,17 @@ psdoc - + Resource identifier of the postscript file as returned by ps_new. - + file - - + + @@ -41,9 +41,9 @@ &reftitle.returnvalues; - + &return.success; - + diff --git a/reference/ps/functions/ps-lineto.xml b/reference/ps/functions/ps-lineto.xml index 4b4870db5..120b8ab18 100644 --- a/reference/ps/functions/ps-lineto.xml +++ b/reference/ps/functions/ps-lineto.xml @@ -15,11 +15,11 @@ floatx floaty - + Adds a straight line from the current point to the given coordinates to the current path. Use ps_moveto to set the starting point of the line. - + @@ -29,26 +29,26 @@ psdoc - + Resource identifier of the postscript file as returned by ps_new. - + x - + x-coordinate of the end point of the line. - + y - + y-coordinate of the end point of the line. - + @@ -57,9 +57,9 @@ &reftitle.returnvalues; - + &return.success; - + diff --git a/reference/ps/functions/ps-makespotcolor.xml b/reference/ps/functions/ps-makespotcolor.xml index 10bcfe6c6..f242104f6 100644 --- a/reference/ps/functions/ps-makespotcolor.xml +++ b/reference/ps/functions/ps-makespotcolor.xml @@ -15,14 +15,14 @@ stringname intreserved0 - + Creates a spot color from the current fill color. The fill color must be defined in rgb, cmyk or gray colorspace. The spot color name can be an arbitrary name. A spot color can be set as any color with ps_setcolor. When the document is not printed but displayed by an postscript viewer the given color in the specified color space is use. - + @@ -32,18 +32,18 @@ psdoc - + Resource identifier of the postscript file as returned by ps_new. - + name - + Name of the spot color, e.g. Pantone 5565. - + @@ -52,9 +52,9 @@ &reftitle.returnvalues; - + The id of the new spot color or 0 in case of an error. - + @@ -91,10 +91,10 @@ ps_delete($ps); ?> ]]> - + This example creates the spot color "PANTONE 5565 C" which is a darker green (olive) and fills a rectangle with 50% intensity. - + diff --git a/reference/ps/functions/ps-moveto.xml b/reference/ps/functions/ps-moveto.xml index 2d92d0c74..4187d728d 100644 --- a/reference/ps/functions/ps-moveto.xml +++ b/reference/ps/functions/ps-moveto.xml @@ -15,12 +15,12 @@ floatx floaty - + Sets the current point to new coordinates. If this is the first call of ps_moveto after a previous path has been ended then it will start a new path. If this function is called in the middle of a path it will just set the current point and start a subpath. - + @@ -30,26 +30,26 @@ psdoc - + Resource identifier of the postscript file as returned by ps_new. - + x - + x-coordinate of the point to move to. - + y - + y-coordinate of the point to move to. - + @@ -58,9 +58,9 @@ &reftitle.returnvalues; - + &return.success; - + diff --git a/reference/ps/functions/ps-new.xml b/reference/ps/functions/ps-new.xml index 53ee4ef7c..c8e9cb7c1 100644 --- a/reference/ps/functions/ps-new.xml +++ b/reference/ps/functions/ps-new.xml @@ -13,12 +13,12 @@ resourcefalseps_new - + Creates a new document instance. It does not create the file on disk or in memory, it just sets up everything. ps_new is usually followed by a call of ps_open_file to actually create the postscript document. - + @@ -28,10 +28,10 @@ &reftitle.returnvalues; - + Resource of PostScript document&return.falseforfailure;. The return value is passed to all other functions as the first argument. - + diff --git a/reference/ps/functions/ps-open-file.xml b/reference/ps/functions/ps-open-file.xml index 3faa89323..9182275ee 100644 --- a/reference/ps/functions/ps-open-file.xml +++ b/reference/ps/functions/ps-open-file.xml @@ -14,10 +14,10 @@ resourcepsdoc stringfilename - + Creates a new file on disk and writes the PostScript document into it. The file will be closed when ps_close is called. - + @@ -27,20 +27,20 @@ psdoc - + Resource identifier of the postscript file as returned by ps_new. - + filename - + The name of the postscript file. If filename is not passed the document will be created in memory and all output will go straight to the browser. - + @@ -49,9 +49,9 @@ &reftitle.returnvalues; - + &return.success; - + diff --git a/reference/ps/functions/ps-open-image-file.xml b/reference/ps/functions/ps-open-image-file.xml index 148d53dc2..d7e797a6e 100644 --- a/reference/ps/functions/ps-open-image-file.xml +++ b/reference/ps/functions/ps-open-image-file.xml @@ -17,9 +17,9 @@ stringstringparam intintparam0 - + Loads an image for later use. - + @@ -29,43 +29,43 @@ psdoc - + Resource identifier of the postscript file as returned by ps_new. - + type - + The type of the image. Possible values are png, jpeg, or eps. - + filename - + The name of the file containing the image data. - + stringparam - + Not used. - + intparam - + Not used. - + @@ -74,10 +74,10 @@ &reftitle.returnvalues; - + Returns identifier of image or zero in case of an error. The identifier is a positive number greater than 0. - + diff --git a/reference/ps/functions/ps-open-image.xml b/reference/ps/functions/ps-open-image.xml index 685663fd7..844682ea3 100644 --- a/reference/ps/functions/ps-open-image.xml +++ b/reference/ps/functions/ps-open-image.xml @@ -22,14 +22,14 @@ intbpc stringparams - + Reads an image which is already available in memory. The parameter source is currently not evaluated and assumed to be memory. The image data is a sequence of pixels starting in th upper left corner and ending in the lower right corner. Each pixel consists of components color components, and each component has bpc bits. - + @@ -39,83 +39,83 @@ psdoc - + Resource identifier of the postscript file as returned by ps_new. - + type - + The type of the image. Possible values are png, jpeg, or eps. - + source - + Not used. - + data - + The image data. - + length - + The length of the image data. - + width - + The width of the image. - + height - + The height of the image. - + components - + The number of components for each pixel. This can be 1 (gray scale images), 3 (rgb images), or 4 (cmyk, rgba images). - + bpc - + Number of bits per component (quite often 8). - + params - - + + @@ -124,10 +124,10 @@ &reftitle.returnvalues; - + Returns identifier of image or zero in case of an error. The identifier is a positive number greater than 0. - + diff --git a/reference/ps/functions/ps-open-memory-image.xml b/reference/ps/functions/ps-open-memory-image.xml index b7ea3fcf4..d9d0b357c 100644 --- a/reference/ps/functions/ps-open-memory-image.xml +++ b/reference/ps/functions/ps-open-memory-image.xml @@ -23,17 +23,17 @@ psdoc - + Resource identifier of the postscript file as returned by ps_new. - + gd - - + + diff --git a/reference/ps/functions/ps-place-image.xml b/reference/ps/functions/ps-place-image.xml index dd4ed8d32..984600cd0 100644 --- a/reference/ps/functions/ps-place-image.xml +++ b/reference/ps/functions/ps-place-image.xml @@ -17,11 +17,11 @@ floaty floatscale - + Places a formerly loaded image on the page. The image can be scaled. If the image shall be rotated as well, you will have to rotate the coordinate system before with ps_rotate. - + @@ -31,46 +31,46 @@ psdoc - + Resource identifier of the postscript file as returned by ps_new. - + imageid - - The resource identifier of the image as returned by + + The resource identifier of the image as returned by ps_open_image or ps_open_image_file. - + x - + x-coordinate of the lower left corner of the image. - + y - + y-coordinate of the lower left corner of the image. - + scale - + The scaling factor for the image. A scale of 1.0 will result in a resolution of 72 dpi, because each pixel is equivalent to 1 point. - + @@ -79,9 +79,9 @@ &reftitle.returnvalues; - + &return.success; - + diff --git a/reference/ps/functions/ps-rect.xml b/reference/ps/functions/ps-rect.xml index fa2f81e7c..878344264 100644 --- a/reference/ps/functions/ps-rect.xml +++ b/reference/ps/functions/ps-rect.xml @@ -17,14 +17,14 @@ floatwidth floatheight - + Draws a rectangle with its lower left corner at (x, y). The rectangle starts and ends in its lower left corner. If this function is called outside a path it will start a new path. If it is called within a path it will add the rectangle as a subpath. If the last drawing operation does not end in the lower left corner then there will be a gap in the path. - + @@ -34,42 +34,42 @@ psdoc - + Resource identifier of the postscript file as returned by ps_new. - + x - + x-coordinate of the lower left corner of the rectangle. - + y - + y-coordinate of the lower left corner of the rectangle. - + width - + The width of the image. - + height - + The height of the image. - + @@ -78,9 +78,9 @@ &reftitle.returnvalues; - + &return.success; - + diff --git a/reference/ps/functions/ps-restore.xml b/reference/ps/functions/ps-restore.xml index 590e3d2df..26130d9ca 100644 --- a/reference/ps/functions/ps-restore.xml +++ b/reference/ps/functions/ps-restore.xml @@ -13,13 +13,13 @@ boolps_restore resourcepsdoc - + Restores a previously saved graphics context. Any call of ps_save must be accompanied by a call to ps_restore. All coordinate transformations, line style settings, color settings, etc. are being restored to the state before the call of ps_save. - + @@ -29,10 +29,10 @@ psdoc - + Resource identifier of the postscript file as returned by ps_new. - + @@ -41,9 +41,9 @@ &reftitle.returnvalues; - + &return.success; - + diff --git a/reference/ps/functions/ps-rotate.xml b/reference/ps/functions/ps-rotate.xml index 6d954e21a..8f9753216 100644 --- a/reference/ps/functions/ps-rotate.xml +++ b/reference/ps/functions/ps-rotate.xml @@ -14,9 +14,9 @@ resourcepsdoc floatrot - + Sets the rotation of the coordinate system. - + @@ -26,18 +26,18 @@ psdoc - + Resource identifier of the postscript file as returned by ps_new. - + rot - + Angle of rotation in degree. - + @@ -46,9 +46,9 @@ &reftitle.returnvalues; - + &return.success; - + @@ -96,7 +96,7 @@ ps_delete($ps); ?> ]]> - + The above example illustrates a very common way of rotating a graphic (in this case just a rectangle) by simply rotating the coordinate system. Since the graphic's coordinate system assumes @@ -107,12 +107,12 @@ ps_delete($ps); rotated around the point (100, 100) in the untranslated coordinate system. Switching the two statements has a completely different result. - - + + In order to output the following text at the original position, all modifications of the coordinate system are encapsulated in ps_save and ps_restore. - + diff --git a/reference/ps/functions/ps-save.xml b/reference/ps/functions/ps-save.xml index f9f170d84..f0ca6d4f6 100644 --- a/reference/ps/functions/ps-save.xml +++ b/reference/ps/functions/ps-save.xml @@ -13,11 +13,11 @@ boolps_save resourcepsdoc - + Saves the current graphics context, containing colors, translation and rotation settings and some more. A saved context can be restored with ps_restore. - + @@ -27,10 +27,10 @@ psdoc - + Resource identifier of the postscript file as returned by ps_new. - + @@ -39,9 +39,9 @@ &reftitle.returnvalues; - + &return.success; - + diff --git a/reference/ps/functions/ps-scale.xml b/reference/ps/functions/ps-scale.xml index 5f7bfdb1d..3c176bd61 100644 --- a/reference/ps/functions/ps-scale.xml +++ b/reference/ps/functions/ps-scale.xml @@ -15,9 +15,9 @@ floatx floaty - + Sets horizontal and vertical scaling of the coordinate system. - + @@ -27,26 +27,26 @@ psdoc - + Resource identifier of the postscript file as returned by ps_new. - + x - + Scaling factor in horizontal direction. - + y - + Scaling factor in vertical direction. - + @@ -55,9 +55,9 @@ &reftitle.returnvalues; - + &return.success; - + diff --git a/reference/ps/functions/ps-set-border-color.xml b/reference/ps/functions/ps-set-border-color.xml index 9bfc127ef..7f6db5cb4 100644 --- a/reference/ps/functions/ps-set-border-color.xml +++ b/reference/ps/functions/ps-set-border-color.xml @@ -16,14 +16,14 @@ floatgreen floatblue - + Links added with one of the functions ps_add_weblink, ps_add_pdflink, etc. will be displayed with a surounded rectangle when the postscript document is converted to pdf and viewed in a pdf viewer. This rectangle is not visible in the postscript document. This function sets the color of the rectangle's border line. - + @@ -33,34 +33,34 @@ psdoc - + Resource identifier of the postscript file as returned by ps_new. - + red - + The red component of the border color. - + green - + The green component of the border color. - + blue - + The blue component of the border color. - + @@ -69,9 +69,9 @@ &reftitle.returnvalues; - + &return.success; - + diff --git a/reference/ps/functions/ps-set-border-dash.xml b/reference/ps/functions/ps-set-border-dash.xml index 5d0d7eae9..5b46ac6e2 100644 --- a/reference/ps/functions/ps-set-border-dash.xml +++ b/reference/ps/functions/ps-set-border-dash.xml @@ -15,7 +15,7 @@ floatblack floatwhite - + Links added with one of the functions ps_add_weblink, ps_add_pdflink, etc. will be displayed with a surounded rectangle when the postscript document is converted to @@ -23,7 +23,7 @@ the postscript document. This function sets the length of the black and white portion of a dashed border line. - + @@ -33,26 +33,26 @@ psdoc - + Resource identifier of the postscript file as returned by ps_new. - + black - + The length of the dash. - + white - + The length of the gap between dashes. - + @@ -61,9 +61,9 @@ &reftitle.returnvalues; - + &return.success; - + diff --git a/reference/ps/functions/ps-set-border-style.xml b/reference/ps/functions/ps-set-border-style.xml index e1c439a6e..305cef182 100644 --- a/reference/ps/functions/ps-set-border-style.xml +++ b/reference/ps/functions/ps-set-border-style.xml @@ -15,14 +15,14 @@ stringstyle floatwidth - + Links added with one of the functions ps_add_weblink, ps_add_pdflink, etc. will be displayed with a surounded rectangle when the postscript document is converted to pdf and viewed in a pdf viewer. This rectangle is not visible in the postscript document. This function sets the appearance and width of the border line. - + @@ -32,27 +32,27 @@ psdoc - + Resource identifier of the postscript file as returned by ps_new. - + style - + style can be solid or dashed. - + width - - The line width of the border. - + + The line width of the border. + @@ -61,9 +61,9 @@ &reftitle.returnvalues; - + &return.success; - + diff --git a/reference/ps/functions/ps-set-info.xml b/reference/ps/functions/ps-set-info.xml index b00cf1909..6d258310f 100644 --- a/reference/ps/functions/ps-set-info.xml +++ b/reference/ps/functions/ps-set-info.xml @@ -15,23 +15,23 @@ stringkey stringvalue - + Sets certain information fields of the document. This fields will be shown as a comment in the header of the PostScript file. If the document is converted to pdf this fields will also be used for the document information. - - + + The BoundingBox is usually set to the value given to the first page. This only works if ps_findfont has not been called before. In such cases the BoundingBox would be left unset unless you set it explicitly with this function. - - + + This function will have no effect anymore when the header of the postscript file has been already written. It must be called before the first page or the first call of ps_findfont. - + @@ -41,29 +41,29 @@ psdoc - + Resource identifier of the postscript file as returned by ps_new. - + key - + The name of the information field to set. The values which can be set are Keywords, Subject, Title, Creator, Author, BoundingBox, and Orientation. Be aware that some of them has a meaning to PostScript viewers. - + value - + The value of the information field. The field Orientation can be set to either Portrait or Landscape. The @@ -71,13 +71,13 @@ The first two numbers are the coordinates of the lower left corner of the page. The last two numbers are the coordinates of the upper right corner. - + - + Up to version 0.2.6 of pslib, the BoundingBox and Orientation will be overwritten by ps_begin_page, unless ps_findfont has been called before. - + @@ -87,9 +87,9 @@ &reftitle.returnvalues; - + &return.success; - + diff --git a/reference/ps/functions/ps-set-parameter.xml b/reference/ps/functions/ps-set-parameter.xml index dd263eb89..c6b21c85d 100644 --- a/reference/ps/functions/ps-set-parameter.xml +++ b/reference/ps/functions/ps-set-parameter.xml @@ -15,10 +15,10 @@ stringname stringvalue - + Sets several parameters which are used by many functions. Parameters are by definition string values. - + @@ -28,26 +28,26 @@ psdoc - + Resource identifier of the postscript file as returned by ps_new. - + name - + For a list of possible names see ps_get_parameter. - + value - + The value of the parameter. - + @@ -56,9 +56,9 @@ &reftitle.returnvalues; - + &return.success; - + diff --git a/reference/ps/functions/ps-set-text-pos.xml b/reference/ps/functions/ps-set-text-pos.xml index dd42dd48f..a35d1a834 100644 --- a/reference/ps/functions/ps-set-text-pos.xml +++ b/reference/ps/functions/ps-set-text-pos.xml @@ -15,17 +15,17 @@ floatx floaty - + Set the position for the next text output. You may alternatively set the x and y value separately by calling ps_set_value and choosing textx respectively texty as the value name. - - + + If you want to output text at a certain position it is more convenient to use ps_show_xy instead of setting the text position and calling ps_show. - + @@ -35,26 +35,26 @@ psdoc - + Resource identifier of the postscript file as returned by ps_new. - + x - + x-coordinate of the new text position. - + y - + y-coordinate of the new text position. - + @@ -63,9 +63,9 @@ &reftitle.returnvalues; - + &return.success; - + diff --git a/reference/ps/functions/ps-set-value.xml b/reference/ps/functions/ps-set-value.xml index be58ad777..aa4cd0282 100644 --- a/reference/ps/functions/ps-set-value.xml +++ b/reference/ps/functions/ps-set-value.xml @@ -15,10 +15,10 @@ stringname floatvalue - + Sets several values which are used by many functions. Parameters are by definition float values. - + @@ -28,10 +28,10 @@ psdoc - + Resource identifier of the postscript file as returned by ps_new. - + @@ -43,41 +43,41 @@ textrendering - + The way how text is shown. - + textx - + The x coordinate for text output. - + texty - + The y coordinate for text output. - + wordspacing - + The distance between words relative to the width of a space. - + leading - + The distance between lines in pixels. - + @@ -87,9 +87,9 @@ value - + The value of the parameter. - + @@ -98,9 +98,9 @@ &reftitle.returnvalues; - + &return.success; - + diff --git a/reference/ps/functions/ps-setcolor.xml b/reference/ps/functions/ps-setcolor.xml index 8e4c79710..06d339a2e 100644 --- a/reference/ps/functions/ps-setcolor.xml +++ b/reference/ps/functions/ps-setcolor.xml @@ -19,9 +19,9 @@ floatc3 floatc4 - + Sets the color for drawing, filling, or both. - + @@ -31,69 +31,69 @@ psdoc - + Resource identifier of the postscript file as returned by ps_new. - + type - - The parameter type can be + + The parameter type can be both, fill, or fillstroke. - + colorspace - + The colorspace should be one of gray, - rgb, cmyk, + rgb, cmyk, spot, pattern. Depending on the colorspace either only the first, the first three or all parameters will be used. - + c1 - + Depending on the colorspace this is either the red component (rgb), the cyan component (cmyk), the gray value (gray), the identifier of the spot color or the identifier of the pattern. - + c2 - + Depending on the colorspace this is either the green component (rgb), the magenta component (cmyk). - + c3 - + Depending on the colorspace this is either the blue component (rgb), the yellow component (cmyk). - + c4 - + This must only be set in cmyk colorspace and specifies the black component. - + @@ -102,19 +102,19 @@ &reftitle.returnvalues; - + &return.success; - + &reftitle.notes; - + The second parameter is currently not always evaluated. The color is sometimes set for filling and drawing just as if fillstroke were passed. - + diff --git a/reference/ps/functions/ps-setdash.xml b/reference/ps/functions/ps-setdash.xml index 09deb8103..be22b37fb 100644 --- a/reference/ps/functions/ps-setdash.xml +++ b/reference/ps/functions/ps-setdash.xml @@ -15,9 +15,9 @@ floaton floatoff - + Sets the length of the black and white portions of a dashed line. - + @@ -27,26 +27,26 @@ psdoc - + Resource identifier of the postscript file as returned by ps_new. - + on - + The length of the dash. - + off - + The length of the gap between dashes. - + @@ -55,9 +55,9 @@ &reftitle.returnvalues; - + &return.success; - + diff --git a/reference/ps/functions/ps-setflat.xml b/reference/ps/functions/ps-setflat.xml index 88926dcec..8b547bb78 100644 --- a/reference/ps/functions/ps-setflat.xml +++ b/reference/ps/functions/ps-setflat.xml @@ -23,18 +23,18 @@ psdoc - + Resource identifier of the postscript file as returned by ps_new. - + value - + The value must be between 0.2 and 1. - + @@ -43,9 +43,9 @@ &reftitle.returnvalues; - + &return.success; - + diff --git a/reference/ps/functions/ps-setfont.xml b/reference/ps/functions/ps-setfont.xml index 5c2d452d2..bcc3aaa43 100644 --- a/reference/ps/functions/ps-setfont.xml +++ b/reference/ps/functions/ps-setfont.xml @@ -15,11 +15,11 @@ intfontid floatsize - + Sets a font, which has to be loaded before with ps_findfont. Outputting text without setting a font results in an error. - + @@ -29,26 +29,26 @@ psdoc - + Resource identifier of the postscript file as returned by ps_new. - + fontid - + The font identifier as returned by ps_findfont. - + size - + The size of the font. - + @@ -57,9 +57,9 @@ &reftitle.returnvalues; - + &return.success; - + diff --git a/reference/ps/functions/ps-setgray.xml b/reference/ps/functions/ps-setgray.xml index 20e59e6d4..93128d13f 100644 --- a/reference/ps/functions/ps-setgray.xml +++ b/reference/ps/functions/ps-setgray.xml @@ -14,11 +14,11 @@ resourcepsdoc floatgray - + Sets the gray value for all following drawing operations. - + - + &reftitle.parameters; @@ -27,18 +27,18 @@ psdoc - + Resource identifier of the postscript file as returned by ps_new. - + gray - + The value must be between 0 (white) and 1 (black). - + @@ -47,9 +47,9 @@ &reftitle.returnvalues; - + &return.success; - + diff --git a/reference/ps/functions/ps-setlinecap.xml b/reference/ps/functions/ps-setlinecap.xml index 4fec1ecf2..180cb7010 100644 --- a/reference/ps/functions/ps-setlinecap.xml +++ b/reference/ps/functions/ps-setlinecap.xml @@ -14,11 +14,11 @@ resourcepsdoc inttype - + Sets how line ends look like. - + - + &reftitle.parameters; @@ -26,21 +26,21 @@ psdoc - + Resource identifier of the postscript file as returned by ps_new. - + type - + The type of line ends. Possible values are PS_LINECAP_BUTT, PS_LINECAP_ROUND, or PS_LINECAP_SQUARED. - + @@ -49,9 +49,9 @@ &reftitle.returnvalues; - + &return.success; - + diff --git a/reference/ps/functions/ps-setlinejoin.xml b/reference/ps/functions/ps-setlinejoin.xml index f645a3159..df0b4b668 100644 --- a/reference/ps/functions/ps-setlinejoin.xml +++ b/reference/ps/functions/ps-setlinejoin.xml @@ -14,9 +14,9 @@ resourcepsdoc inttype - + Sets how lines are joined. - + @@ -26,21 +26,21 @@ psdoc - + Resource identifier of the postscript file as returned by ps_new. - + type - + The way lines are joined. Possible values are PS_LINEJOIN_MITER, PS_LINEJOIN_ROUND, or PS_LINEJOIN_BEVEL. - + @@ -49,9 +49,9 @@ &reftitle.returnvalues; - + &return.success; - + diff --git a/reference/ps/functions/ps-setlinewidth.xml b/reference/ps/functions/ps-setlinewidth.xml index 1d6a667f1..ce33c4497 100644 --- a/reference/ps/functions/ps-setlinewidth.xml +++ b/reference/ps/functions/ps-setlinewidth.xml @@ -14,9 +14,9 @@ resourcepsdoc floatwidth - + Sets the line width for all following drawing operations. - + @@ -26,18 +26,18 @@ psdoc - + Resource identifier of the postscript file as returned by ps_new. - + width - + The width of lines in points. - + @@ -46,9 +46,9 @@ &reftitle.returnvalues; - + &return.success; - + diff --git a/reference/ps/functions/ps-setmiterlimit.xml b/reference/ps/functions/ps-setmiterlimit.xml index 17fe1f691..c7b9caedd 100644 --- a/reference/ps/functions/ps-setmiterlimit.xml +++ b/reference/ps/functions/ps-setmiterlimit.xml @@ -14,12 +14,12 @@ resourcepsdoc floatvalue - + If two lines join in a small angle and the line join is set to PS_LINEJOIN_MITER, then the resulting spike will be very long. The miter limit is the maximum ratio of the miter length (the length of the spike) and the line width. - + @@ -29,20 +29,20 @@ psdoc - + Resource identifier of the postscript file as returned by ps_new. - + value - + The maximum ratio between the miter length and the line width. Larger values (> 10) will result in very long spikes when two lines meet in a small angle. Keep the default unless you know what you are doing. - + @@ -51,9 +51,9 @@ &reftitle.returnvalues; - + &return.success; - + diff --git a/reference/ps/functions/ps-setoverprintmode.xml b/reference/ps/functions/ps-setoverprintmode.xml index 68cc16497..f0d28b0a3 100644 --- a/reference/ps/functions/ps-setoverprintmode.xml +++ b/reference/ps/functions/ps-setoverprintmode.xml @@ -22,17 +22,17 @@ psdoc - + Resource identifier of the postscript file as returned by ps_new. - + mode - - + + @@ -41,9 +41,9 @@ &reftitle.returnvalues; - + &return.success; - + diff --git a/reference/ps/functions/ps-setpolydash.xml b/reference/ps/functions/ps-setpolydash.xml index a48b24805..3f8076abe 100644 --- a/reference/ps/functions/ps-setpolydash.xml +++ b/reference/ps/functions/ps-setpolydash.xml @@ -14,11 +14,11 @@ resourcepsdoc floatarr - + Sets the length of the black and white portions of a dashed line. ps_setpolydash is used to set more complicated dash patterns. - + @@ -28,19 +28,19 @@ psdoc - + Resource identifier of the postscript file as returned by ps_new. - + arr - + arr is a list of length elements alternately for the black and white portion. - + @@ -49,9 +49,9 @@ &reftitle.returnvalues; - + &return.success; - + @@ -83,10 +83,10 @@ ps_delete($ps); ?> ]]> - + This example draws a line with a 10 and 2 points long line, and gaps of 5 points inbetween. - + diff --git a/reference/ps/functions/ps-shading-pattern.xml b/reference/ps/functions/ps-shading-pattern.xml index ca47ee5fd..0f54ffbdd 100644 --- a/reference/ps/functions/ps-shading-pattern.xml +++ b/reference/ps/functions/ps-shading-pattern.xml @@ -15,11 +15,11 @@ intshadingid stringoptlist - + Creates a pattern based on a shading, which has to be created before with ps_shading. Shading patterns can be used like regular patterns. - + @@ -29,27 +29,27 @@ psdoc - + Resource identifier of the postscript file as returned by ps_new. - + shadingid - + The identifier of a shading previously created with ps_shading. - + optlist - + This argument is not currently used. - + @@ -58,9 +58,9 @@ &reftitle.returnvalues; - + The identifier of the pattern &return.falseforfailure;. - + diff --git a/reference/ps/functions/ps-shading.xml b/reference/ps/functions/ps-shading.xml index 6e611f556..7c95fa27a 100644 --- a/reference/ps/functions/ps-shading.xml +++ b/reference/ps/functions/ps-shading.xml @@ -23,14 +23,14 @@ floatc4 stringoptlist - + Creates a shading, which can be used by ps_shfill or ps_shading_pattern. - - + + The color of the shading can be in any color space except for pattern. - + @@ -40,53 +40,53 @@ psdoc - + Resource identifier of the postscript file as returned by ps_new. - + type - + The type of shading can be either radial or axial. Each shading starts with the current fill color and ends with the given color values passed in the parameters c1 to c4 (see ps_setcolor for their meaning). - + x0, x1, y0, y1 - + The coordinates x0, y0, x1, y1 are the start and end point of the shading. If the type of shading is radial the two points are the middle points of a starting and ending circle. - + c1, c2, c3, c4 - + See ps_setcolor for their meaning. - + optlist - + If the shading is of type radial the optlist must also contain the parameters r0 and r1 with the radius of the start and end circle. - + @@ -95,9 +95,9 @@ &reftitle.returnvalues; - + Returns the identifier of the pattern &return.falseforfailure;. - + diff --git a/reference/ps/functions/ps-shfill.xml b/reference/ps/functions/ps-shfill.xml index 394cdbd84..9dbc2ddeb 100644 --- a/reference/ps/functions/ps-shfill.xml +++ b/reference/ps/functions/ps-shfill.xml @@ -14,12 +14,12 @@ resourcepsdoc intshadingid - + Fills an area with a shading, which has to be created before with ps_shading. This is an alternative way to creating a pattern from a shading ps_shading_pattern and using the pattern as the filling color. - + @@ -29,19 +29,19 @@ psdoc - + Resource identifier of the postscript file as returned by ps_new. - + shadingid - + The identifier of a shading previously created with ps_shading. - + @@ -50,9 +50,9 @@ &reftitle.returnvalues; - + &return.success; - + diff --git a/reference/ps/functions/ps-show-boxed.xml b/reference/ps/functions/ps-show-boxed.xml index ed7887b69..375776111 100644 --- a/reference/ps/functions/ps-show-boxed.xml +++ b/reference/ps/functions/ps-show-boxed.xml @@ -20,13 +20,13 @@ stringhmode stringfeature - + Outputs a text in a given box. The lower left corner of the box is at (left, bottom). Line breaks will be inserted where needed. Multiple spaces are treated as one. Tabulators are treated as spaces. - - + + The text will be hyphenated if the parameter hyphenation is set to &true; and the parameter hyphendict contains a valid @@ -41,7 +41,7 @@ indenting of the first m paragraphs set the value parindentskip to a positive number. - + @@ -51,71 +51,71 @@ psdoc - + Resource identifier of the postscript file as returned by ps_new. - + text - + The text to be output into the given box. - + left - + x-coordinate of the lower left corner of the box. - + bottom - + y-coordinate of the lower left corner of the box. - + width - + Width of the box. - + height - + Height of the box. - + hmode - + The parameter hmode can be justify, fulljustify, right, left, or center. The difference of justify and fulljustify just affects the last line of the box. In fulljustify mode the last line will be left and right justified unless this is also the last line of paragraph. In justify mode it will always be left justified. - + feature - - - + + + @@ -133,121 +133,121 @@ leading (value) - Distance between baselines of two consecutive lines. + Distance between baselines of two consecutive lines. linebreak (parameter) - + Set to &true; if you want a carriage return to start a new line instead of treating it as a space. Defaults to &false;. - + parbreak (parameter) - + Set to &true; if you want a carriage return on a single line to start a new paragraph instead of treating it as a space. Defaults to &true;. - + hyphenation (parameter) - + Set to &true; in order to turn hyphenation on. This requires a dictionary to be set with the parameter hyphendict. Defaults to &false;. - + hyphendict (parameter) - + Filename of the dictionary used for hyphenation pattern (see below). - + hyphenminchar (value) - + The number of chars which must at least be left over before or after the hyphen. This implies that only words of at least two times this value will be hyphenated. The default value is three. Setting a value of zero will result in the default value. - + parindent (value) - + Set the amount of space in pixel for indenting the first m lines of a paragraph. m can be set with the value numindentlines. - + parskip (value) - + Set the amount of extra space in pixel between paragraphs. Defaults to 0 which will result in a normal line distance. - + numindentlines (value) - + Number of lines from the start of the paragraph which will be indented. Defaults to 1. - + parindentskip (value) - + Number of paragraphs in the box whose first lines will not be indented. This defaults to 0. This is useful for paragraphs right after a section heading or text being continued in a second box. In both case one would set this to 1. - + linenumbermode (parameter) - + Set how lines are to be numbered. Possible values are box for numbering lines in the whole box or paragraph to number lines within each paragraph. - + linenumberspace (value) - + The space for the column left of the numbered line containing the line number. The line number will be right justified into this column. Defaults to 20. - + linenumbersep (value) - + The space between the column with line numbers and the line itself. Defaults to 5. - + @@ -281,9 +281,9 @@ &reftitle.returnvalues; - + Number of characters that could not be written. - + diff --git a/reference/ps/functions/ps-show-xy.xml b/reference/ps/functions/ps-show-xy.xml index 2ff14292b..467bdc28f 100644 --- a/reference/ps/functions/ps-show-xy.xml +++ b/reference/ps/functions/ps-show-xy.xml @@ -16,9 +16,9 @@ floatx floaty - + Output a text at the given text position. - + @@ -28,34 +28,34 @@ psdoc - + Resource identifier of the postscript file as returned by ps_new. - + text - + The text to be output. - + x - + x-coordinate of the lower left corner of the box surrounding the text. - + y - + y-coordinate of the lower left corner of the box surrounding the text. - + @@ -64,9 +64,9 @@ &reftitle.returnvalues; - + &return.success; - + diff --git a/reference/ps/functions/ps-show-xy2.xml b/reference/ps/functions/ps-show-xy2.xml index a892cd85c..0c1528f07 100644 --- a/reference/ps/functions/ps-show-xy2.xml +++ b/reference/ps/functions/ps-show-xy2.xml @@ -21,9 +21,9 @@ &reftitle.returnvalues; - + &return.success; - + diff --git a/reference/ps/functions/ps-show.xml b/reference/ps/functions/ps-show.xml index de397b263..f07f6c044 100644 --- a/reference/ps/functions/ps-show.xml +++ b/reference/ps/functions/ps-show.xml @@ -14,72 +14,72 @@ resourcepsdoc stringtext - + Output a text at the current text position. The text position can be set by storing the x and y coordinates into the values textx and texty with the function ps_set_value. The function will issue an error if a font was not set before with ps_setfont. - - + + ps_show evaluates the following parameters and values as set by ps_set_parameter and ps_set_value. - + charspacing (value) - + Distance between two consecutive glyphs. If this value is unequal to zero then all ligatures will be resolved. Values less than zero are allowed. - + kerning (parameter) - + Setting this parameter to "false" will turn off kerning. Kerning is turned on by default. - + ligatures (parameter) - - Setting this parameter to "false" will turn off the use of ligatures. + + Setting this parameter to "false" will turn off the use of ligatures. Ligatures are turned on by default. - + underline (parameter) - + Setting this parameter to "true" will turn on underlining. Underlining is turned off by default. - + overline (parameter) - + Setting this parameter to "true" will turn on overlining. Overlining is turned off by default. - + strikeout (parameter) - - + + Setting this parameter to "true" will turn on striking out. Striking out is turned off by default. - + @@ -92,18 +92,18 @@ psdoc - + Resource identifier of the postscript file as returned by ps_new. - + text - + The text to be output. - + @@ -112,9 +112,9 @@ &reftitle.returnvalues; - + &return.success; - + diff --git a/reference/ps/functions/ps-show2.xml b/reference/ps/functions/ps-show2.xml index a00dd68c0..f37af4ba5 100644 --- a/reference/ps/functions/ps-show2.xml +++ b/reference/ps/functions/ps-show2.xml @@ -14,9 +14,9 @@ stringtext intlen - + Output text at the current position. Do not print more than len characters. - + @@ -26,26 +26,26 @@ psdoc - + Resource identifier of the postscript file as returned by ps_new. - + text - + The text to be output. - + len - + The maximum number of characters to print. - + @@ -54,9 +54,9 @@ &reftitle.returnvalues; - + &return.success; - + diff --git a/reference/ps/functions/ps-string-geometry.xml b/reference/ps/functions/ps-string-geometry.xml index f052af4a2..3a01042a9 100644 --- a/reference/ps/functions/ps-string-geometry.xml +++ b/reference/ps/functions/ps-string-geometry.xml @@ -16,11 +16,11 @@ intfontid0 floatsize0.0 - + This function is similar to ps_stringwidth but returns an array of dimensions containing the width, ascender, and descender of the text. - + @@ -30,36 +30,36 @@ psdoc - + Resource identifier of the postscript file as returned by ps_new. - + text - + The text for which the geometry is to be calculated. - + fontid - + The identifier of the font to be used. If not font is specified the current font will be used. - + size - + The size of the font. If no size is specified the current size is used. - + @@ -68,12 +68,12 @@ &reftitle.returnvalues; - + An array of the dimensions of a string. The element 'width' contains the width of the string as returned by ps_stringwidth. The element 'descender' contains the maximum descender and 'ascender' the maximum ascender of the string. - + diff --git a/reference/ps/functions/ps-stringwidth.xml b/reference/ps/functions/ps-stringwidth.xml index 5572b1130..081620ac9 100644 --- a/reference/ps/functions/ps-stringwidth.xml +++ b/reference/ps/functions/ps-stringwidth.xml @@ -6,7 +6,7 @@ ps_stringwidth Gets width of a string - + &reftitle.description; @@ -16,13 +16,13 @@ intfontid0 floatsize0.0 - + Calculates the width of a string in points if it was output in the given font and font size. This function needs an Adobe font metrics file to calculate the precise width. If kerning is turned on, it will be taken into account. - + @@ -32,36 +32,36 @@ psdoc - + Resource identifier of the postscript file as returned by ps_new. - + text - + The text for which the width is to be calculated. - + fontid - + The identifier of the font to be used. If not font is specified the current font will be used. - + size - + The size of the font. If no size is specified the current size is used. - + @@ -70,9 +70,9 @@ &reftitle.returnvalues; - + Width of a string in points. - + diff --git a/reference/ps/functions/ps-stroke.xml b/reference/ps/functions/ps-stroke.xml index 865b99587..cea1f034f 100644 --- a/reference/ps/functions/ps-stroke.xml +++ b/reference/ps/functions/ps-stroke.xml @@ -13,10 +13,10 @@ boolps_stroke resourcepsdoc - + Draws the path constructed with previously called drawing functions like ps_lineto. - + @@ -26,10 +26,10 @@ psdoc - + Resource identifier of the postscript file as returned by ps_new. - + @@ -38,9 +38,9 @@ &reftitle.returnvalues; - + &return.success; - + diff --git a/reference/ps/functions/ps-symbol-name.xml b/reference/ps/functions/ps-symbol-name.xml index 4807c2df2..9e4c340d6 100644 --- a/reference/ps/functions/ps-symbol-name.xml +++ b/reference/ps/functions/ps-symbol-name.xml @@ -15,10 +15,10 @@ intord intfontid0 - + This function needs an Adobe font metrics file to know which glyphs are available. - + @@ -28,28 +28,28 @@ psdoc - + Resource identifier of the postscript file as returned by ps_new. - + ord - + The parameter ord is the position of the glyph in the font encoding vector. - + fontid - + The identifier of the font to be used. If not font is specified the current font will be used. - + @@ -58,9 +58,9 @@ &reftitle.returnvalues; - + The name of a glyph in the given font. - + diff --git a/reference/ps/functions/ps-symbol-width.xml b/reference/ps/functions/ps-symbol-width.xml index 84872d6af..a21991320 100644 --- a/reference/ps/functions/ps-symbol-width.xml +++ b/reference/ps/functions/ps-symbol-width.xml @@ -16,11 +16,11 @@ intfontid0 floatsize0.0 - + Calculates the width of a glyph in points if it was output in the given font and font size. This function needs an Adobe font metrics file to calculate the precise width. - + @@ -30,36 +30,36 @@ psdoc - + Resource identifier of the postscript file as returned by ps_new. - + ord - + The position of the glyph in the font encoding vector. - + fontid - + The identifier of the font to be used. If not font is specified the current font will be used. - + size - + The size of the font. If no size is specified the current size is used. - + @@ -68,9 +68,9 @@ &reftitle.returnvalues; - + The width of a glyph in points. - + diff --git a/reference/ps/functions/ps-symbol.xml b/reference/ps/functions/ps-symbol.xml index 978e94dc2..8aa02a68a 100644 --- a/reference/ps/functions/ps-symbol.xml +++ b/reference/ps/functions/ps-symbol.xml @@ -14,11 +14,11 @@ resourcepsdoc intord - + Output the glyph at position ord in the font encoding vector of the current font. The font encoding for a font can be set when loading the font with ps_findfont. - + @@ -28,18 +28,18 @@ psdoc - + Resource identifier of the postscript file as returned by ps_new. - + ord - + The position of the glyph in the font encoding vector. - + @@ -48,9 +48,9 @@ &reftitle.returnvalues; - + &return.success; - + diff --git a/reference/ps/functions/ps-translate.xml b/reference/ps/functions/ps-translate.xml index 5c4521bfe..8e9bba70a 100644 --- a/reference/ps/functions/ps-translate.xml +++ b/reference/ps/functions/ps-translate.xml @@ -15,9 +15,9 @@ floatx floaty - + Sets a new initial point of the coordinate system. - + @@ -27,26 +27,26 @@ psdoc - + Resource identifier of the postscript file as returned by ps_new. - + x - + x-coordinate of the origin of the translated coordinate system. - + y - + y-coordinate of the origin of the translated coordinate system. - + @@ -55,9 +55,9 @@ &reftitle.returnvalues; - + &return.success; - + @@ -114,19 +114,19 @@ ps_delete($ps); ]]> - The above example demonstrates two possible ways to place + The above example demonstrates two possible ways to place a graphic (in this case just a rectangle) at any position on the page, while the graphic itself uses its own coordinate system. The trick is to change the origin of the current coordinate system before drawing the rectangle. The translation has to be undone after the graphic has been drawn. - - + + On the second page a slightly different and more elegant approach is applied. Instead of undoing the translation with a second call of ps_translate the graphics context is saved before modifying the coordinate system and restored after drawing the rectangle. - + diff --git a/reference/ps/reference.xml b/reference/ps/reference.xml index fca9882f3..284af8fe9 100644 --- a/reference/ps/reference.xml +++ b/reference/ps/reference.xml @@ -7,12 +7,12 @@
    Contact Information - + If you have comments, bugfixes, enhancements for either this extension or pslib then please drop me a mail steinm@php.net. Any help is very welcome. - +
    diff --git a/reference/ps/setup.xml b/reference/ps/setup.xml index e0d509801..ae5bf3450 100644 --- a/reference/ps/setup.xml +++ b/reference/ps/setup.xml @@ -7,10 +7,10 @@
    &reftitle.required; - + You need at least pslib >= 0.1.12. The ps library (pslib) is available at &url.pslib;. - +
    @@ -21,10 +21,10 @@
    &reftitle.resources; - + This extension defines a PostScript document resource returned by ps_new. - +
    diff --git a/reference/pthreads/book.xml b/reference/pthreads/book.xml index b60c8b78b..7424f3e4a 100644 --- a/reference/pthreads/book.xml +++ b/reference/pthreads/book.xml @@ -1,6 +1,6 @@ - + pthreads pthreads diff --git a/reference/pthreads/collectable.xml b/reference/pthreads/collectable.xml index 51553ec79..0d983deb6 100644 --- a/reference/pthreads/collectable.xml +++ b/reference/pthreads/collectable.xml @@ -1,6 +1,6 @@ - + The Collectable interface Collectable diff --git a/reference/pthreads/collectable/isgarbage.xml b/reference/pthreads/collectable/isgarbage.xml index 1001901c0..551088b69 100644 --- a/reference/pthreads/collectable/isgarbage.xml +++ b/reference/pthreads/collectable/isgarbage.xml @@ -1,6 +1,6 @@ - + Collectable::isGarbage Determine whether an object has been marked as garbage diff --git a/reference/pthreads/configure.xml b/reference/pthreads/configure.xml index c925c2fe4..ae5c5c7a1 100644 --- a/reference/pthreads/configure.xml +++ b/reference/pthreads/configure.xml @@ -1,6 +1,6 @@ -
    +
    &reftitle.install; diff --git a/reference/pthreads/constants.xml b/reference/pthreads/constants.xml index ebcdb94c2..3ab3825fb 100644 --- a/reference/pthreads/constants.xml +++ b/reference/pthreads/constants.xml @@ -1,6 +1,6 @@ - + &reftitle.constants; &extension.constants; diff --git a/reference/pthreads/pool.xml b/reference/pthreads/pool.xml index f8eb53aa9..fe05105e1 100644 --- a/reference/pthreads/pool.xml +++ b/reference/pthreads/pool.xml @@ -1,6 +1,6 @@ - + The Pool class Pool diff --git a/reference/pthreads/pool/collect.xml b/reference/pthreads/pool/collect.xml index 43c7ee071..584646804 100644 --- a/reference/pthreads/pool/collect.xml +++ b/reference/pthreads/pool/collect.xml @@ -1,6 +1,6 @@ - + Pool::collect Collect references to completed tasks diff --git a/reference/pthreads/pool/construct.xml b/reference/pthreads/pool/construct.xml index 83a9c07af..b57f78f27 100644 --- a/reference/pthreads/pool/construct.xml +++ b/reference/pthreads/pool/construct.xml @@ -1,6 +1,6 @@ - + Pool::__construct Creates a new Pool of Workers diff --git a/reference/pthreads/pool/resize.xml b/reference/pthreads/pool/resize.xml index d5be09548..b9e6b5a6a 100644 --- a/reference/pthreads/pool/resize.xml +++ b/reference/pthreads/pool/resize.xml @@ -1,6 +1,6 @@ - + Pool::resize Resize the Pool diff --git a/reference/pthreads/pool/shutdown.xml b/reference/pthreads/pool/shutdown.xml index 91550d200..2bd821810 100644 --- a/reference/pthreads/pool/shutdown.xml +++ b/reference/pthreads/pool/shutdown.xml @@ -1,6 +1,6 @@ - + Pool::shutdown Shutdown all workers diff --git a/reference/pthreads/pool/submit.xml b/reference/pthreads/pool/submit.xml index ec96bed83..0ab8424b8 100644 --- a/reference/pthreads/pool/submit.xml +++ b/reference/pthreads/pool/submit.xml @@ -1,6 +1,6 @@ - + Pool::submit Submits an object for execution diff --git a/reference/pthreads/pool/submitTo.xml b/reference/pthreads/pool/submitTo.xml index cfec954c9..2ba59f33c 100644 --- a/reference/pthreads/pool/submitTo.xml +++ b/reference/pthreads/pool/submitTo.xml @@ -1,6 +1,6 @@ - + Pool::submitTo Submits a task to a specific worker for execution diff --git a/reference/pthreads/setup.xml b/reference/pthreads/setup.xml index 97318f420..8fef1c616 100644 --- a/reference/pthreads/setup.xml +++ b/reference/pthreads/setup.xml @@ -1,6 +1,6 @@ - + &reftitle.setup;
    diff --git a/reference/pthreads/thread.xml b/reference/pthreads/thread.xml index 3093a869e..a3f50c9e8 100644 --- a/reference/pthreads/thread.xml +++ b/reference/pthreads/thread.xml @@ -1,6 +1,6 @@ - + The Thread class Thread diff --git a/reference/pthreads/thread/getcreatorid.xml b/reference/pthreads/thread/getcreatorid.xml index 5fe20d26a..10d6ca558 100644 --- a/reference/pthreads/thread/getcreatorid.xml +++ b/reference/pthreads/thread/getcreatorid.xml @@ -1,6 +1,6 @@ - + Thread::getCreatorId Identification diff --git a/reference/pthreads/thread/getcurrentthread.xml b/reference/pthreads/thread/getcurrentthread.xml index 74b19ea61..90921339e 100644 --- a/reference/pthreads/thread/getcurrentthread.xml +++ b/reference/pthreads/thread/getcurrentthread.xml @@ -1,6 +1,6 @@ - + Thread::getCurrentThread Identification diff --git a/reference/pthreads/thread/getcurrentthreadid.xml b/reference/pthreads/thread/getcurrentthreadid.xml index 1cc35796e..f82a94cc5 100644 --- a/reference/pthreads/thread/getcurrentthreadid.xml +++ b/reference/pthreads/thread/getcurrentthreadid.xml @@ -1,6 +1,6 @@ - + Thread::getCurrentThreadId Identification diff --git a/reference/pthreads/thread/getthreadid.xml b/reference/pthreads/thread/getthreadid.xml index 3beab6e40..41414a74f 100644 --- a/reference/pthreads/thread/getthreadid.xml +++ b/reference/pthreads/thread/getthreadid.xml @@ -1,6 +1,6 @@ - + Thread::getThreadId Identification diff --git a/reference/pthreads/thread/isjoined.xml b/reference/pthreads/thread/isjoined.xml index d687caf89..089e6eea0 100644 --- a/reference/pthreads/thread/isjoined.xml +++ b/reference/pthreads/thread/isjoined.xml @@ -1,6 +1,6 @@ - + Thread::isJoined State Detection diff --git a/reference/pthreads/thread/isstarted.xml b/reference/pthreads/thread/isstarted.xml index adc3efab4..2565a7d51 100644 --- a/reference/pthreads/thread/isstarted.xml +++ b/reference/pthreads/thread/isstarted.xml @@ -1,6 +1,6 @@ - + Thread::isStarted State Detection diff --git a/reference/pthreads/thread/join.xml b/reference/pthreads/thread/join.xml index b73729fcd..7cb46bcbc 100644 --- a/reference/pthreads/thread/join.xml +++ b/reference/pthreads/thread/join.xml @@ -1,6 +1,6 @@ - + Thread::join Synchronization diff --git a/reference/pthreads/thread/start.xml b/reference/pthreads/thread/start.xml index 3fc234e73..8227b4d31 100644 --- a/reference/pthreads/thread/start.xml +++ b/reference/pthreads/thread/start.xml @@ -1,6 +1,6 @@ - + Thread::start Execution diff --git a/reference/pthreads/threaded.xml b/reference/pthreads/threaded.xml index 9988c1757..ed3fefbd6 100644 --- a/reference/pthreads/threaded.xml +++ b/reference/pthreads/threaded.xml @@ -1,6 +1,6 @@ - + The Threaded class Threaded diff --git a/reference/pthreads/threaded/chunk.xml b/reference/pthreads/threaded/chunk.xml index 48487c151..00814f57b 100644 --- a/reference/pthreads/threaded/chunk.xml +++ b/reference/pthreads/threaded/chunk.xml @@ -1,6 +1,6 @@ - + Threaded::chunk Manipulation diff --git a/reference/pthreads/threaded/count.xml b/reference/pthreads/threaded/count.xml index 0d6400ef2..28fb9f3ad 100644 --- a/reference/pthreads/threaded/count.xml +++ b/reference/pthreads/threaded/count.xml @@ -1,6 +1,6 @@ - + Threaded::count Manipulation diff --git a/reference/pthreads/threaded/extend.xml b/reference/pthreads/threaded/extend.xml index 51c5bcc70..a4eec2caa 100644 --- a/reference/pthreads/threaded/extend.xml +++ b/reference/pthreads/threaded/extend.xml @@ -1,6 +1,6 @@ - + Threaded::extend Runtime Manipulation diff --git a/reference/pthreads/threaded/isrunning.xml b/reference/pthreads/threaded/isrunning.xml index 6f1282eec..1c7037da3 100644 --- a/reference/pthreads/threaded/isrunning.xml +++ b/reference/pthreads/threaded/isrunning.xml @@ -1,6 +1,6 @@ - + Threaded::isRunning State Detection diff --git a/reference/pthreads/threaded/isterminated.xml b/reference/pthreads/threaded/isterminated.xml index d3d04f408..d985bc128 100644 --- a/reference/pthreads/threaded/isterminated.xml +++ b/reference/pthreads/threaded/isterminated.xml @@ -1,6 +1,6 @@ - + Threaded::isTerminated State Detection diff --git a/reference/pthreads/threaded/merge.xml b/reference/pthreads/threaded/merge.xml index 4101731a2..c430610e8 100644 --- a/reference/pthreads/threaded/merge.xml +++ b/reference/pthreads/threaded/merge.xml @@ -1,6 +1,6 @@ - + Threaded::merge Manipulation diff --git a/reference/pthreads/threaded/notify.xml b/reference/pthreads/threaded/notify.xml index d02455943..8e170572b 100644 --- a/reference/pthreads/threaded/notify.xml +++ b/reference/pthreads/threaded/notify.xml @@ -1,6 +1,6 @@ - + Threaded::notify Synchronization diff --git a/reference/pthreads/threaded/notifyone.xml b/reference/pthreads/threaded/notifyone.xml index 3b990dfb6..3db0e153b 100644 --- a/reference/pthreads/threaded/notifyone.xml +++ b/reference/pthreads/threaded/notifyone.xml @@ -1,6 +1,6 @@ - + Threaded::notifyOne Synchronization diff --git a/reference/pthreads/threaded/pop.xml b/reference/pthreads/threaded/pop.xml index b31805194..da4643c74 100644 --- a/reference/pthreads/threaded/pop.xml +++ b/reference/pthreads/threaded/pop.xml @@ -1,6 +1,6 @@ - + Threaded::pop Manipulation diff --git a/reference/pthreads/threaded/run.xml b/reference/pthreads/threaded/run.xml index 85f42b008..abca94fc1 100644 --- a/reference/pthreads/threaded/run.xml +++ b/reference/pthreads/threaded/run.xml @@ -1,6 +1,6 @@ - + Threaded::run Execution diff --git a/reference/pthreads/threaded/shift.xml b/reference/pthreads/threaded/shift.xml index a1f4d9b96..8298f5f19 100644 --- a/reference/pthreads/threaded/shift.xml +++ b/reference/pthreads/threaded/shift.xml @@ -1,6 +1,6 @@ - + Threaded::shift Manipulation diff --git a/reference/pthreads/threaded/synchronized.xml b/reference/pthreads/threaded/synchronized.xml index 19024ab48..648ed3084 100644 --- a/reference/pthreads/threaded/synchronized.xml +++ b/reference/pthreads/threaded/synchronized.xml @@ -1,6 +1,6 @@ - + Threaded::synchronized Synchronization diff --git a/reference/pthreads/threaded/wait.xml b/reference/pthreads/threaded/wait.xml index a6e5de14f..913143c3a 100644 --- a/reference/pthreads/threaded/wait.xml +++ b/reference/pthreads/threaded/wait.xml @@ -1,6 +1,6 @@ - + Threaded::wait Synchronization diff --git a/reference/pthreads/worker.xml b/reference/pthreads/worker.xml index a0f511a55..d33b8b44e 100644 --- a/reference/pthreads/worker.xml +++ b/reference/pthreads/worker.xml @@ -1,6 +1,6 @@ - + The Worker class Worker diff --git a/reference/pthreads/worker/collect.xml b/reference/pthreads/worker/collect.xml index 3eabd66dd..f7a772c54 100644 --- a/reference/pthreads/worker/collect.xml +++ b/reference/pthreads/worker/collect.xml @@ -1,6 +1,6 @@ - + Worker::collect Collect references to completed tasks diff --git a/reference/pthreads/worker/getstacked.xml b/reference/pthreads/worker/getstacked.xml index b685a3e79..fcd78c891 100644 --- a/reference/pthreads/worker/getstacked.xml +++ b/reference/pthreads/worker/getstacked.xml @@ -1,6 +1,6 @@ - + Worker::getStacked Gets the remaining stack size diff --git a/reference/pthreads/worker/isshutdown.xml b/reference/pthreads/worker/isshutdown.xml index 7387dc1d9..386838149 100644 --- a/reference/pthreads/worker/isshutdown.xml +++ b/reference/pthreads/worker/isshutdown.xml @@ -1,6 +1,6 @@ - + Worker::isShutdown State Detection diff --git a/reference/pthreads/worker/shutdown.xml b/reference/pthreads/worker/shutdown.xml index efe438c5a..e9e19c91f 100644 --- a/reference/pthreads/worker/shutdown.xml +++ b/reference/pthreads/worker/shutdown.xml @@ -1,6 +1,6 @@ - + Worker::shutdown Shutdown the worker diff --git a/reference/pthreads/worker/stack.xml b/reference/pthreads/worker/stack.xml index 5f52d80ae..82e2abe21 100644 --- a/reference/pthreads/worker/stack.xml +++ b/reference/pthreads/worker/stack.xml @@ -1,6 +1,6 @@ - + Worker::stack Stacking work diff --git a/reference/pthreads/worker/unstack.xml b/reference/pthreads/worker/unstack.xml index 8eda43e85..cc21fc81a 100644 --- a/reference/pthreads/worker/unstack.xml +++ b/reference/pthreads/worker/unstack.xml @@ -1,6 +1,6 @@ - + Worker::unstack Unstacking work diff --git a/reference/quickhash/book.xml b/reference/quickhash/book.xml index 06d1b87a6..96841da91 100644 --- a/reference/quickhash/book.xml +++ b/reference/quickhash/book.xml @@ -1,6 +1,6 @@ - + Quickhash Quickhash diff --git a/reference/quickhash/quickhashinthash.xml b/reference/quickhash/quickhashinthash.xml index 5286ac49e..aa7339848 100644 --- a/reference/quickhash/quickhashinthash.xml +++ b/reference/quickhash/quickhashinthash.xml @@ -1,6 +1,6 @@ - + The QuickHashIntHash class QuickHashIntHash diff --git a/reference/quickhash/quickhashinthash/add.xml b/reference/quickhash/quickhashinthash/add.xml index d85702ec4..b18ef9528 100644 --- a/reference/quickhash/quickhashinthash/add.xml +++ b/reference/quickhash/quickhashinthash/add.xml @@ -1,6 +1,6 @@ - + QuickHashIntHash::add This method adds a new entry to the hash diff --git a/reference/quickhash/quickhashinthash/construct.xml b/reference/quickhash/quickhashinthash/construct.xml index 7ba6b1ce9..a75f9a3a1 100644 --- a/reference/quickhash/quickhashinthash/construct.xml +++ b/reference/quickhash/quickhashinthash/construct.xml @@ -1,6 +1,6 @@ - + QuickHashIntHash::__construct Creates a new QuickHashIntHash object diff --git a/reference/quickhash/quickhashinthash/delete.xml b/reference/quickhash/quickhashinthash/delete.xml index 6f6f7c0c9..fc02d1f8d 100644 --- a/reference/quickhash/quickhashinthash/delete.xml +++ b/reference/quickhash/quickhashinthash/delete.xml @@ -1,6 +1,6 @@ - + QuickHashIntHash::delete This method deletes an entry from the hash diff --git a/reference/quickhash/quickhashinthash/exists.xml b/reference/quickhash/quickhashinthash/exists.xml index 9feabc65a..6fe6f94ee 100644 --- a/reference/quickhash/quickhashinthash/exists.xml +++ b/reference/quickhash/quickhashinthash/exists.xml @@ -1,6 +1,6 @@ - + QuickHashIntHash::exists This method checks whether a key is part of the hash diff --git a/reference/quickhash/quickhashinthash/get.xml b/reference/quickhash/quickhashinthash/get.xml index 2b6f23566..ae99dc003 100644 --- a/reference/quickhash/quickhashinthash/get.xml +++ b/reference/quickhash/quickhashinthash/get.xml @@ -1,6 +1,6 @@ - + QuickHashIntHash::get This method retrieves a value from the hash by its key diff --git a/reference/quickhash/quickhashinthash/getsize.xml b/reference/quickhash/quickhashinthash/getsize.xml index 400939a74..e9f707f78 100644 --- a/reference/quickhash/quickhashinthash/getsize.xml +++ b/reference/quickhash/quickhashinthash/getsize.xml @@ -1,6 +1,6 @@ - + QuickHashIntHash::getSize Returns the number of elements in the hash diff --git a/reference/quickhash/quickhashinthash/loadfromfile.xml b/reference/quickhash/quickhashinthash/loadfromfile.xml index 2d5c58f8f..8e4ae3711 100644 --- a/reference/quickhash/quickhashinthash/loadfromfile.xml +++ b/reference/quickhash/quickhashinthash/loadfromfile.xml @@ -1,6 +1,6 @@ - + QuickHashIntHash::loadFromFile This factory method creates a hash from a file diff --git a/reference/quickhash/quickhashinthash/loadfromstring.xml b/reference/quickhash/quickhashinthash/loadfromstring.xml index bc20e9cc3..4c825e0c4 100644 --- a/reference/quickhash/quickhashinthash/loadfromstring.xml +++ b/reference/quickhash/quickhashinthash/loadfromstring.xml @@ -1,6 +1,6 @@ - + QuickHashIntHash::loadFromString This factory method creates a hash from a string diff --git a/reference/quickhash/quickhashinthash/savetofile.xml b/reference/quickhash/quickhashinthash/savetofile.xml index fb0d7ac04..13bd04f99 100644 --- a/reference/quickhash/quickhashinthash/savetofile.xml +++ b/reference/quickhash/quickhashinthash/savetofile.xml @@ -1,6 +1,6 @@ - + QuickHashIntHash::saveToFile This method stores an in-memory hash to disk diff --git a/reference/quickhash/quickhashinthash/savetostring.xml b/reference/quickhash/quickhashinthash/savetostring.xml index 554657cb7..54cff7bec 100644 --- a/reference/quickhash/quickhashinthash/savetostring.xml +++ b/reference/quickhash/quickhashinthash/savetostring.xml @@ -1,6 +1,6 @@ - + QuickHashIntHash::saveToString This method returns a serialized version of the hash diff --git a/reference/quickhash/quickhashinthash/set.xml b/reference/quickhash/quickhashinthash/set.xml index 8cad6bd2a..3861f420f 100644 --- a/reference/quickhash/quickhashinthash/set.xml +++ b/reference/quickhash/quickhashinthash/set.xml @@ -1,6 +1,6 @@ - + QuickHashIntHash::set This method updates an entry in the hash with a new value, or diff --git a/reference/quickhash/quickhashinthash/update.xml b/reference/quickhash/quickhashinthash/update.xml index 2f519c976..1c0da03cc 100644 --- a/reference/quickhash/quickhashinthash/update.xml +++ b/reference/quickhash/quickhashinthash/update.xml @@ -1,6 +1,6 @@ - + QuickHashIntHash::update This method updates an entry in the hash with a new value diff --git a/reference/quickhash/quickhashintset.xml b/reference/quickhash/quickhashintset.xml index 17abce2c0..43428ef0f 100644 --- a/reference/quickhash/quickhashintset.xml +++ b/reference/quickhash/quickhashintset.xml @@ -1,6 +1,6 @@ - + The QuickHashIntSet class QuickHashIntSet diff --git a/reference/quickhash/quickhashintset/add.xml b/reference/quickhash/quickhashintset/add.xml index 2a3846388..ab9b91619 100644 --- a/reference/quickhash/quickhashintset/add.xml +++ b/reference/quickhash/quickhashintset/add.xml @@ -1,6 +1,6 @@ - + QuickHashIntSet::add This method adds a new entry to the set diff --git a/reference/quickhash/quickhashintset/construct.xml b/reference/quickhash/quickhashintset/construct.xml index be488e71f..0f1a4aa07 100644 --- a/reference/quickhash/quickhashintset/construct.xml +++ b/reference/quickhash/quickhashintset/construct.xml @@ -1,6 +1,6 @@ - + QuickHashIntSet::__construct Creates a new QuickHashIntSet object diff --git a/reference/quickhash/quickhashintset/delete.xml b/reference/quickhash/quickhashintset/delete.xml index a54d42390..6ba9dab49 100644 --- a/reference/quickhash/quickhashintset/delete.xml +++ b/reference/quickhash/quickhashintset/delete.xml @@ -1,6 +1,6 @@ - + QuickHashIntSet::delete This method deletes an entry from the set diff --git a/reference/quickhash/quickhashintset/exists.xml b/reference/quickhash/quickhashintset/exists.xml index 80462da31..9f852bbf7 100644 --- a/reference/quickhash/quickhashintset/exists.xml +++ b/reference/quickhash/quickhashintset/exists.xml @@ -1,6 +1,6 @@ - + QuickHashIntSet::exists This method checks whether a key is part of the set diff --git a/reference/quickhash/quickhashintset/getsize.xml b/reference/quickhash/quickhashintset/getsize.xml index 4a9c6d747..0a20398ff 100644 --- a/reference/quickhash/quickhashintset/getsize.xml +++ b/reference/quickhash/quickhashintset/getsize.xml @@ -1,6 +1,6 @@ - + QuickHashIntSet::getSize Returns the number of elements in the set diff --git a/reference/quickhash/quickhashintset/loadfromfile.xml b/reference/quickhash/quickhashintset/loadfromfile.xml index b083b4306..5351ec5bd 100644 --- a/reference/quickhash/quickhashintset/loadfromfile.xml +++ b/reference/quickhash/quickhashintset/loadfromfile.xml @@ -1,6 +1,6 @@ - + QuickHashIntSet::loadFromFile This factory method creates a set from a file diff --git a/reference/quickhash/quickhashintset/loadfromstring.xml b/reference/quickhash/quickhashintset/loadfromstring.xml index d3d0001c3..764981774 100644 --- a/reference/quickhash/quickhashintset/loadfromstring.xml +++ b/reference/quickhash/quickhashintset/loadfromstring.xml @@ -1,6 +1,6 @@ - + QuickHashIntSet::loadFromString This factory method creates a set from a string diff --git a/reference/quickhash/quickhashintset/savetofile.xml b/reference/quickhash/quickhashintset/savetofile.xml index f3c55336a..b1ed0620f 100644 --- a/reference/quickhash/quickhashintset/savetofile.xml +++ b/reference/quickhash/quickhashintset/savetofile.xml @@ -1,6 +1,6 @@ - + QuickHashIntSet::saveToFile This method stores an in-memory set to disk diff --git a/reference/quickhash/quickhashintset/savetostring.xml b/reference/quickhash/quickhashintset/savetostring.xml index 88739feed..1b80a8b13 100644 --- a/reference/quickhash/quickhashintset/savetostring.xml +++ b/reference/quickhash/quickhashintset/savetostring.xml @@ -1,6 +1,6 @@ - + QuickHashIntSet::saveToString This method returns a serialized version of the set diff --git a/reference/quickhash/quickhashintstringhash.xml b/reference/quickhash/quickhashintstringhash.xml index c87dd5df8..b12c31117 100644 --- a/reference/quickhash/quickhashintstringhash.xml +++ b/reference/quickhash/quickhashintstringhash.xml @@ -1,6 +1,6 @@ - + The QuickHashIntStringHash class QuickHashIntStringHash diff --git a/reference/quickhash/quickhashintstringhash/add.xml b/reference/quickhash/quickhashintstringhash/add.xml index 8c1da7fe8..467e74faa 100644 --- a/reference/quickhash/quickhashintstringhash/add.xml +++ b/reference/quickhash/quickhashintstringhash/add.xml @@ -1,6 +1,6 @@ - + QuickHashIntStringHash::add This method adds a new entry to the hash diff --git a/reference/quickhash/quickhashintstringhash/construct.xml b/reference/quickhash/quickhashintstringhash/construct.xml index d9a8ff8cc..98edaa06b 100644 --- a/reference/quickhash/quickhashintstringhash/construct.xml +++ b/reference/quickhash/quickhashintstringhash/construct.xml @@ -1,6 +1,6 @@ - + QuickHashIntStringHash::__construct Creates a new QuickHashIntStringHash object diff --git a/reference/quickhash/quickhashintstringhash/delete.xml b/reference/quickhash/quickhashintstringhash/delete.xml index db78a1f4d..56e61af13 100644 --- a/reference/quickhash/quickhashintstringhash/delete.xml +++ b/reference/quickhash/quickhashintstringhash/delete.xml @@ -1,6 +1,6 @@ - + QuickHashIntStringHash::delete This method deletes an entry from the hash diff --git a/reference/quickhash/quickhashintstringhash/exists.xml b/reference/quickhash/quickhashintstringhash/exists.xml index 02aeedee0..b386b1580 100644 --- a/reference/quickhash/quickhashintstringhash/exists.xml +++ b/reference/quickhash/quickhashintstringhash/exists.xml @@ -1,6 +1,6 @@ - + QuickHashIntStringHash::exists This method checks whether a key is part of the hash diff --git a/reference/quickhash/quickhashintstringhash/get.xml b/reference/quickhash/quickhashintstringhash/get.xml index 4d25e125d..8ef5a1f75 100644 --- a/reference/quickhash/quickhashintstringhash/get.xml +++ b/reference/quickhash/quickhashintstringhash/get.xml @@ -1,6 +1,6 @@ - + QuickHashIntStringHash::get This method retrieves a value from the hash by its key diff --git a/reference/quickhash/quickhashintstringhash/getsize.xml b/reference/quickhash/quickhashintstringhash/getsize.xml index 759f0a9cc..3abb96880 100644 --- a/reference/quickhash/quickhashintstringhash/getsize.xml +++ b/reference/quickhash/quickhashintstringhash/getsize.xml @@ -1,6 +1,6 @@ - + QuickHashIntStringHash::getSize Returns the number of elements in the hash diff --git a/reference/quickhash/quickhashintstringhash/loadfromfile.xml b/reference/quickhash/quickhashintstringhash/loadfromfile.xml index c4399960a..a6c9bd761 100644 --- a/reference/quickhash/quickhashintstringhash/loadfromfile.xml +++ b/reference/quickhash/quickhashintstringhash/loadfromfile.xml @@ -1,6 +1,6 @@ - + QuickHashIntStringHash::loadFromFile This factory method creates a hash from a file diff --git a/reference/quickhash/quickhashintstringhash/loadfromstring.xml b/reference/quickhash/quickhashintstringhash/loadfromstring.xml index eeb787754..6fe891071 100644 --- a/reference/quickhash/quickhashintstringhash/loadfromstring.xml +++ b/reference/quickhash/quickhashintstringhash/loadfromstring.xml @@ -1,6 +1,6 @@ - + QuickHashIntStringHash::loadFromString This factory method creates a hash from a string diff --git a/reference/quickhash/quickhashintstringhash/savetofile.xml b/reference/quickhash/quickhashintstringhash/savetofile.xml index 7e4a000c8..f34985e3e 100644 --- a/reference/quickhash/quickhashintstringhash/savetofile.xml +++ b/reference/quickhash/quickhashintstringhash/savetofile.xml @@ -1,6 +1,6 @@ - + QuickHashIntStringHash::saveToFile This method stores an in-memory hash to disk diff --git a/reference/quickhash/quickhashintstringhash/savetostring.xml b/reference/quickhash/quickhashintstringhash/savetostring.xml index bdf4eee30..d1cc65128 100644 --- a/reference/quickhash/quickhashintstringhash/savetostring.xml +++ b/reference/quickhash/quickhashintstringhash/savetostring.xml @@ -1,6 +1,6 @@ - + QuickHashIntStringHash::saveToString This method returns a serialized version of the hash diff --git a/reference/quickhash/quickhashintstringhash/set.xml b/reference/quickhash/quickhashintstringhash/set.xml index 7eda7c21b..6e89afe2f 100644 --- a/reference/quickhash/quickhashintstringhash/set.xml +++ b/reference/quickhash/quickhashintstringhash/set.xml @@ -1,6 +1,6 @@ - + QuickHashIntStringHash::set This method updates an entry in the hash with a new value, or diff --git a/reference/quickhash/quickhashintstringhash/update.xml b/reference/quickhash/quickhashintstringhash/update.xml index c049ace25..9f7db04cb 100644 --- a/reference/quickhash/quickhashintstringhash/update.xml +++ b/reference/quickhash/quickhashintstringhash/update.xml @@ -1,6 +1,6 @@ - + QuickHashIntStringHash::update This method updates an entry in the hash with a new value diff --git a/reference/quickhash/quickhashstringinthash.xml b/reference/quickhash/quickhashstringinthash.xml index 0195bace6..bb1b6e4e7 100644 --- a/reference/quickhash/quickhashstringinthash.xml +++ b/reference/quickhash/quickhashstringinthash.xml @@ -1,6 +1,6 @@ - + The QuickHashStringIntHash class QuickHashStringIntHash diff --git a/reference/quickhash/quickhashstringinthash/add.xml b/reference/quickhash/quickhashstringinthash/add.xml index 9a39d5a11..c242a6e42 100644 --- a/reference/quickhash/quickhashstringinthash/add.xml +++ b/reference/quickhash/quickhashstringinthash/add.xml @@ -1,6 +1,6 @@ - + QuickHashStringIntHash::add This method adds a new entry to the hash diff --git a/reference/quickhash/quickhashstringinthash/construct.xml b/reference/quickhash/quickhashstringinthash/construct.xml index c64878013..252e86261 100644 --- a/reference/quickhash/quickhashstringinthash/construct.xml +++ b/reference/quickhash/quickhashstringinthash/construct.xml @@ -1,6 +1,6 @@ - + QuickHashStringIntHash::__construct Creates a new QuickHashStringIntHash object diff --git a/reference/quickhash/quickhashstringinthash/delete.xml b/reference/quickhash/quickhashstringinthash/delete.xml index dc73c7eb4..b3f09e7d0 100644 --- a/reference/quickhash/quickhashstringinthash/delete.xml +++ b/reference/quickhash/quickhashstringinthash/delete.xml @@ -1,6 +1,6 @@ - + QuickHashStringIntHash::delete This method deletes an entry from the hash diff --git a/reference/quickhash/quickhashstringinthash/exists.xml b/reference/quickhash/quickhashstringinthash/exists.xml index 770a6da1d..9a7eabe75 100644 --- a/reference/quickhash/quickhashstringinthash/exists.xml +++ b/reference/quickhash/quickhashstringinthash/exists.xml @@ -1,6 +1,6 @@ - + QuickHashStringIntHash::exists This method checks whether a key is part of the hash diff --git a/reference/quickhash/quickhashstringinthash/get.xml b/reference/quickhash/quickhashstringinthash/get.xml index 92e95eed4..ebf400b2f 100644 --- a/reference/quickhash/quickhashstringinthash/get.xml +++ b/reference/quickhash/quickhashstringinthash/get.xml @@ -1,6 +1,6 @@ - + QuickHashStringIntHash::get This method retrieves a value from the hash by its key diff --git a/reference/quickhash/quickhashstringinthash/getsize.xml b/reference/quickhash/quickhashstringinthash/getsize.xml index 198da274a..577e6377f 100644 --- a/reference/quickhash/quickhashstringinthash/getsize.xml +++ b/reference/quickhash/quickhashstringinthash/getsize.xml @@ -1,6 +1,6 @@ - + QuickHashStringIntHash::getSize Returns the number of elements in the hash diff --git a/reference/quickhash/quickhashstringinthash/loadfromfile.xml b/reference/quickhash/quickhashstringinthash/loadfromfile.xml index a98e30969..c3699d631 100644 --- a/reference/quickhash/quickhashstringinthash/loadfromfile.xml +++ b/reference/quickhash/quickhashstringinthash/loadfromfile.xml @@ -1,6 +1,6 @@ - + QuickHashStringIntHash::loadFromFile This factory method creates a hash from a file diff --git a/reference/quickhash/quickhashstringinthash/loadfromstring.xml b/reference/quickhash/quickhashstringinthash/loadfromstring.xml index b11f61bfb..6abeb6066 100644 --- a/reference/quickhash/quickhashstringinthash/loadfromstring.xml +++ b/reference/quickhash/quickhashstringinthash/loadfromstring.xml @@ -1,6 +1,6 @@ - + QuickHashStringIntHash::loadFromString This factory method creates a hash from a string diff --git a/reference/quickhash/quickhashstringinthash/savetofile.xml b/reference/quickhash/quickhashstringinthash/savetofile.xml index 9a02a7024..7043322a1 100644 --- a/reference/quickhash/quickhashstringinthash/savetofile.xml +++ b/reference/quickhash/quickhashstringinthash/savetofile.xml @@ -1,6 +1,6 @@ - + QuickHashStringIntHash::saveToFile This method stores an in-memory hash to disk diff --git a/reference/quickhash/quickhashstringinthash/savetostring.xml b/reference/quickhash/quickhashstringinthash/savetostring.xml index 9560477ca..34f3778de 100644 --- a/reference/quickhash/quickhashstringinthash/savetostring.xml +++ b/reference/quickhash/quickhashstringinthash/savetostring.xml @@ -1,6 +1,6 @@ - + QuickHashStringIntHash::saveToString This method returns a serialized version of the hash diff --git a/reference/quickhash/quickhashstringinthash/set.xml b/reference/quickhash/quickhashstringinthash/set.xml index 287e5d518..60dd260f7 100644 --- a/reference/quickhash/quickhashstringinthash/set.xml +++ b/reference/quickhash/quickhashstringinthash/set.xml @@ -1,6 +1,6 @@ - + QuickHashStringIntHash::set This method updates an entry in the hash with a new value, or diff --git a/reference/quickhash/quickhashstringinthash/update.xml b/reference/quickhash/quickhashstringinthash/update.xml index e85e604a6..45f8c0521 100644 --- a/reference/quickhash/quickhashstringinthash/update.xml +++ b/reference/quickhash/quickhashstringinthash/update.xml @@ -1,6 +1,6 @@ - + QuickHashStringIntHash::update This method updates an entry in the hash with a new value diff --git a/reference/quickhash/setup.xml b/reference/quickhash/setup.xml index 845652e51..bfc492c6f 100644 --- a/reference/quickhash/setup.xml +++ b/reference/quickhash/setup.xml @@ -1,6 +1,6 @@ - + &reftitle.setup;
    diff --git a/reference/radius/book.xml b/reference/radius/book.xml index 3aa5c354b..4bbf69626 100644 --- a/reference/radius/book.xml +++ b/reference/radius/book.xml @@ -1,6 +1,6 @@ - + Radius diff --git a/reference/radius/configure.xml b/reference/radius/configure.xml index 781f5e4fe..020a147da 100644 --- a/reference/radius/configure.xml +++ b/reference/radius/configure.xml @@ -1,6 +1,6 @@ -
    +
    &reftitle.install; &pecl.moved; diff --git a/reference/radius/constants.xml b/reference/radius/constants.xml index 38a5714f4..3d8a12e82 100644 --- a/reference/radius/constants.xml +++ b/reference/radius/constants.xml @@ -1,6 +1,6 @@ - + &reftitle.constants; &extension.constants; diff --git a/reference/radius/examples.xml b/reference/radius/examples.xml index 545854726..396e4b514 100644 --- a/reference/radius/examples.xml +++ b/reference/radius/examples.xml @@ -1,6 +1,6 @@ - + &reftitle.examples; diff --git a/reference/radius/functions/radius-acct-open.xml b/reference/radius/functions/radius-acct-open.xml index e8e528743..040502025 100644 --- a/reference/radius/functions/radius-acct-open.xml +++ b/reference/radius/functions/radius-acct-open.xml @@ -1,7 +1,7 @@ - + radius_acct_open Creates a Radius handle for accounting diff --git a/reference/radius/functions/radius-add-server.xml b/reference/radius/functions/radius-add-server.xml index df74a4b33..42ab6aef8 100644 --- a/reference/radius/functions/radius-add-server.xml +++ b/reference/radius/functions/radius-add-server.xml @@ -1,7 +1,7 @@ - + radius_add_server Adds a server @@ -50,7 +50,7 @@ port - + The port specifies the UDP port to contact on the server. If port is given as 0, the library looks up the radius/udp or @@ -58,7 +58,7 @@ network services database, and uses the port found there. If no entry is found, the library uses the standard Radius ports, 1812 for authentication and 1813 for accounting. - + diff --git a/reference/radius/functions/radius-auth-open.xml b/reference/radius/functions/radius-auth-open.xml index ff99e4e99..4efb847d4 100644 --- a/reference/radius/functions/radius-auth-open.xml +++ b/reference/radius/functions/radius-auth-open.xml @@ -1,7 +1,7 @@ - + radius_auth_open Creates a Radius handle for authentication diff --git a/reference/radius/functions/radius-close.xml b/reference/radius/functions/radius-close.xml index 9bfd0869f..2b0d720fd 100644 --- a/reference/radius/functions/radius-close.xml +++ b/reference/radius/functions/radius-close.xml @@ -1,7 +1,7 @@ - + radius_close Frees all ressources diff --git a/reference/radius/functions/radius-config.xml b/reference/radius/functions/radius-config.xml index 9913aab34..f2831e993 100644 --- a/reference/radius/functions/radius-config.xml +++ b/reference/radius/functions/radius-config.xml @@ -1,7 +1,7 @@ - + radius_config Causes the library to read the given configuration file diff --git a/reference/radius/functions/radius-create-request.xml b/reference/radius/functions/radius-create-request.xml index 543ac9a62..4e7807c8f 100644 --- a/reference/radius/functions/radius-create-request.xml +++ b/reference/radius/functions/radius-create-request.xml @@ -1,7 +1,7 @@ - + radius_create_request Create accounting or authentication request diff --git a/reference/radius/functions/radius-cvt-addr.xml b/reference/radius/functions/radius-cvt-addr.xml index 3ad439680..51e4ea036 100644 --- a/reference/radius/functions/radius-cvt-addr.xml +++ b/reference/radius/functions/radius-cvt-addr.xml @@ -1,7 +1,7 @@ - + radius_cvt_addr Converts raw data to IP-Address diff --git a/reference/radius/functions/radius-cvt-int.xml b/reference/radius/functions/radius-cvt-int.xml index 83b0ef72e..d706677fa 100644 --- a/reference/radius/functions/radius-cvt-int.xml +++ b/reference/radius/functions/radius-cvt-int.xml @@ -1,7 +1,7 @@ - + radius_cvt_int Converts raw data to integer diff --git a/reference/radius/functions/radius-cvt-string.xml b/reference/radius/functions/radius-cvt-string.xml index 8e84a2e3e..df378cd14 100644 --- a/reference/radius/functions/radius-cvt-string.xml +++ b/reference/radius/functions/radius-cvt-string.xml @@ -1,7 +1,7 @@ - + radius_cvt_string Converts raw data to string diff --git a/reference/radius/functions/radius-demangle-mppe-key.xml b/reference/radius/functions/radius-demangle-mppe-key.xml index 0fbf976de..230f757a6 100644 --- a/reference/radius/functions/radius-demangle-mppe-key.xml +++ b/reference/radius/functions/radius-demangle-mppe-key.xml @@ -1,7 +1,7 @@ - + radius_demangle_mppe_key Derives mppe-keys from mangled data diff --git a/reference/radius/functions/radius-demangle.xml b/reference/radius/functions/radius-demangle.xml index 7040e2ae5..3d72cfebe 100644 --- a/reference/radius/functions/radius-demangle.xml +++ b/reference/radius/functions/radius-demangle.xml @@ -1,7 +1,7 @@ - + radius_demangle Demangles data diff --git a/reference/radius/functions/radius-get-attr.xml b/reference/radius/functions/radius-get-attr.xml index f47d90642..e84778e6d 100644 --- a/reference/radius/functions/radius-get-attr.xml +++ b/reference/radius/functions/radius-get-attr.xml @@ -1,7 +1,7 @@ - + radius_get_attr Extracts an attribute diff --git a/reference/radius/functions/radius-get-tagged-attr-data.xml b/reference/radius/functions/radius-get-tagged-attr-data.xml index 6e6e043da..056e101b0 100644 --- a/reference/radius/functions/radius-get-tagged-attr-data.xml +++ b/reference/radius/functions/radius-get-tagged-attr-data.xml @@ -1,6 +1,6 @@ - + radius_get_tagged_attr_data Extracts the data from a tagged attribute diff --git a/reference/radius/functions/radius-get-tagged-attr-tag.xml b/reference/radius/functions/radius-get-tagged-attr-tag.xml index edd086c15..5978a91c5 100644 --- a/reference/radius/functions/radius-get-tagged-attr-tag.xml +++ b/reference/radius/functions/radius-get-tagged-attr-tag.xml @@ -1,6 +1,6 @@ - + radius_get_tagged_attr_tag Extracts the tag from a tagged attribute diff --git a/reference/radius/functions/radius-put-addr.xml b/reference/radius/functions/radius-put-addr.xml index 721f3873a..5e3c22be0 100644 --- a/reference/radius/functions/radius-put-addr.xml +++ b/reference/radius/functions/radius-put-addr.xml @@ -1,7 +1,7 @@ - + radius_put_addr Attaches an IP address attribute diff --git a/reference/radius/functions/radius-put-attr.xml b/reference/radius/functions/radius-put-attr.xml index b45d50a76..2ee810d4b 100644 --- a/reference/radius/functions/radius-put-attr.xml +++ b/reference/radius/functions/radius-put-attr.xml @@ -1,7 +1,7 @@ - + radius_put_attr Attaches a binary attribute diff --git a/reference/radius/functions/radius-put-int.xml b/reference/radius/functions/radius-put-int.xml index 983fe0441..7de244ad3 100644 --- a/reference/radius/functions/radius-put-int.xml +++ b/reference/radius/functions/radius-put-int.xml @@ -1,7 +1,7 @@ - + radius_put_int Attaches an integer attribute diff --git a/reference/radius/functions/radius-put-string.xml b/reference/radius/functions/radius-put-string.xml index 712498540..b757bc286 100644 --- a/reference/radius/functions/radius-put-string.xml +++ b/reference/radius/functions/radius-put-string.xml @@ -1,7 +1,7 @@ - + radius_put_string Attaches a string attribute diff --git a/reference/radius/functions/radius-put-vendor-addr.xml b/reference/radius/functions/radius-put-vendor-addr.xml index 2c574a186..86cfb8e81 100644 --- a/reference/radius/functions/radius-put-vendor-addr.xml +++ b/reference/radius/functions/radius-put-vendor-addr.xml @@ -1,7 +1,7 @@ - + radius_put_vendor_addr Attaches a vendor specific IP address attribute diff --git a/reference/radius/functions/radius-put-vendor-attr.xml b/reference/radius/functions/radius-put-vendor-attr.xml index f75af26f3..d12e45b9a 100644 --- a/reference/radius/functions/radius-put-vendor-attr.xml +++ b/reference/radius/functions/radius-put-vendor-attr.xml @@ -1,7 +1,7 @@ - + radius_put_vendor_attr Attaches a vendor specific binary attribute diff --git a/reference/radius/functions/radius-put-vendor-int.xml b/reference/radius/functions/radius-put-vendor-int.xml index 16aeae851..66e725744 100644 --- a/reference/radius/functions/radius-put-vendor-int.xml +++ b/reference/radius/functions/radius-put-vendor-int.xml @@ -1,7 +1,7 @@ - + radius_put_vendor_int Attaches a vendor specific integer attribute diff --git a/reference/radius/functions/radius-put-vendor-string.xml b/reference/radius/functions/radius-put-vendor-string.xml index 46eb4cdc9..69d724b8e 100644 --- a/reference/radius/functions/radius-put-vendor-string.xml +++ b/reference/radius/functions/radius-put-vendor-string.xml @@ -1,7 +1,7 @@ - + radius_put_vendor_string Attaches a vendor specific string attribute diff --git a/reference/radius/functions/radius-request-authenticator.xml b/reference/radius/functions/radius-request-authenticator.xml index 796482b10..a64ee8deb 100644 --- a/reference/radius/functions/radius-request-authenticator.xml +++ b/reference/radius/functions/radius-request-authenticator.xml @@ -1,7 +1,7 @@ - + radius_request_authenticator Returns the request authenticator diff --git a/reference/radius/functions/radius-salt-encrypt-attr.xml b/reference/radius/functions/radius-salt-encrypt-attr.xml index ae4f5d558..491cae5b5 100644 --- a/reference/radius/functions/radius-salt-encrypt-attr.xml +++ b/reference/radius/functions/radius-salt-encrypt-attr.xml @@ -1,6 +1,6 @@ - + radius_salt_encrypt_attr Salt-encrypts a value diff --git a/reference/radius/functions/radius-send-request.xml b/reference/radius/functions/radius-send-request.xml index cc30df0d6..b5176e378 100644 --- a/reference/radius/functions/radius-send-request.xml +++ b/reference/radius/functions/radius-send-request.xml @@ -1,7 +1,7 @@ - + radius_send_request Sends the request and waits for a reply diff --git a/reference/radius/functions/radius-server-secret.xml b/reference/radius/functions/radius-server-secret.xml index 79cfd6b30..74fcf8a29 100644 --- a/reference/radius/functions/radius-server-secret.xml +++ b/reference/radius/functions/radius-server-secret.xml @@ -1,7 +1,7 @@ - + radius_server_secret Returns the shared secret diff --git a/reference/radius/functions/radius-strerror.xml b/reference/radius/functions/radius-strerror.xml index 75b441af9..fb93be1b9 100644 --- a/reference/radius/functions/radius-strerror.xml +++ b/reference/radius/functions/radius-strerror.xml @@ -1,7 +1,7 @@ - + radius_strerror Returns an error message diff --git a/reference/radius/reference.xml b/reference/radius/reference.xml index 91feca46d..66775d433 100644 --- a/reference/radius/reference.xml +++ b/reference/radius/reference.xml @@ -5,7 +5,7 @@ Radius &Functions; &reference.radius.entities.functions; - + - + Rar Archiving Rar diff --git a/reference/rar/examples.xml b/reference/rar/examples.xml index f2ebd8699..35234aab7 100644 --- a/reference/rar/examples.xml +++ b/reference/rar/examples.xml @@ -1,6 +1,6 @@ - + &reftitle.examples; diff --git a/reference/rar/functions/rar-wrapper-cache-stats.xml b/reference/rar/functions/rar-wrapper-cache-stats.xml index b8b8c2b41..9e13902ba 100644 --- a/reference/rar/functions/rar-wrapper-cache-stats.xml +++ b/reference/rar/functions/rar-wrapper-cache-stats.xml @@ -1,6 +1,6 @@ - + rar_wrapper_cache_stats Cache hits and misses for the URL wrapper diff --git a/reference/rar/rararchive.xml b/reference/rar/rararchive.xml index a158b5adb..b847072b8 100644 --- a/reference/rar/rararchive.xml +++ b/reference/rar/rararchive.xml @@ -1,6 +1,6 @@ - + The RarArchive class RarArchive diff --git a/reference/rar/rararchive/close.xml b/reference/rar/rararchive/close.xml index bdcbc7f67..52d9bc518 100644 --- a/reference/rar/rararchive/close.xml +++ b/reference/rar/rararchive/close.xml @@ -1,6 +1,6 @@ - + RarArchive::close rar_close diff --git a/reference/rar/rararchive/getcomment.xml b/reference/rar/rararchive/getcomment.xml index 3c197af14..11a1674e0 100644 --- a/reference/rar/rararchive/getcomment.xml +++ b/reference/rar/rararchive/getcomment.xml @@ -1,6 +1,6 @@ - + RarArchive::getComment rar_comment_get diff --git a/reference/rar/rararchive/getentries.xml b/reference/rar/rararchive/getentries.xml index 04b8e0cc0..a79db1081 100644 --- a/reference/rar/rararchive/getentries.xml +++ b/reference/rar/rararchive/getentries.xml @@ -1,6 +1,6 @@ - + RarArchive::getEntries rar_list diff --git a/reference/rar/rararchive/getentry.xml b/reference/rar/rararchive/getentry.xml index 018a70685..d49cf44cc 100644 --- a/reference/rar/rararchive/getentry.xml +++ b/reference/rar/rararchive/getentry.xml @@ -1,6 +1,6 @@ - + RarArchive::getEntry rar_entry_get diff --git a/reference/rar/rararchive/isbroken.xml b/reference/rar/rararchive/isbroken.xml index 1b1a5046f..253f89981 100644 --- a/reference/rar/rararchive/isbroken.xml +++ b/reference/rar/rararchive/isbroken.xml @@ -1,6 +1,6 @@ - + RarArchive::isBroken rar_broken_is diff --git a/reference/rar/rararchive/issolid.xml b/reference/rar/rararchive/issolid.xml index b111a94ed..99877fa3a 100644 --- a/reference/rar/rararchive/issolid.xml +++ b/reference/rar/rararchive/issolid.xml @@ -1,6 +1,6 @@ - + RarArchive::isSolid rar_solid_is diff --git a/reference/rar/rararchive/open.xml b/reference/rar/rararchive/open.xml index eebe5e376..70028e3d9 100644 --- a/reference/rar/rararchive/open.xml +++ b/reference/rar/rararchive/open.xml @@ -1,6 +1,6 @@ - + RarArchive::open rar_open diff --git a/reference/rar/rararchive/setallowbroken.xml b/reference/rar/rararchive/setallowbroken.xml index 9526c0ac4..3ad2b9550 100644 --- a/reference/rar/rararchive/setallowbroken.xml +++ b/reference/rar/rararchive/setallowbroken.xml @@ -1,6 +1,6 @@ - + RarArchive::setAllowBroken Whether opening broken archives is allowed diff --git a/reference/rar/rararchive/tostring.xml b/reference/rar/rararchive/tostring.xml index 1126fb562..9f0f383e3 100644 --- a/reference/rar/rararchive/tostring.xml +++ b/reference/rar/rararchive/tostring.xml @@ -1,6 +1,6 @@ - + RarArchive::__toString Get text representation diff --git a/reference/rar/rarentry.xml b/reference/rar/rarentry.xml index 839b07553..2e92b21af 100644 --- a/reference/rar/rarentry.xml +++ b/reference/rar/rarentry.xml @@ -1,6 +1,6 @@ - + The <classname>RarEntry</classname> class RarEntry diff --git a/reference/rar/rarentry/extract.xml b/reference/rar/rarentry/extract.xml index 1781ef8e5..4fcb5ec3e 100644 --- a/reference/rar/rarentry/extract.xml +++ b/reference/rar/rarentry/extract.xml @@ -1,6 +1,6 @@ - + RarEntry::extract Extract entry from the archive diff --git a/reference/rar/rarentry/getattr.xml b/reference/rar/rarentry/getattr.xml index 0df6a2a67..1b62447ad 100644 --- a/reference/rar/rarentry/getattr.xml +++ b/reference/rar/rarentry/getattr.xml @@ -1,6 +1,6 @@ - + RarEntry::getAttr Get attributes of the entry diff --git a/reference/rar/rarentry/getcrc.xml b/reference/rar/rarentry/getcrc.xml index 93c7eb500..302d9d69f 100644 --- a/reference/rar/rarentry/getcrc.xml +++ b/reference/rar/rarentry/getcrc.xml @@ -1,6 +1,6 @@ - + RarEntry::getCrc Get CRC of the entry diff --git a/reference/rar/rarentry/getfiletime.xml b/reference/rar/rarentry/getfiletime.xml index fd39b3c4d..ba8e5153e 100644 --- a/reference/rar/rarentry/getfiletime.xml +++ b/reference/rar/rarentry/getfiletime.xml @@ -1,6 +1,6 @@ - + RarEntry::getFileTime Get entry last modification time diff --git a/reference/rar/rarentry/gethostos.xml b/reference/rar/rarentry/gethostos.xml index cb41184da..b1e6b9c6e 100644 --- a/reference/rar/rarentry/gethostos.xml +++ b/reference/rar/rarentry/gethostos.xml @@ -1,6 +1,6 @@ - + RarEntry::getHostOs Get entry host OS diff --git a/reference/rar/rarentry/getmethod.xml b/reference/rar/rarentry/getmethod.xml index 0a5fe81cf..92cc5914d 100644 --- a/reference/rar/rarentry/getmethod.xml +++ b/reference/rar/rarentry/getmethod.xml @@ -1,6 +1,6 @@ - + RarEntry::getMethod Get pack method of the entry diff --git a/reference/rar/rarentry/getname.xml b/reference/rar/rarentry/getname.xml index 14ccde1b6..654cdb026 100644 --- a/reference/rar/rarentry/getname.xml +++ b/reference/rar/rarentry/getname.xml @@ -1,6 +1,6 @@ - + RarEntry::getName Get name of the entry diff --git a/reference/rar/rarentry/getpackedsize.xml b/reference/rar/rarentry/getpackedsize.xml index 487a66f03..8f65d1e03 100644 --- a/reference/rar/rarentry/getpackedsize.xml +++ b/reference/rar/rarentry/getpackedsize.xml @@ -1,6 +1,6 @@ - + RarEntry::getPackedSize Get packed size of the entry diff --git a/reference/rar/rarentry/getstream.xml b/reference/rar/rarentry/getstream.xml index c9a38d8c6..3a12b01b6 100644 --- a/reference/rar/rarentry/getstream.xml +++ b/reference/rar/rarentry/getstream.xml @@ -1,6 +1,6 @@ - + RarEntry::getStream Get file handler for entry diff --git a/reference/rar/rarentry/getunpackedsize.xml b/reference/rar/rarentry/getunpackedsize.xml index 15c987a2d..08490b565 100644 --- a/reference/rar/rarentry/getunpackedsize.xml +++ b/reference/rar/rarentry/getunpackedsize.xml @@ -1,6 +1,6 @@ - + RarEntry::getUnpackedSize Get unpacked size of the entry diff --git a/reference/rar/rarentry/getversion.xml b/reference/rar/rarentry/getversion.xml index 2984d76ba..c489c746e 100644 --- a/reference/rar/rarentry/getversion.xml +++ b/reference/rar/rarentry/getversion.xml @@ -1,6 +1,6 @@ - + RarEntry::getVersion Get minimum version of RAR program required to unpack the entry diff --git a/reference/rar/rarentry/isdirectory.xml b/reference/rar/rarentry/isdirectory.xml index d591f319d..ec6011e47 100644 --- a/reference/rar/rarentry/isdirectory.xml +++ b/reference/rar/rarentry/isdirectory.xml @@ -1,6 +1,6 @@ - + RarEntry::isDirectory Test whether an entry represents a directory diff --git a/reference/rar/rarentry/isencrypted.xml b/reference/rar/rarentry/isencrypted.xml index 1e2de6487..5fbeb80a6 100644 --- a/reference/rar/rarentry/isencrypted.xml +++ b/reference/rar/rarentry/isencrypted.xml @@ -1,6 +1,6 @@ - + RarEntry::isEncrypted Test whether an entry is encrypted diff --git a/reference/rar/rarentry/tostring.xml b/reference/rar/rarentry/tostring.xml index 2a0d80cba..2f0b669a8 100644 --- a/reference/rar/rarentry/tostring.xml +++ b/reference/rar/rarentry/tostring.xml @@ -1,6 +1,6 @@ - + RarEntry::__toString Get text representation of entry diff --git a/reference/rar/rarexception.xml b/reference/rar/rarexception.xml index cb5283dc2..665e68641 100644 --- a/reference/rar/rarexception.xml +++ b/reference/rar/rarexception.xml @@ -1,6 +1,6 @@ - + The RarException class RarException diff --git a/reference/rar/rarexception/isusingexceptions.xml b/reference/rar/rarexception/isusingexceptions.xml index 390f10037..426b8475f 100644 --- a/reference/rar/rarexception/isusingexceptions.xml +++ b/reference/rar/rarexception/isusingexceptions.xml @@ -1,6 +1,6 @@ - + RarException::isUsingExceptions Check whether error handling with exceptions is in use diff --git a/reference/rar/rarexception/setusingexceptions.xml b/reference/rar/rarexception/setusingexceptions.xml index 89bd365e5..8d819389d 100644 --- a/reference/rar/rarexception/setusingexceptions.xml +++ b/reference/rar/rarexception/setusingexceptions.xml @@ -1,6 +1,6 @@ - + RarException::setUsingExceptions Activate and deactivate error handling with exceptions diff --git a/reference/rar/setup.xml b/reference/rar/setup.xml index 8f591d122..47f54e4de 100644 --- a/reference/rar/setup.xml +++ b/reference/rar/setup.xml @@ -1,6 +1,6 @@ - + &reftitle.setup; diff --git a/reference/recode/book.xml b/reference/recode/book.xml index 29610c4f6..5c35cd26b 100644 --- a/reference/recode/book.xml +++ b/reference/recode/book.xml @@ -1,7 +1,7 @@ - + GNU Recode Recode diff --git a/reference/recode/configure.xml b/reference/recode/configure.xml index e6a8cefae..4f68a1e38 100644 --- a/reference/recode/configure.xml +++ b/reference/recode/configure.xml @@ -1,6 +1,6 @@ -
    +
    &reftitle.install;
    diff --git a/reference/recode/functions/recode-file.xml b/reference/recode/functions/recode-file.xml index 00db5b578..3661d3693 100644 --- a/reference/recode/functions/recode-file.xml +++ b/reference/recode/functions/recode-file.xml @@ -1,6 +1,6 @@ - + recode_file Recode from file to file according to recode request diff --git a/reference/recode/functions/recode-string.xml b/reference/recode/functions/recode-string.xml index 4cc32aa96..9b18b736b 100644 --- a/reference/recode/functions/recode-string.xml +++ b/reference/recode/functions/recode-string.xml @@ -1,6 +1,6 @@ - + recode_string Recode a string according to a recode request diff --git a/reference/recode/setup.xml b/reference/recode/setup.xml index 2352816c3..ff7f24148 100644 --- a/reference/recode/setup.xml +++ b/reference/recode/setup.xml @@ -1,6 +1,6 @@ - + &reftitle.setup; diff --git a/reference/rnp/book.xml b/reference/rnp/book.xml index 7c283f6d1..47986c80a 100644 --- a/reference/rnp/book.xml +++ b/reference/rnp/book.xml @@ -1,6 +1,6 @@ - + Rnp Rnp diff --git a/reference/rnp/configure.xml b/reference/rnp/configure.xml index 40b85fec3..8106fc7dd 100644 --- a/reference/rnp/configure.xml +++ b/reference/rnp/configure.xml @@ -1,5 +1,5 @@ -
    +
    &reftitle.install; diff --git a/reference/rnp/constants.xml b/reference/rnp/constants.xml index 86d84e17d..88e831ffd 100644 --- a/reference/rnp/constants.xml +++ b/reference/rnp/constants.xml @@ -1,5 +1,5 @@ - + &reftitle.constants; &extension.constants; diff --git a/reference/rnp/examples.xml b/reference/rnp/examples.xml index 6ce2920c4..df6783c1a 100644 --- a/reference/rnp/examples.xml +++ b/reference/rnp/examples.xml @@ -1,6 +1,6 @@ - + &reftitle.examples;
    Clearsign text diff --git a/reference/rnp/functions/rnp-backend-string.xml b/reference/rnp/functions/rnp-backend-string.xml index 3e95ecdfa..e8146d7aa 100644 --- a/reference/rnp/functions/rnp-backend-string.xml +++ b/reference/rnp/functions/rnp-backend-string.xml @@ -1,5 +1,5 @@ - + rnp_backend_string Return cryptographic backend library name diff --git a/reference/rnp/functions/rnp-backend-version.xml b/reference/rnp/functions/rnp-backend-version.xml index ddc1afbd6..e2556d380 100644 --- a/reference/rnp/functions/rnp-backend-version.xml +++ b/reference/rnp/functions/rnp-backend-version.xml @@ -1,5 +1,5 @@ - + rnp_backend_version Return cryptographic backend library version diff --git a/reference/rnp/functions/rnp-decrypt.xml b/reference/rnp/functions/rnp-decrypt.xml index 375eb3afe..ae6dd3b80 100644 --- a/reference/rnp/functions/rnp-decrypt.xml +++ b/reference/rnp/functions/rnp-decrypt.xml @@ -1,5 +1,5 @@ - + rnp_decrypt Decrypt PGP message diff --git a/reference/rnp/functions/rnp-dump-packets-to-json.xml b/reference/rnp/functions/rnp-dump-packets-to-json.xml index 1165c6098..878aed3e9 100644 --- a/reference/rnp/functions/rnp-dump-packets-to-json.xml +++ b/reference/rnp/functions/rnp-dump-packets-to-json.xml @@ -1,5 +1,5 @@ - + rnp_dump_packets_to_json Dump OpenPGP packets stream information to the JSON string diff --git a/reference/rnp/functions/rnp-dump-packets.xml b/reference/rnp/functions/rnp-dump-packets.xml index bb36934cb..cdd8045ec 100644 --- a/reference/rnp/functions/rnp-dump-packets.xml +++ b/reference/rnp/functions/rnp-dump-packets.xml @@ -1,5 +1,5 @@ - + rnp_dump_packets Dump OpenPGP packets stream information in humand-readable format diff --git a/reference/rnp/functions/rnp-ffi-create.xml b/reference/rnp/functions/rnp-ffi-create.xml index 60f5a0a81..45dd9a783 100644 --- a/reference/rnp/functions/rnp-ffi-create.xml +++ b/reference/rnp/functions/rnp-ffi-create.xml @@ -1,5 +1,5 @@ - + rnp_ffi_create Create the top-level object used for interacting with the library diff --git a/reference/rnp/functions/rnp-ffi-destroy.xml b/reference/rnp/functions/rnp-ffi-destroy.xml index 445f4b448..4a7282a7b 100644 --- a/reference/rnp/functions/rnp-ffi-destroy.xml +++ b/reference/rnp/functions/rnp-ffi-destroy.xml @@ -1,5 +1,5 @@ - + rnp_ffi_destroy Destroy the top-level object used for interacting with the library diff --git a/reference/rnp/functions/rnp-ffi-set-pass-provider.xml b/reference/rnp/functions/rnp-ffi-set-pass-provider.xml index 9541be180..f327206ea 100644 --- a/reference/rnp/functions/rnp-ffi-set-pass-provider.xml +++ b/reference/rnp/functions/rnp-ffi-set-pass-provider.xml @@ -1,5 +1,5 @@ - + rnp_ffi_set_pass_provider Set password provider callback function diff --git a/reference/rnp/functions/rnp-import-keys.xml b/reference/rnp/functions/rnp-import-keys.xml index b8a372c0c..fc5cc3ec0 100644 --- a/reference/rnp/functions/rnp-import-keys.xml +++ b/reference/rnp/functions/rnp-import-keys.xml @@ -1,5 +1,5 @@ - + rnp_import_keys Import keys from PHP string to the keyring and receive JSON describing new/updated keys diff --git a/reference/rnp/functions/rnp-import-signatures.xml b/reference/rnp/functions/rnp-import-signatures.xml index 08ef6bb3b..c7387156c 100644 --- a/reference/rnp/functions/rnp-import-signatures.xml +++ b/reference/rnp/functions/rnp-import-signatures.xml @@ -1,5 +1,5 @@ - + rnp_import_signatures Import standalone signatures to the keyring and receive JSON describing updated keys diff --git a/reference/rnp/functions/rnp-key-export-autocrypt.xml b/reference/rnp/functions/rnp-key-export-autocrypt.xml index 2ffd07add..6940674cf 100644 --- a/reference/rnp/functions/rnp-key-export-autocrypt.xml +++ b/reference/rnp/functions/rnp-key-export-autocrypt.xml @@ -1,5 +1,5 @@ - + rnp_key_export_autocrypt diff --git a/reference/rnp/functions/rnp-key-export-revocation.xml b/reference/rnp/functions/rnp-key-export-revocation.xml index f2b726e4c..31a409e93 100644 --- a/reference/rnp/functions/rnp-key-export-revocation.xml +++ b/reference/rnp/functions/rnp-key-export-revocation.xml @@ -1,5 +1,5 @@ - + rnp_key_export_revocation Generate and export primary key revocation signature diff --git a/reference/rnp/functions/rnp-key-export.xml b/reference/rnp/functions/rnp-key-export.xml index 0de544b5f..ab9c3141b 100644 --- a/reference/rnp/functions/rnp-key-export.xml +++ b/reference/rnp/functions/rnp-key-export.xml @@ -1,5 +1,5 @@ - + rnp_key_export Export a key diff --git a/reference/rnp/functions/rnp-key-get-info.xml b/reference/rnp/functions/rnp-key-get-info.xml index d3449edb2..217607fe6 100644 --- a/reference/rnp/functions/rnp-key-get-info.xml +++ b/reference/rnp/functions/rnp-key-get-info.xml @@ -1,5 +1,5 @@ - + rnp_key_get_info Get information about the key diff --git a/reference/rnp/functions/rnp-key-remove.xml b/reference/rnp/functions/rnp-key-remove.xml index 6c811cb4c..8d83ba6ef 100644 --- a/reference/rnp/functions/rnp-key-remove.xml +++ b/reference/rnp/functions/rnp-key-remove.xml @@ -1,5 +1,5 @@ - + rnp_key_remove Remove a key from keyring(s) diff --git a/reference/rnp/functions/rnp-key-revoke.xml b/reference/rnp/functions/rnp-key-revoke.xml index ffc2aedc8..a6bac4574 100644 --- a/reference/rnp/functions/rnp-key-revoke.xml +++ b/reference/rnp/functions/rnp-key-revoke.xml @@ -1,5 +1,5 @@ - + rnp_key_revoke Revoke a key or subkey by generating and adding revocation signature diff --git a/reference/rnp/functions/rnp-list-keys.xml b/reference/rnp/functions/rnp-list-keys.xml index d8700260f..fca28cdcc 100644 --- a/reference/rnp/functions/rnp-list-keys.xml +++ b/reference/rnp/functions/rnp-list-keys.xml @@ -1,5 +1,5 @@ - + rnp_list_keys Enumerate all keys present in a keyring by specified identifer type diff --git a/reference/rnp/functions/rnp-load-keys-from-path.xml b/reference/rnp/functions/rnp-load-keys-from-path.xml index bd720d023..965f6ba87 100644 --- a/reference/rnp/functions/rnp-load-keys-from-path.xml +++ b/reference/rnp/functions/rnp-load-keys-from-path.xml @@ -1,5 +1,5 @@ - + rnp_load_keys_from_path Load keys from specified path diff --git a/reference/rnp/functions/rnp-load-keys.xml b/reference/rnp/functions/rnp-load-keys.xml index 8aad54993..b605f7921 100644 --- a/reference/rnp/functions/rnp-load-keys.xml +++ b/reference/rnp/functions/rnp-load-keys.xml @@ -1,5 +1,5 @@ - + rnp_load_keys Load keys from PHP string diff --git a/reference/rnp/functions/rnp-locate-key.xml b/reference/rnp/functions/rnp-locate-key.xml index 33f5d4ac6..1b84ccf8a 100644 --- a/reference/rnp/functions/rnp-locate-key.xml +++ b/reference/rnp/functions/rnp-locate-key.xml @@ -1,5 +1,5 @@ - + rnp_locate_key Search for the key diff --git a/reference/rnp/functions/rnp-op-encrypt.xml b/reference/rnp/functions/rnp-op-encrypt.xml index 6e950d50c..6a784bd8d 100644 --- a/reference/rnp/functions/rnp-op-encrypt.xml +++ b/reference/rnp/functions/rnp-op-encrypt.xml @@ -1,5 +1,5 @@ - + rnp_op_encrypt Encrypt message @@ -67,9 +67,9 @@ "compression_alg" string Compression algorithm. Both - "compression_alg" and "compression_level" - must be set in order to enable data compression. - + "compression_alg" and "compression_level" + must be set in order to enable data compression. + "compression_level" @@ -112,16 +112,16 @@ string Set symmetric encryption algorithm. Possible values are "IDEA", "TRIPLEDES", - "CAST5", "BLOWFISH", "AES128", "AES192", "AES256", "TWOFISH", "CAMELLIA128", + "CAST5", "BLOWFISH", "AES128", "AES192", "AES256", "TWOFISH", "CAMELLIA128", "CAMELLIA192", "CAMELLIA256", "SM4". - + "aead" string Set AEAD mode algorithm. Possible values are "None" to disable AEAD, "EAX", "OCB". - + "aead_bits" diff --git a/reference/rnp/functions/rnp-op-generate-key.xml b/reference/rnp/functions/rnp-op-generate-key.xml index 180da4271..d37664b8f 100644 --- a/reference/rnp/functions/rnp-op-generate-key.xml +++ b/reference/rnp/functions/rnp-op-generate-key.xml @@ -1,5 +1,5 @@ - + rnp_op_generate_key Generate key @@ -101,7 +101,7 @@ boolean Enable requesting password via password provider. This password will be used for key encryption. Password provider callback function should be set in - advance by calling rnp_ffi_set_pass_provider. + advance by calling rnp_ffi_set_pass_provider. Note: this setting will be ignored if password was set via"password" diff --git a/reference/rnp/functions/rnp-op-sign-cleartext.xml b/reference/rnp/functions/rnp-op-sign-cleartext.xml index 337ccbe4f..20150a8de 100644 --- a/reference/rnp/functions/rnp-op-sign-cleartext.xml +++ b/reference/rnp/functions/rnp-op-sign-cleartext.xml @@ -1,5 +1,5 @@ - + rnp_op_sign_cleartext Perform signing operation on a textual data, return cleartext signed message diff --git a/reference/rnp/functions/rnp-op-sign-detached.xml b/reference/rnp/functions/rnp-op-sign-detached.xml index 3824bab71..16e274730 100644 --- a/reference/rnp/functions/rnp-op-sign-detached.xml +++ b/reference/rnp/functions/rnp-op-sign-detached.xml @@ -1,5 +1,5 @@ - + rnp_op_sign_detached Perform signing operation, return detached signature(s) diff --git a/reference/rnp/functions/rnp-op-sign.xml b/reference/rnp/functions/rnp-op-sign.xml index 8a7125c3a..156279116 100644 --- a/reference/rnp/functions/rnp-op-sign.xml +++ b/reference/rnp/functions/rnp-op-sign.xml @@ -1,5 +1,5 @@ - + rnp_op_sign Perform signing operation on a binary data, return embedded signature(s) @@ -68,9 +68,9 @@ "compression_alg" string Compression algorithm. Both - "compression_alg" and "compression_level" - must be set in order to enable data compression. - + "compression_alg" and "compression_level" + must be set in order to enable data compression. + "compression_level" diff --git a/reference/rnp/functions/rnp-op-verify-detached.xml b/reference/rnp/functions/rnp-op-verify-detached.xml index 6b04837f0..80e2de378 100644 --- a/reference/rnp/functions/rnp-op-verify-detached.xml +++ b/reference/rnp/functions/rnp-op-verify-detached.xml @@ -1,5 +1,5 @@ - + rnp_op_verify_detached Verify detached signatures diff --git a/reference/rnp/functions/rnp-op-verify.xml b/reference/rnp/functions/rnp-op-verify.xml index 087df9957..78a855f79 100644 --- a/reference/rnp/functions/rnp-op-verify.xml +++ b/reference/rnp/functions/rnp-op-verify.xml @@ -1,5 +1,5 @@ - + rnp_op_verify Verify embedded or cleartext signatures diff --git a/reference/rnp/functions/rnp-save-keys-to-path.xml b/reference/rnp/functions/rnp-save-keys-to-path.xml index 0949051b3..4a9710e8e 100644 --- a/reference/rnp/functions/rnp-save-keys-to-path.xml +++ b/reference/rnp/functions/rnp-save-keys-to-path.xml @@ -1,5 +1,5 @@ - + rnp_save_keys_to_path Save keys to specified path diff --git a/reference/rnp/functions/rnp-save-keys.xml b/reference/rnp/functions/rnp-save-keys.xml index d46cc2ddf..16aa25010 100644 --- a/reference/rnp/functions/rnp-save-keys.xml +++ b/reference/rnp/functions/rnp-save-keys.xml @@ -1,5 +1,5 @@ - + rnp_save_keys Save keys to PHP string diff --git a/reference/rnp/functions/rnp-supported-features.xml b/reference/rnp/functions/rnp-supported-features.xml index 0d54f6ed7..669037204 100644 --- a/reference/rnp/functions/rnp-supported-features.xml +++ b/reference/rnp/functions/rnp-supported-features.xml @@ -1,5 +1,5 @@ - + rnp_supported_features Get supported features in JSON format diff --git a/reference/rnp/functions/rnp-version-string-full.xml b/reference/rnp/functions/rnp-version-string-full.xml index 33e10a52f..91a6b354c 100644 --- a/reference/rnp/functions/rnp-version-string-full.xml +++ b/reference/rnp/functions/rnp-version-string-full.xml @@ -1,5 +1,5 @@ - + rnp_version_string_full Full version string of RNP library diff --git a/reference/rnp/functions/rnp-version-string.xml b/reference/rnp/functions/rnp-version-string.xml index e277f615d..d155ed56f 100644 --- a/reference/rnp/functions/rnp-version-string.xml +++ b/reference/rnp/functions/rnp-version-string.xml @@ -1,5 +1,5 @@ - + rnp_version_string RNP library version diff --git a/reference/rnp/rnpffi.xml b/reference/rnp/rnpffi.xml index 6b7490b6e..ec0c0c11b 100644 --- a/reference/rnp/rnpffi.xml +++ b/reference/rnp/rnpffi.xml @@ -1,5 +1,5 @@ - + The RnpFFI class RnpFFI diff --git a/reference/rnp/setup.xml b/reference/rnp/setup.xml index 4ddd8ad60..b4ce021a8 100644 --- a/reference/rnp/setup.xml +++ b/reference/rnp/setup.xml @@ -1,5 +1,5 @@ - + &reftitle.setup;
    diff --git a/reference/rrd/book.xml b/reference/rrd/book.xml index b9c2d8c98..d364e54a2 100644 --- a/reference/rrd/book.xml +++ b/reference/rrd/book.xml @@ -1,6 +1,6 @@ - + RRDtool RRD diff --git a/reference/rrd/configure.xml b/reference/rrd/configure.xml index 0ab2eadb3..57a2bea5d 100644 --- a/reference/rrd/configure.xml +++ b/reference/rrd/configure.xml @@ -1,6 +1,6 @@ -
    +
    &reftitle.install; diff --git a/reference/rrd/examples.xml b/reference/rrd/examples.xml index f69c7dff1..5ca170ffa 100644 --- a/reference/rrd/examples.xml +++ b/reference/rrd/examples.xml @@ -1,6 +1,6 @@ - + &reftitle.examples;
    Procedural PECL/rrd example diff --git a/reference/rrd/functions/rrd-create.xml b/reference/rrd/functions/rrd-create.xml index 5fc90c196..63eee584a 100644 --- a/reference/rrd/functions/rrd-create.xml +++ b/reference/rrd/functions/rrd-create.xml @@ -1,6 +1,6 @@ - + rrd_create Creates rrd database file diff --git a/reference/rrd/functions/rrd-error.xml b/reference/rrd/functions/rrd-error.xml index e17d13558..7e8e0c263 100644 --- a/reference/rrd/functions/rrd-error.xml +++ b/reference/rrd/functions/rrd-error.xml @@ -1,6 +1,6 @@ - + rrd_error Gets latest error message diff --git a/reference/rrd/functions/rrd-fetch.xml b/reference/rrd/functions/rrd-fetch.xml index 0f78a72d2..f41b24eac 100644 --- a/reference/rrd/functions/rrd-fetch.xml +++ b/reference/rrd/functions/rrd-fetch.xml @@ -1,6 +1,6 @@ - + rrd_fetch Fetch the data for graph as array diff --git a/reference/rrd/functions/rrd-first.xml b/reference/rrd/functions/rrd-first.xml index d545e7e1b..87d016a91 100644 --- a/reference/rrd/functions/rrd-first.xml +++ b/reference/rrd/functions/rrd-first.xml @@ -1,6 +1,6 @@ - + rrd_first Gets the timestamp of the first sample from rrd file diff --git a/reference/rrd/functions/rrd-graph.xml b/reference/rrd/functions/rrd-graph.xml index 0fb120af5..d750f798e 100644 --- a/reference/rrd/functions/rrd-graph.xml +++ b/reference/rrd/functions/rrd-graph.xml @@ -1,6 +1,6 @@ - + rrd_graph Creates image from a data diff --git a/reference/rrd/functions/rrd-info.xml b/reference/rrd/functions/rrd-info.xml index 53cfc952e..3596c1a2e 100644 --- a/reference/rrd/functions/rrd-info.xml +++ b/reference/rrd/functions/rrd-info.xml @@ -1,6 +1,6 @@ - + rrd_info Gets information about rrd file diff --git a/reference/rrd/functions/rrd-last.xml b/reference/rrd/functions/rrd-last.xml index 5252bc6e2..5e4e7fd39 100644 --- a/reference/rrd/functions/rrd-last.xml +++ b/reference/rrd/functions/rrd-last.xml @@ -1,6 +1,6 @@ - + rrd_last Gets unix timestamp of the last sample diff --git a/reference/rrd/functions/rrd-lastupdate.xml b/reference/rrd/functions/rrd-lastupdate.xml index 6ef4fd2f5..e6d467e06 100644 --- a/reference/rrd/functions/rrd-lastupdate.xml +++ b/reference/rrd/functions/rrd-lastupdate.xml @@ -1,6 +1,6 @@ - + rrd_lastupdate Gets information about last updated data diff --git a/reference/rrd/functions/rrd-restore.xml b/reference/rrd/functions/rrd-restore.xml index b044e6f94..4c9ac28c5 100644 --- a/reference/rrd/functions/rrd-restore.xml +++ b/reference/rrd/functions/rrd-restore.xml @@ -1,6 +1,6 @@ - + rrd_restore Restores the RRD file from XML dump diff --git a/reference/rrd/functions/rrd-tune.xml b/reference/rrd/functions/rrd-tune.xml index af1663ea0..01869b2c7 100644 --- a/reference/rrd/functions/rrd-tune.xml +++ b/reference/rrd/functions/rrd-tune.xml @@ -1,6 +1,6 @@ - + rrd_tune Tunes some RRD database file header options diff --git a/reference/rrd/functions/rrd-update.xml b/reference/rrd/functions/rrd-update.xml index fec478ef6..421be2f9a 100644 --- a/reference/rrd/functions/rrd-update.xml +++ b/reference/rrd/functions/rrd-update.xml @@ -1,6 +1,6 @@ - + rrd_update Updates the RRD database diff --git a/reference/rrd/functions/rrd-version.xml b/reference/rrd/functions/rrd-version.xml index 505415be3..10573e190 100644 --- a/reference/rrd/functions/rrd-version.xml +++ b/reference/rrd/functions/rrd-version.xml @@ -1,6 +1,6 @@ - + rrd_version Gets information about underlying rrdtool library diff --git a/reference/rrd/functions/rrd-xport.xml b/reference/rrd/functions/rrd-xport.xml index 5ab548a81..23b4601e5 100644 --- a/reference/rrd/functions/rrd-xport.xml +++ b/reference/rrd/functions/rrd-xport.xml @@ -1,6 +1,6 @@ - + rrd_xport Exports the information about RRD database diff --git a/reference/rrd/functions/rrdc-disconnect.xml b/reference/rrd/functions/rrdc-disconnect.xml index 3eb8c804d..1b247e0e7 100644 --- a/reference/rrd/functions/rrdc-disconnect.xml +++ b/reference/rrd/functions/rrdc-disconnect.xml @@ -1,6 +1,6 @@ - + rrdc_disconnect Close any outstanding connection to rrd caching daemon diff --git a/reference/rrd/rrdcreator.xml b/reference/rrd/rrdcreator.xml index f6ff937b8..38b6a683b 100644 --- a/reference/rrd/rrdcreator.xml +++ b/reference/rrd/rrdcreator.xml @@ -1,6 +1,6 @@ - + The RRDCreator class RRDCreator diff --git a/reference/rrd/rrdcreator/addarchive.xml b/reference/rrd/rrdcreator/addarchive.xml index 80d10b28d..04fe774d7 100644 --- a/reference/rrd/rrdcreator/addarchive.xml +++ b/reference/rrd/rrdcreator/addarchive.xml @@ -1,6 +1,6 @@ - + RRDCreator::addArchive Adds RRA - archive of data values for each data source diff --git a/reference/rrd/rrdcreator/adddatasource.xml b/reference/rrd/rrdcreator/adddatasource.xml index 13dfb5146..f3050cda0 100644 --- a/reference/rrd/rrdcreator/adddatasource.xml +++ b/reference/rrd/rrdcreator/adddatasource.xml @@ -1,6 +1,6 @@ - + RRDCreator::addDataSource Adds data source definition for RRD database diff --git a/reference/rrd/rrdcreator/construct.xml b/reference/rrd/rrdcreator/construct.xml index 0750a72ca..3f2580289 100644 --- a/reference/rrd/rrdcreator/construct.xml +++ b/reference/rrd/rrdcreator/construct.xml @@ -1,6 +1,6 @@ - + RRDCreator::__construct Creates new RRDCreator instance diff --git a/reference/rrd/rrdcreator/save.xml b/reference/rrd/rrdcreator/save.xml index 1028ca9ba..fad549b3a 100644 --- a/reference/rrd/rrdcreator/save.xml +++ b/reference/rrd/rrdcreator/save.xml @@ -1,6 +1,6 @@ - + RRDCreator::save Saves the RRD database to a file diff --git a/reference/rrd/rrdgraph.xml b/reference/rrd/rrdgraph.xml index 3c501064d..e601f14ac 100644 --- a/reference/rrd/rrdgraph.xml +++ b/reference/rrd/rrdgraph.xml @@ -1,6 +1,6 @@ - + The RRDGraph class RRDGraph diff --git a/reference/rrd/rrdgraph/construct.xml b/reference/rrd/rrdgraph/construct.xml index 48471e19d..f12ee6a33 100644 --- a/reference/rrd/rrdgraph/construct.xml +++ b/reference/rrd/rrdgraph/construct.xml @@ -1,6 +1,6 @@ - + RRDGraph::__construct Creates new RRDGraph instance diff --git a/reference/rrd/rrdgraph/save.xml b/reference/rrd/rrdgraph/save.xml index 84f7487fe..2ff55f458 100644 --- a/reference/rrd/rrdgraph/save.xml +++ b/reference/rrd/rrdgraph/save.xml @@ -1,6 +1,6 @@ - + RRDGraph::save Saves the result of query into image diff --git a/reference/rrd/rrdgraph/saveverbose.xml b/reference/rrd/rrdgraph/saveverbose.xml index f85f95839..d3c93b68d 100644 --- a/reference/rrd/rrdgraph/saveverbose.xml +++ b/reference/rrd/rrdgraph/saveverbose.xml @@ -1,6 +1,6 @@ - + RRDGraph::saveVerbose Saves the RRD database query into image and returns the verbose diff --git a/reference/rrd/rrdgraph/setoptions.xml b/reference/rrd/rrdgraph/setoptions.xml index 5ac27770a..fc982e1de 100644 --- a/reference/rrd/rrdgraph/setoptions.xml +++ b/reference/rrd/rrdgraph/setoptions.xml @@ -1,6 +1,6 @@ - + RRDGraph::setOptions Sets the options for rrd graph export diff --git a/reference/rrd/rrdupdater.xml b/reference/rrd/rrdupdater.xml index 48ff5926a..ac18e8b7f 100644 --- a/reference/rrd/rrdupdater.xml +++ b/reference/rrd/rrdupdater.xml @@ -1,6 +1,6 @@ - + The RRDUpdater class RRDUpdater diff --git a/reference/rrd/rrdupdater/construct.xml b/reference/rrd/rrdupdater/construct.xml index a10b1cae0..8c3fd106b 100644 --- a/reference/rrd/rrdupdater/construct.xml +++ b/reference/rrd/rrdupdater/construct.xml @@ -1,6 +1,6 @@ - + RRDUpdater::__construct Creates new RRDUpdater instance diff --git a/reference/rrd/rrdupdater/update.xml b/reference/rrd/rrdupdater/update.xml index 78d0b1c21..570f950ae 100644 --- a/reference/rrd/rrdupdater/update.xml +++ b/reference/rrd/rrdupdater/update.xml @@ -1,6 +1,6 @@ - + RRDUpdater::update Update the RRD database file @@ -54,7 +54,7 @@ &reftitle.errors; - Throws a Exception on error. + Throws a Exception on error. diff --git a/reference/rrd/setup.xml b/reference/rrd/setup.xml index 95fea8424..6f27b163c 100644 --- a/reference/rrd/setup.xml +++ b/reference/rrd/setup.xml @@ -1,6 +1,6 @@ - + &reftitle.setup;
    diff --git a/reference/runkit7/constants.xml b/reference/runkit7/constants.xml index 20a74373a..18d9cdb60 100644 --- a/reference/runkit7/constants.xml +++ b/reference/runkit7/constants.xml @@ -1,6 +1,6 @@ - + &reftitle.constants; &extension.constants; diff --git a/reference/runkit7/functions/runkit7-constant-add.xml b/reference/runkit7/functions/runkit7-constant-add.xml index 2e1603614..5de0e30fe 100644 --- a/reference/runkit7/functions/runkit7-constant-add.xml +++ b/reference/runkit7/functions/runkit7-constant-add.xml @@ -1,6 +1,6 @@ - + runkit7_constant_add diff --git a/reference/runkit7/functions/runkit7-constant-redefine.xml b/reference/runkit7/functions/runkit7-constant-redefine.xml index 4a13862b1..6e41b39c0 100644 --- a/reference/runkit7/functions/runkit7-constant-redefine.xml +++ b/reference/runkit7/functions/runkit7-constant-redefine.xml @@ -1,6 +1,6 @@ - + runkit7_constant_redefine Redefine an already defined constant diff --git a/reference/runkit7/functions/runkit7-constant-remove.xml b/reference/runkit7/functions/runkit7-constant-remove.xml index f743ae0b7..225c339c2 100644 --- a/reference/runkit7/functions/runkit7-constant-remove.xml +++ b/reference/runkit7/functions/runkit7-constant-remove.xml @@ -1,6 +1,6 @@ - + runkit7_constant_remove diff --git a/reference/runkit7/functions/runkit7-function-add.xml b/reference/runkit7/functions/runkit7-function-add.xml index e5df6aa94..41ebdd9a0 100644 --- a/reference/runkit7/functions/runkit7-function-add.xml +++ b/reference/runkit7/functions/runkit7-function-add.xml @@ -1,6 +1,6 @@ - + runkit7_function_add diff --git a/reference/runkit7/functions/runkit7-function-copy.xml b/reference/runkit7/functions/runkit7-function-copy.xml index 46b0fd0bb..ed112ee92 100644 --- a/reference/runkit7/functions/runkit7-function-copy.xml +++ b/reference/runkit7/functions/runkit7-function-copy.xml @@ -1,6 +1,6 @@ - + runkit7_function_copy diff --git a/reference/runkit7/functions/runkit7-function-redefine.xml b/reference/runkit7/functions/runkit7-function-redefine.xml index 4969f7577..ab1308cdd 100644 --- a/reference/runkit7/functions/runkit7-function-redefine.xml +++ b/reference/runkit7/functions/runkit7-function-redefine.xml @@ -1,6 +1,6 @@ - + runkit7_function_redefine diff --git a/reference/runkit7/functions/runkit7-function-remove.xml b/reference/runkit7/functions/runkit7-function-remove.xml index dab175505..970200578 100644 --- a/reference/runkit7/functions/runkit7-function-remove.xml +++ b/reference/runkit7/functions/runkit7-function-remove.xml @@ -1,6 +1,6 @@ - + runkit7_function_remove diff --git a/reference/runkit7/functions/runkit7-function-rename.xml b/reference/runkit7/functions/runkit7-function-rename.xml index f25286456..8b04fb259 100644 --- a/reference/runkit7/functions/runkit7-function-rename.xml +++ b/reference/runkit7/functions/runkit7-function-rename.xml @@ -1,6 +1,6 @@ - + runkit7_function_rename diff --git a/reference/runkit7/functions/runkit7-import.xml b/reference/runkit7/functions/runkit7-import.xml index 363423784..a5d01d041 100644 --- a/reference/runkit7/functions/runkit7-import.xml +++ b/reference/runkit7/functions/runkit7-import.xml @@ -1,6 +1,6 @@ - + runkit7_import diff --git a/reference/runkit7/functions/runkit7-method-add.xml b/reference/runkit7/functions/runkit7-method-add.xml index 4dd2bf829..139fe6a13 100644 --- a/reference/runkit7/functions/runkit7-method-add.xml +++ b/reference/runkit7/functions/runkit7-method-add.xml @@ -1,6 +1,6 @@ - + runkit7_method_add Dynamically adds a new method to a given class diff --git a/reference/runkit7/functions/runkit7-method-copy.xml b/reference/runkit7/functions/runkit7-method-copy.xml index 62c4cddac..ec630e88e 100644 --- a/reference/runkit7/functions/runkit7-method-copy.xml +++ b/reference/runkit7/functions/runkit7-method-copy.xml @@ -1,6 +1,6 @@ - + runkit7_method_copy Copies a method from class to another diff --git a/reference/runkit7/functions/runkit7-method-redefine.xml b/reference/runkit7/functions/runkit7-method-redefine.xml index e8bbfce4b..72cf7a39a 100644 --- a/reference/runkit7/functions/runkit7-method-redefine.xml +++ b/reference/runkit7/functions/runkit7-method-redefine.xml @@ -1,6 +1,6 @@ - + runkit7_method_redefine Dynamically changes the code of the given method diff --git a/reference/runkit7/functions/runkit7-method-remove.xml b/reference/runkit7/functions/runkit7-method-remove.xml index 0dfb8b03f..1175b8515 100644 --- a/reference/runkit7/functions/runkit7-method-remove.xml +++ b/reference/runkit7/functions/runkit7-method-remove.xml @@ -1,6 +1,6 @@ - + runkit7_method_remove Dynamically removes the given method diff --git a/reference/runkit7/functions/runkit7-method-rename.xml b/reference/runkit7/functions/runkit7-method-rename.xml index d1cde58ae..68acb049e 100644 --- a/reference/runkit7/functions/runkit7-method-rename.xml +++ b/reference/runkit7/functions/runkit7-method-rename.xml @@ -1,6 +1,6 @@ - + runkit7_method_rename Dynamically changes the name of the given method diff --git a/reference/runkit7/functions/runkit7-object-id.xml b/reference/runkit7/functions/runkit7-object-id.xml index 979ce50dc..f2095d74d 100644 --- a/reference/runkit7/functions/runkit7-object-id.xml +++ b/reference/runkit7/functions/runkit7-object-id.xml @@ -1,6 +1,6 @@ - + runkit7_object_id diff --git a/reference/runkit7/functions/runkit7-superglobals.xml b/reference/runkit7/functions/runkit7-superglobals.xml index fd671dfe4..306d0e50d 100644 --- a/reference/runkit7/functions/runkit7-superglobals.xml +++ b/reference/runkit7/functions/runkit7-superglobals.xml @@ -1,6 +1,6 @@ - + runkit7_superglobals diff --git a/reference/runkit7/functions/runkit7-zval-inspect.xml b/reference/runkit7/functions/runkit7-zval-inspect.xml index f4281bac0..59b65e24e 100644 --- a/reference/runkit7/functions/runkit7-zval-inspect.xml +++ b/reference/runkit7/functions/runkit7-zval-inspect.xml @@ -1,6 +1,6 @@ - + runkit7_zval_inspect Returns information about the passed in value with data types, reference counts, etc diff --git a/reference/runkit7/ini.xml b/reference/runkit7/ini.xml index c22358cb9..b6b273470 100644 --- a/reference/runkit7/ini.xml +++ b/reference/runkit7/ini.xml @@ -1,6 +1,6 @@ -
    +
    &reftitle.runtime; &extension.runtime; diff --git a/reference/runkit7/setup.xml b/reference/runkit7/setup.xml index 3ecef8b9d..1c2dbbaf6 100644 --- a/reference/runkit7/setup.xml +++ b/reference/runkit7/setup.xml @@ -1,6 +1,6 @@ - + &reftitle.setup;
    diff --git a/reference/scoutapm/book.xml b/reference/scoutapm/book.xml index 48914cbad..4dfc9ac3a 100644 --- a/reference/scoutapm/book.xml +++ b/reference/scoutapm/book.xml @@ -1,6 +1,6 @@ - + ScoutAPM ScoutAPM diff --git a/reference/scoutapm/configure.xml b/reference/scoutapm/configure.xml index 117c9d1d8..391eef4ad 100644 --- a/reference/scoutapm/configure.xml +++ b/reference/scoutapm/configure.xml @@ -1,6 +1,6 @@ -
    +
    &reftitle.install; diff --git a/reference/scoutapm/functions/scoutapm-get-calls.xml b/reference/scoutapm/functions/scoutapm-get-calls.xml index c4c5febb3..11626ab06 100644 --- a/reference/scoutapm/functions/scoutapm-get-calls.xml +++ b/reference/scoutapm/functions/scoutapm-get-calls.xml @@ -1,6 +1,6 @@ - + scoutapm_get_calls Returns a list of instrumented calls that have occurred diff --git a/reference/scoutapm/functions/scoutapm-list-instrumented-functions.xml b/reference/scoutapm/functions/scoutapm-list-instrumented-functions.xml index 6d1bfc687..57d36a320 100644 --- a/reference/scoutapm/functions/scoutapm-list-instrumented-functions.xml +++ b/reference/scoutapm/functions/scoutapm-list-instrumented-functions.xml @@ -1,6 +1,6 @@ - + scoutapm_list_instrumented_functions List functions scoutapm will instrument. diff --git a/reference/scoutapm/setup.xml b/reference/scoutapm/setup.xml index b9df23f22..0d42a5844 100644 --- a/reference/scoutapm/setup.xml +++ b/reference/scoutapm/setup.xml @@ -1,6 +1,6 @@ - + &reftitle.setup;
    diff --git a/reference/seaslog/book.xml b/reference/seaslog/book.xml index 66f77d0a7..7ca5f16bf 100644 --- a/reference/seaslog/book.xml +++ b/reference/seaslog/book.xml @@ -1,6 +1,6 @@ - + Seaslog Seaslog diff --git a/reference/seaslog/configure.xml b/reference/seaslog/configure.xml index f7b4ce23c..df3309bc1 100644 --- a/reference/seaslog/configure.xml +++ b/reference/seaslog/configure.xml @@ -1,6 +1,6 @@ -
    +
    &reftitle.install; diff --git a/reference/seaslog/constants.xml b/reference/seaslog/constants.xml index 95d8e78d9..c4f929b75 100644 --- a/reference/seaslog/constants.xml +++ b/reference/seaslog/constants.xml @@ -1,6 +1,6 @@ - + &reftitle.constants; &extension.constants; diff --git a/reference/seaslog/examples.xml b/reference/seaslog/examples.xml index 46907abbd..3a50d14c8 100644 --- a/reference/seaslog/examples.xml +++ b/reference/seaslog/examples.xml @@ -1,6 +1,6 @@ - + &reftitle.examples; diff --git a/reference/seaslog/functions/seaslog-get-author.xml b/reference/seaslog/functions/seaslog-get-author.xml index 0485117cd..26f2f3783 100644 --- a/reference/seaslog/functions/seaslog-get-author.xml +++ b/reference/seaslog/functions/seaslog-get-author.xml @@ -1,6 +1,6 @@ - + seaslog_get_author Get SeasLog author. diff --git a/reference/seaslog/functions/seaslog-get-version.xml b/reference/seaslog/functions/seaslog-get-version.xml index 18e51f3ad..c532a24a8 100644 --- a/reference/seaslog/functions/seaslog-get-version.xml +++ b/reference/seaslog/functions/seaslog-get-version.xml @@ -1,6 +1,6 @@ - + seaslog_get_version Get SeasLog version. diff --git a/reference/seaslog/ini.xml b/reference/seaslog/ini.xml index cb94b2832..6cce0732d 100644 --- a/reference/seaslog/ini.xml +++ b/reference/seaslog/ini.xml @@ -1,6 +1,6 @@ -
    +
    &reftitle.runtime; &extension.runtime; diff --git a/reference/seaslog/seaslog.xml b/reference/seaslog/seaslog.xml index c91a1185a..7655487ea 100644 --- a/reference/seaslog/seaslog.xml +++ b/reference/seaslog/seaslog.xml @@ -1,6 +1,6 @@ - + The SeasLog class SeasLog diff --git a/reference/seaslog/seaslog/alert.xml b/reference/seaslog/seaslog/alert.xml index 7f33abc54..4fc817fb6 100644 --- a/reference/seaslog/seaslog/alert.xml +++ b/reference/seaslog/seaslog/alert.xml @@ -1,6 +1,6 @@ - + SeasLog::alert Record alert log information diff --git a/reference/seaslog/seaslog/analyzercount.xml b/reference/seaslog/seaslog/analyzercount.xml index 8168dbdfc..94dddae2a 100644 --- a/reference/seaslog/seaslog/analyzercount.xml +++ b/reference/seaslog/seaslog/analyzercount.xml @@ -1,6 +1,6 @@ - + SeasLog::analyzerCount Get log count by level, log_path and key_word diff --git a/reference/seaslog/seaslog/analyzerdetail.xml b/reference/seaslog/seaslog/analyzerdetail.xml index b09dd856b..49364063c 100644 --- a/reference/seaslog/seaslog/analyzerdetail.xml +++ b/reference/seaslog/seaslog/analyzerdetail.xml @@ -1,6 +1,6 @@ - + SeasLog::analyzerDetail Get log detail by level, log_path, key_word, start, limit, order diff --git a/reference/seaslog/seaslog/closeloggerstream.xml b/reference/seaslog/seaslog/closeloggerstream.xml index 8adefbbcd..d28731101 100644 --- a/reference/seaslog/seaslog/closeloggerstream.xml +++ b/reference/seaslog/seaslog/closeloggerstream.xml @@ -1,6 +1,6 @@ - + SeasLog::closeLoggerStream Manually release stream flow from logger diff --git a/reference/seaslog/seaslog/construct.xml b/reference/seaslog/seaslog/construct.xml index 09514e369..814f3d09e 100644 --- a/reference/seaslog/seaslog/construct.xml +++ b/reference/seaslog/seaslog/construct.xml @@ -1,6 +1,6 @@ - + SeasLog::__construct Description diff --git a/reference/seaslog/seaslog/critical.xml b/reference/seaslog/seaslog/critical.xml index 329c20010..4591a7d68 100644 --- a/reference/seaslog/seaslog/critical.xml +++ b/reference/seaslog/seaslog/critical.xml @@ -1,6 +1,6 @@ - + SeasLog::critical Record critical log information diff --git a/reference/seaslog/seaslog/debug.xml b/reference/seaslog/seaslog/debug.xml index c532adeec..4bcddcf6f 100644 --- a/reference/seaslog/seaslog/debug.xml +++ b/reference/seaslog/seaslog/debug.xml @@ -1,6 +1,6 @@ - + SeasLog::debug Record debug log information diff --git a/reference/seaslog/seaslog/destruct.xml b/reference/seaslog/seaslog/destruct.xml index 67c5179e9..639143d9e 100644 --- a/reference/seaslog/seaslog/destruct.xml +++ b/reference/seaslog/seaslog/destruct.xml @@ -1,6 +1,6 @@ - + SeasLog::__destruct Description diff --git a/reference/seaslog/seaslog/emergency.xml b/reference/seaslog/seaslog/emergency.xml index 3233cdd4d..83652335e 100644 --- a/reference/seaslog/seaslog/emergency.xml +++ b/reference/seaslog/seaslog/emergency.xml @@ -1,6 +1,6 @@ - + SeasLog::emergency Record emergency log information diff --git a/reference/seaslog/seaslog/error.xml b/reference/seaslog/seaslog/error.xml index 53277504a..1c3c14c77 100644 --- a/reference/seaslog/seaslog/error.xml +++ b/reference/seaslog/seaslog/error.xml @@ -1,6 +1,6 @@ - + SeasLog::error Record error log information diff --git a/reference/seaslog/seaslog/flushbuffer.xml b/reference/seaslog/seaslog/flushbuffer.xml index 6fbd39717..ff7a30822 100644 --- a/reference/seaslog/seaslog/flushbuffer.xml +++ b/reference/seaslog/seaslog/flushbuffer.xml @@ -1,6 +1,6 @@ - + SeasLog::flushBuffer Flush logs buffer, dump to appender file, or send to remote api with tcp/udp diff --git a/reference/seaslog/seaslog/getbasepath.xml b/reference/seaslog/seaslog/getbasepath.xml index 027114ac6..651279ce3 100644 --- a/reference/seaslog/seaslog/getbasepath.xml +++ b/reference/seaslog/seaslog/getbasepath.xml @@ -1,6 +1,6 @@ - + SeasLog::getBasePath Get SeasLog base path. diff --git a/reference/seaslog/seaslog/getbuffer.xml b/reference/seaslog/seaslog/getbuffer.xml index 3b2e50d73..8e54bef2d 100644 --- a/reference/seaslog/seaslog/getbuffer.xml +++ b/reference/seaslog/seaslog/getbuffer.xml @@ -1,6 +1,6 @@ - + SeasLog::getBuffer Get the logs buffer in memory as array diff --git a/reference/seaslog/seaslog/getbufferenabled.xml b/reference/seaslog/seaslog/getbufferenabled.xml index 1da3fcf24..2ff565df2 100644 --- a/reference/seaslog/seaslog/getbufferenabled.xml +++ b/reference/seaslog/seaslog/getbufferenabled.xml @@ -1,6 +1,6 @@ - + SeasLog::getBufferEnabled Determin if buffer enabled diff --git a/reference/seaslog/seaslog/getdatetimeformat.xml b/reference/seaslog/seaslog/getdatetimeformat.xml index 590310883..05445520d 100644 --- a/reference/seaslog/seaslog/getdatetimeformat.xml +++ b/reference/seaslog/seaslog/getdatetimeformat.xml @@ -1,6 +1,6 @@ - + SeasLog::getDatetimeFormat Get SeasLog datetime format style diff --git a/reference/seaslog/seaslog/getlastlogger.xml b/reference/seaslog/seaslog/getlastlogger.xml index 541ed10a4..2144f8920 100644 --- a/reference/seaslog/seaslog/getlastlogger.xml +++ b/reference/seaslog/seaslog/getlastlogger.xml @@ -1,6 +1,6 @@ - + SeasLog::getLastLogger Get SeasLog last logger path diff --git a/reference/seaslog/seaslog/getrequestid.xml b/reference/seaslog/seaslog/getrequestid.xml index d0e2e08a0..89a6196ee 100644 --- a/reference/seaslog/seaslog/getrequestid.xml +++ b/reference/seaslog/seaslog/getrequestid.xml @@ -1,6 +1,6 @@ - + SeasLog::getRequestID Get SeasLog request_id differentiated requests diff --git a/reference/seaslog/seaslog/getrequestvariable.xml b/reference/seaslog/seaslog/getrequestvariable.xml index 4ea982274..27805c01d 100644 --- a/reference/seaslog/seaslog/getrequestvariable.xml +++ b/reference/seaslog/seaslog/getrequestvariable.xml @@ -1,6 +1,6 @@ - + SeasLog::getRequestVariable Get SeasLog request variable diff --git a/reference/seaslog/seaslog/info.xml b/reference/seaslog/seaslog/info.xml index eb70baecc..5f73f4f2e 100644 --- a/reference/seaslog/seaslog/info.xml +++ b/reference/seaslog/seaslog/info.xml @@ -1,6 +1,6 @@ - + SeasLog::info Record info log information diff --git a/reference/seaslog/seaslog/log.xml b/reference/seaslog/seaslog/log.xml index 45ff072eb..b834d325e 100644 --- a/reference/seaslog/seaslog/log.xml +++ b/reference/seaslog/seaslog/log.xml @@ -1,6 +1,6 @@ - + SeasLog::log The Common Record Log Function diff --git a/reference/seaslog/seaslog/notice.xml b/reference/seaslog/seaslog/notice.xml index ea3c20235..8b186342e 100644 --- a/reference/seaslog/seaslog/notice.xml +++ b/reference/seaslog/seaslog/notice.xml @@ -1,6 +1,6 @@ - + SeasLog::notice Record notice log information diff --git a/reference/seaslog/seaslog/setbasepath.xml b/reference/seaslog/seaslog/setbasepath.xml index 8e6781b86..499ebae27 100644 --- a/reference/seaslog/seaslog/setbasepath.xml +++ b/reference/seaslog/seaslog/setbasepath.xml @@ -1,6 +1,6 @@ - + SeasLog::setBasePath Set SeasLog base path diff --git a/reference/seaslog/seaslog/setdatetimeformat.xml b/reference/seaslog/seaslog/setdatetimeformat.xml index a641455a4..5d500d8ee 100644 --- a/reference/seaslog/seaslog/setdatetimeformat.xml +++ b/reference/seaslog/seaslog/setdatetimeformat.xml @@ -1,6 +1,6 @@ - + SeasLog::setDatetimeFormat Set SeasLog datetime format style diff --git a/reference/seaslog/seaslog/setlogger.xml b/reference/seaslog/seaslog/setlogger.xml index d6833c4b5..506d255dd 100644 --- a/reference/seaslog/seaslog/setlogger.xml +++ b/reference/seaslog/seaslog/setlogger.xml @@ -1,6 +1,6 @@ - + SeasLog::setLogger Set SeasLog logger name diff --git a/reference/seaslog/seaslog/setrequestid.xml b/reference/seaslog/seaslog/setrequestid.xml index a44ad97cd..8ac78e43b 100644 --- a/reference/seaslog/seaslog/setrequestid.xml +++ b/reference/seaslog/seaslog/setrequestid.xml @@ -1,6 +1,6 @@ - + SeasLog::setRequestID Set SeasLog request_id differentiated requests diff --git a/reference/seaslog/seaslog/setrequestvariable.xml b/reference/seaslog/seaslog/setrequestvariable.xml index d8821b4a7..9735876e3 100644 --- a/reference/seaslog/seaslog/setrequestvariable.xml +++ b/reference/seaslog/seaslog/setrequestvariable.xml @@ -1,6 +1,6 @@ - + SeasLog::setRequestVariable Manually set SeasLog request variable diff --git a/reference/seaslog/seaslog/warning.xml b/reference/seaslog/seaslog/warning.xml index bbcdf598a..d4cecd767 100644 --- a/reference/seaslog/seaslog/warning.xml +++ b/reference/seaslog/seaslog/warning.xml @@ -1,6 +1,6 @@ - + SeasLog::warning Record warning log information diff --git a/reference/seaslog/setup.xml b/reference/seaslog/setup.xml index 7f7a5cad2..64324a21c 100644 --- a/reference/seaslog/setup.xml +++ b/reference/seaslog/setup.xml @@ -1,6 +1,6 @@ - + &reftitle.setup;
    diff --git a/reference/simdjson/book.xml b/reference/simdjson/book.xml index 2c0025954..c875edd28 100644 --- a/reference/simdjson/book.xml +++ b/reference/simdjson/book.xml @@ -1,5 +1,5 @@ - + Simdjson Simdjson diff --git a/reference/simdjson/constants.xml b/reference/simdjson/constants.xml index 3c85d56de..762aa7af4 100644 --- a/reference/simdjson/constants.xml +++ b/reference/simdjson/constants.xml @@ -1,5 +1,5 @@ - + &reftitle.constants; &extension.constants; diff --git a/reference/simdjson/functions/simdjson-decode.xml b/reference/simdjson/functions/simdjson-decode.xml index 4c232a53a..7241288fc 100644 --- a/reference/simdjson/functions/simdjson-decode.xml +++ b/reference/simdjson/functions/simdjson-decode.xml @@ -1,5 +1,5 @@ - + simdjson_decode Decodes a JSON string @@ -78,12 +78,12 @@ &reftitle.errors; - If json is invalid, a SimdJsonException is thrown as of PECL simdjson 2.1.0, - while previously, a RuntimeException was thrown. + If json is invalid, a SimdJsonException is thrown as of PECL simdjson 2.1.0, + while previously, a RuntimeException was thrown. If depth is outside the allowed range, - a SimdJsonValueError is thrown as of PECL simdjson 3.0.0, + a SimdJsonValueError is thrown as of PECL simdjson 3.0.0, while previously, an error of level E_WARNING was raised. @@ -264,7 +264,7 @@ object(stdClass)#1 (1) { In the event of a failure to decode, - a SimdJsonException is thrown + a SimdJsonException is thrown and SimdJsonException::getCode and SimdJsonException::getMessage can be used to determine the exact nature of the error. diff --git a/reference/simdjson/functions/simdjson-is-valid.xml b/reference/simdjson/functions/simdjson-is-valid.xml index e7eff39b3..91913dc24 100644 --- a/reference/simdjson/functions/simdjson-is-valid.xml +++ b/reference/simdjson/functions/simdjson-is-valid.xml @@ -1,5 +1,5 @@ - + simdjson_is_valid Check if a JSON string is valid @@ -64,12 +64,12 @@ &reftitle.errors; - If json is longer than 4 GiB, a SimdJsonException is thrown as of PECL simdjson 2.1.0, - while previously, a RuntimeException was thrown. + If json is longer than 4 GiB, a SimdJsonException is thrown as of PECL simdjson 2.1.0, + while previously, a RuntimeException was thrown. If depth is outside the allowed range, - a SimdJsonValueError is thrown as of PECL simdjson 3.0.0, + a SimdJsonValueError is thrown as of PECL simdjson 3.0.0, while previously, an error of level E_WARNING was raised. @@ -148,7 +148,7 @@ bool(false) In the event of a failure to decode, - a SimdJsonException is thrown + a SimdJsonException is thrown and SimdJsonException::getCode and SimdJsonException::getMessage can be used to determine the exact nature of the error. diff --git a/reference/simdjson/functions/simdjson-key-count.xml b/reference/simdjson/functions/simdjson-key-count.xml index 997d77030..f582b43b4 100644 --- a/reference/simdjson/functions/simdjson-key-count.xml +++ b/reference/simdjson/functions/simdjson-key-count.xml @@ -1,5 +1,5 @@ - + simdjson_key_count Returns the value at a JSON pointer. @@ -56,7 +56,7 @@ throw_if_uncountable - When true, a SimdJsonException will be thrown + When true, a SimdJsonException will be thrown instead of returning 0 when the value the JSON pointer points to is neither an object nor an array. diff --git a/reference/simdjson/functions/simdjson-key-exists.xml b/reference/simdjson/functions/simdjson-key-exists.xml index e46e1c227..fba9a6339 100644 --- a/reference/simdjson/functions/simdjson-key-exists.xml +++ b/reference/simdjson/functions/simdjson-key-exists.xml @@ -1,5 +1,5 @@ - + simdjson_key_exists Check if the JSON contains the value referred to by a JSON pointer. @@ -55,7 +55,7 @@ throw_if_uncountable - When true, a SimdJsonException will be thrown + When true, a SimdJsonException will be thrown instead of returning 0 when the value the JSON pointer points to is neither an object nor an array. diff --git a/reference/simdjson/functions/simdjson-key-value.xml b/reference/simdjson/functions/simdjson-key-value.xml index 7d736da45..a7dac693b 100644 --- a/reference/simdjson/functions/simdjson-key-value.xml +++ b/reference/simdjson/functions/simdjson-key-value.xml @@ -1,5 +1,5 @@ - + simdjson_key_value Decodes the value of a JSON string located at the requested JSON pointer. @@ -87,12 +87,12 @@ If json or key is invalid, or key could not be found within json, - a SimdJsonException is thrown as of PECL simdjson 2.1.0, - while previously, a RuntimeException was thrown. + a SimdJsonException is thrown as of PECL simdjson 2.1.0, + while previously, a RuntimeException was thrown. If depth is outside the allowed range, - a SimdJsonValueError is thrown as of PECL simdjson 3.0.0, + a SimdJsonValueError is thrown as of PECL simdjson 3.0.0, while previously, an error of level E_WARNING was raised. diff --git a/reference/simdjson/setup.xml b/reference/simdjson/setup.xml index ff85d8adf..833b9fb4b 100644 --- a/reference/simdjson/setup.xml +++ b/reference/simdjson/setup.xml @@ -1,5 +1,5 @@ - + &reftitle.setup;
    diff --git a/reference/simdjson/simdjsonexception.xml b/reference/simdjson/simdjsonexception.xml index f182e85cf..86d713d34 100644 --- a/reference/simdjson/simdjsonexception.xml +++ b/reference/simdjson/simdjsonexception.xml @@ -1,5 +1,5 @@ - + The SimdJsonException class SimdJsonException diff --git a/reference/simdjson/simdjsonvalueerror.xml b/reference/simdjson/simdjsonvalueerror.xml index 757e6696d..6c5ecf234 100644 --- a/reference/simdjson/simdjsonvalueerror.xml +++ b/reference/simdjson/simdjsonvalueerror.xml @@ -1,5 +1,5 @@ - + The SimdJsonValueError class SimdJsonValueError @@ -9,7 +9,7 @@
    &reftitle.intro; - A SimdJsonValueError is thrown when the + A SimdJsonValueError is thrown when the type of an argument to a function from simdjson is correct but the value of it is incorrect. E.g. when the JSON decoding $depth is not positive or the $depth is too large. @@ -61,8 +61,8 @@ PHP 8.0.0 - SimdJsonValueError extends ValueError - now instead of Error. + SimdJsonValueError extends ValueError + now instead of Error. diff --git a/reference/solr/book.xml b/reference/solr/book.xml index 27ff135b1..456444559 100644 --- a/reference/solr/book.xml +++ b/reference/solr/book.xml @@ -8,53 +8,53 @@ &reftitle.intro; - + The Solr extension allows you to communicate effectively with the Apache Solr Server in PHP. - - - The Solr extension is an extremely fast, light-weight, feature-rich library that allows PHP developers to communicate effectively with Solr server instances. - Versions 1.x of The PECL Extension supports Apache Solr Server 1.3-3.x - Versions 2.x of The PECL Extension supports Apache Solr Server 4.0+ - There are built-in tools to add documents and make updates to the solr server. - It also contains tools that allows you to build advanced queries to the server when searching for documents. + + + The Solr extension is an extremely fast, light-weight, feature-rich library that allows PHP developers to communicate effectively with Solr server instances. + Versions 1.x of The PECL Extension supports Apache Solr Server 1.3-3.x + Versions 2.x of The PECL Extension supports Apache Solr Server 4.0+ + There are built-in tools to add documents and make updates to the solr server. + It also contains tools that allows you to build advanced queries to the server when searching for documents. &reference.solr.setup; &reference.solr.constants; &reference.solr.reference; - + &reference.solr.examples; - + &reference.solr.solrutils; - + &reference.solr.solrinputdocument; &reference.solr.solrdocument; &reference.solr.solrdocumentfield; - + &reference.solr.solrobject; - + &reference.solr.solrclient; - + &reference.solr.solrresponse; &reference.solr.solrqueryresponse; &reference.solr.solrupdateresponse; &reference.solr.solrpingresponse; &reference.solr.solrgenericresponse; - + &reference.solr.solrparams; &reference.solr.solrmodifiableparams; &reference.solr.solrquery; &reference.solr.solrdismaxquery; &reference.solr.solrcollapsefunction; - + &reference.solr.solrexception; &reference.solr.solrclientexception; &reference.solr.solrserverexception; &reference.solr.solrillegalargumentexception; &reference.solr.solrillegaloperationexception; &reference.solr.solrmissingmandatoryparameterexception; - - + + - + It returns a string on success and &false; on failure. - + &reftitle.errors; - + This function throws no errors or exceptions. - + diff --git a/reference/solr/setup.xml b/reference/solr/setup.xml index a4fc6854e..b90f2101b 100644 --- a/reference/solr/setup.xml +++ b/reference/solr/setup.xml @@ -7,44 +7,44 @@
    &reftitle.required; - + The libxml and curl extensions must also be enabled for the Apache Solr extension to be available. - - + + libxml2 2.6.31 or later is required. - - + + libcurl 7.18.0 or later is also required. - - + + The above library versions are required and attempting to hack the code to make it compile is strongly discouraged. It will fail, possibly with errors that could be hard to debug. - +
    &reftitle.install; - + &pecl.info; &url.pecl.package;solr. - - + + For help and support, please visit the extension Google group Apache Solr PHP Extension. - - + + &pecl.windows.download.avail; - + - + The solr module can be compiled in debug mode by passing the flag to configure. - - + + When building manually, be sure to include curl and libxml support within the build. - +
    diff --git a/reference/solr/solrclient.xml b/reference/solr/solrclient.xml index 867f26cbc..f9813302f 100644 --- a/reference/solr/solrclient.xml +++ b/reference/solr/solrclient.xml @@ -11,9 +11,9 @@
    &reftitle.intro; - + Used to send requests to a Solr server. Currently, cloning and serialization of SolrClient instances is not supported. - +
    @@ -105,7 +105,7 @@ SolrClient::DEFAULT_SYSTEM_SERVLET admin/system - + &Methods; @@ -123,84 +123,84 @@ SolrClient::SEARCH_SERVLET_TYPE - Used when updating the search servlet. + Used when updating the search servlet. SolrClient::UPDATE_SERVLET_TYPE - Used when updating the update servlet. + Used when updating the update servlet. SolrClient::THREADS_SERVLET_TYPE - Used when updating the threads servlet. + Used when updating the threads servlet. SolrClient::PING_SERVLET_TYPE - Used when updating the ping servlet. + Used when updating the ping servlet. SolrClient::TERMS_SERVLET_TYPE - Used when updating the terms servlet. + Used when updating the terms servlet. - + SolrClient::SYSTEM_SERVLET_TYPE - Used when retrieving system information from the system servlet. + Used when retrieving system information from the system servlet. SolrClient::DEFAULT_SEARCH_SERVLET - This is the initial value for the search servlet. + This is the initial value for the search servlet. SolrClient::DEFAULT_UPDATE_SERVLET - This is the initial value for the update servlet. + This is the initial value for the update servlet. SolrClient::DEFAULT_THREADS_SERVLET - This is the initial value for the threads servlet. + This is the initial value for the threads servlet. SolrClient::DEFAULT_PING_SERVLET - This is the initial value for the ping servlet. + This is the initial value for the ping servlet. SolrClient::DEFAULT_TERMS_SERVLET - This is the initial value for the terms servlet used for the TermsComponent + This is the initial value for the terms servlet used for the TermsComponent - + SolrClient::DEFAULT_SYSTEM_SERVLET - This is the initial value for the system servlet used to obtain Solr Server information + This is the initial value for the system servlet used to obtain Solr Server information diff --git a/reference/solr/solrclient/adddocument.xml b/reference/solr/solrclient/adddocument.xml index fad5cde27..2475bb397 100644 --- a/reference/solr/solrclient/adddocument.xml +++ b/reference/solr/solrclient/adddocument.xml @@ -15,9 +15,9 @@ booloverwrite&true; intcommitWithin0 - + This method adds a document to the index. - +     @@ -28,41 +28,41 @@ doc - + The SolrInputDocument instance. - + overwrite - + Whether to overwrite existing document or not. If &false; there will be duplicates (several documents with the same ID). - - + + - + PECL Solr < 2.0 $allowDups was used instead of $overwrite, which does the same functionality with exact opposite bool flag. - - + + $allowDups = false is the same as $overwrite = true - + commitWithin - + Number of milliseconds within which to auto commit this document. Available since Solr 1.4 . Default (0) means disabled. - - + + When this value specified, it leaves the control of when to do the commit to Solr itself, optimizing number of commits to a minimum while still fulfilling the update latency requirements, and Solr will automatically do a commit when the oldest add in the buffer is due. - + @@ -71,19 +71,19 @@ &reftitle.returnvalues; - + Returns a SolrUpdateResponse object or throws an Exception on failure. - + - + &reftitle.errors; - - Throws SolrClientException if the client had failed, or there was a connection issue. - - - Throws SolrServerException if the Solr Server had failed to process the request. - + + Throws SolrClientException if the client had failed, or there was a connection issue. + + + Throws SolrServerException if the Solr Server had failed to process the request. + @@ -191,7 +191,7 @@ SolrObject Object ]]> - + diff --git a/reference/solr/solrclient/adddocuments.xml b/reference/solr/solrclient/adddocuments.xml index 49ea37a2e..1a22661ba 100644 --- a/reference/solr/solrclient/adddocuments.xml +++ b/reference/solr/solrclient/adddocuments.xml @@ -15,9 +15,9 @@ booloverwrite&true; intcommitWithin0 - + Adds a collection of documents to the index. - + @@ -28,41 +28,41 @@ docs - + An array containing the collection of SolrInputDocument instances. This array must be an actual variable. - + overwrite - + Whether to overwrite existing documents or not. If &false; there will be duplicates (several documents with the same ID). - - + + - + PECL Solr < 2.0 $allowDups was used instead of $overwrite, which does the same functionality with exact opposite bool flag. - - + + $allowDups = false is the same as $overwrite = true - + commitWithin - + Number of milliseconds within which to auto commit this document. Available since Solr 1.4 . Default (0) means disabled. - - + + When this value specified, it leaves the control of when to do the commit to Solr itself, optimizing number of commits to a minimum while still fulfilling the update latency requirements, and Solr will automatically do a commit when the oldest add in the buffer is due. - + @@ -71,19 +71,19 @@ &reftitle.returnvalues; - + Returns a SolrUpdateResponse object or throws an exception on failure. - + - + &reftitle.errors; - - Throws SolrClientException if the client had failed, or there was a connection issue. - - - Throws SolrServerException if the Solr Server had failed to process the request. - + + Throws SolrClientException if the client had failed, or there was a connection issue. + + + Throws SolrServerException if the Solr Server had failed to process the request. + diff --git a/reference/solr/solrclient/commit.xml b/reference/solr/solrclient/commit.xml index b3943bed8..d228efb97 100644 --- a/reference/solr/solrclient/commit.xml +++ b/reference/solr/solrclient/commit.xml @@ -15,9 +15,9 @@ boolwaitSearcher&true; boolexpungeDeletes&false; - + This method finalizes all add/deletes made to the index. - + @@ -28,30 +28,30 @@ softCommit - + This will refresh the 'view' of the index in a more performant manner, but without "on-disk" guarantees. (Solr4.0+) - - - A soft commit is much faster since it only makes index changes visible and does not fsync index files or write a new index descriptor. - If the JVM crashes or there is a loss of power, changes that occurred after the last hard commit will be lost. - Search collections that have near-real-time requirements (that want index changes to be quickly visible to searches) will want to soft commit often but hard commit less frequently. - + + + A soft commit is much faster since it only makes index changes visible and does not fsync index files or write a new index descriptor. + If the JVM crashes or there is a loss of power, changes that occurred after the last hard commit will be lost. + Search collections that have near-real-time requirements (that want index changes to be quickly visible to searches) will want to soft commit often but hard commit less frequently. + waitSearcher - - block until a new searcher is opened and registered as the main query searcher, making the changes visible. - + + block until a new searcher is opened and registered as the main query searcher, making the changes visible. + expungeDeletes - + Merge segments with deletes away. (Solr1.4+) - + @@ -60,21 +60,21 @@ &reftitle.returnvalues; - + Returns a SolrUpdateResponse object on success or throws an exception on failure. - + - + &reftitle.errors; - - Throws SolrClientException if the client had failed, or there was a connection issue. - - - Throws SolrServerException if the Solr Server had failed to process the request. - + + Throws SolrClientException if the client had failed, or there was a connection issue. + + + Throws SolrServerException if the Solr Server had failed to process the request. + - + &reftitle.changelog; @@ -99,11 +99,11 @@ API Changed: SolrClient::commit ([ int $maxSegments = 0 [, bool $softCommit = false [, bool $waitSearcher = true[, bool $expungeDeletes = false ]]] ) - + PECL solr 0.9.2 - Signature: SolrClient::commit ([ int $maxSegments = 1 [, bool $waitFlush = true [, bool $waitSearcher = true ]]] ). + Signature: SolrClient::commit ([ int $maxSegments = 1 [, bool $waitFlush = true [, bool $waitSearcher = true ]]] ). $waitFlush: Block until index changes are flushed to disk. @@ -115,9 +115,9 @@ &reftitle.notes; - - PECL Solr >= 2.0 only supports Solr Server >= 4.0 - + + PECL Solr >= 2.0 only supports Solr Server >= 4.0 + diff --git a/reference/solr/solrclient/construct.xml b/reference/solr/solrclient/construct.xml index 882eb9ab6..11d0ec0fd 100644 --- a/reference/solr/solrclient/construct.xml +++ b/reference/solr/solrclient/construct.xml @@ -13,9 +13,9 @@ public SolrClient::__construct arrayclientOptions - + Constructor for the SolrClient object - + @@ -26,11 +26,11 @@ clientOptions - + This is an array containing one of the following keys : - - - + + + - + - + &reftitle.errors; - - Throws SolrIllegalArgumentException on failure. - + + Throws SolrIllegalArgumentException on failure. + - + &reftitle.examples; diff --git a/reference/solr/solrclient/deletebyid.xml b/reference/solr/solrclient/deletebyid.xml index 7deb676bb..ee9bc5142 100644 --- a/reference/solr/solrclient/deletebyid.xml +++ b/reference/solr/solrclient/deletebyid.xml @@ -13,9 +13,9 @@ public SolrUpdateResponseSolrClient::deleteById stringid - + Deletes the document with the specified ID. Where ID is the value of the uniqueKey field declared in the schema - + @@ -26,9 +26,9 @@ id - + The value of the uniqueKey field declared in the schema - + @@ -37,19 +37,19 @@ &reftitle.returnvalues; - + Returns a SolrUpdateResponse on success and throws an exception on failure. - + - + &reftitle.errors; - - Throws SolrClientException if the client had failed, or there was a connection issue. - - - Throws SolrServerException if the Solr Server had failed to process the request. - + + Throws SolrClientException if the client had failed, or there was a connection issue. + + + Throws SolrServerException if the Solr Server had failed to process the request. + diff --git a/reference/solr/solrclient/deletebyids.xml b/reference/solr/solrclient/deletebyids.xml index 19f2cfc2c..00e9f0d1a 100644 --- a/reference/solr/solrclient/deletebyids.xml +++ b/reference/solr/solrclient/deletebyids.xml @@ -13,9 +13,9 @@ public SolrUpdateResponseSolrClient::deleteByIds arrayids - + Deletes a collection of documents with the specified set of ids. - + @@ -26,9 +26,9 @@ ids - + An array of IDs representing the uniqueKey field declared in the schema for each document to be deleted. This must be an actual php variable. - + @@ -37,19 +37,19 @@ &reftitle.returnvalues; - + Returns a SolrUpdateResponse on success and throws an exception on failure. - + - + &reftitle.errors; - - Throws SolrClientException if the client had failed, or there was a connection issue. - - - Throws SolrServerException if the Solr Server had failed to process the request. - + + Throws SolrClientException if the client had failed, or there was a connection issue. + + + Throws SolrServerException if the Solr Server had failed to process the request. + diff --git a/reference/solr/solrclient/deletebyqueries.xml b/reference/solr/solrclient/deletebyqueries.xml index 92e0e9683..2877cf2e4 100644 --- a/reference/solr/solrclient/deletebyqueries.xml +++ b/reference/solr/solrclient/deletebyqueries.xml @@ -13,9 +13,9 @@ public SolrUpdateResponseSolrClient::deleteByQueries arrayqueries - + Removes all documents matching any of the queries - + @@ -25,9 +25,9 @@ queries - + The array of queries. This must be an actual php variable. - + @@ -36,19 +36,19 @@ &reftitle.returnvalues; - + Returns a SolrUpdateResponse on success and throws a SolrClientException on failure. - + - + &reftitle.errors; - - Throws SolrClientException if the client had failed, or there was a connection issue. - - - Throws SolrServerException if the Solr Server had failed to process the request. - + + Throws SolrClientException if the client had failed, or there was a connection issue. + + + Throws SolrServerException if the Solr Server had failed to process the request. + diff --git a/reference/solr/solrclient/deletebyquery.xml b/reference/solr/solrclient/deletebyquery.xml index 25d763139..c0af9de2c 100644 --- a/reference/solr/solrclient/deletebyquery.xml +++ b/reference/solr/solrclient/deletebyquery.xml @@ -13,9 +13,9 @@ public SolrUpdateResponseSolrClient::deleteByQuery stringquery - + Deletes all documents matching the given query. - + @@ -26,9 +26,9 @@ query - + The query - + @@ -37,21 +37,21 @@ &reftitle.returnvalues; - + Returns a SolrUpdateResponse on success and throws an exception on failure. - + - + &reftitle.errors; - - Throws SolrClientException if the client had failed, or there was a connection issue. - - - Throws SolrServerException if the Solr Server had failed to process the request. - + + Throws SolrClientException if the client had failed, or there was a connection issue. + + + Throws SolrServerException if the Solr Server had failed to process the request. + - + &reftitle.examples; diff --git a/reference/solr/solrclient/destruct.xml b/reference/solr/solrclient/destruct.xml index 977a7d3f2..8504db7d4 100644 --- a/reference/solr/solrclient/destruct.xml +++ b/reference/solr/solrclient/destruct.xml @@ -13,9 +13,9 @@ public SolrClient::__destruct - + Destructor - + @@ -25,9 +25,9 @@ &reftitle.returnvalues; - + Destructor for SolrClient - + diff --git a/reference/solr/solrclient/getbyid.xml b/reference/solr/solrclient/getbyid.xml index 1315538e5..3c5295099 100644 --- a/reference/solr/solrclient/getbyid.xml +++ b/reference/solr/solrclient/getbyid.xml @@ -13,9 +13,9 @@ public SolrQueryResponseSolrClient::getById stringid - + Get Document By Id. Utilizes Solr Realtime Get (RTG). - + @@ -24,9 +24,9 @@ id - + Document ID - + @@ -34,9 +34,9 @@ &reftitle.returnvalues; - + SolrQueryResponse - + diff --git a/reference/solr/solrclient/getbyids.xml b/reference/solr/solrclient/getbyids.xml index ac1aa821d..76718cc88 100644 --- a/reference/solr/solrclient/getbyids.xml +++ b/reference/solr/solrclient/getbyids.xml @@ -13,9 +13,9 @@ public SolrQueryResponseSolrClient::getByIds arrayids - + Get Documents by their Ids. Utilizes Solr Realtime Get (RTG). - + @@ -25,9 +25,9 @@ ids - + Document ids - + @@ -35,9 +35,9 @@ &reftitle.returnvalues; - + SolrQueryResponse - + diff --git a/reference/solr/solrclient/getdebug.xml b/reference/solr/solrclient/getdebug.xml index 14a0ded4d..2a2759205 100644 --- a/reference/solr/solrclient/getdebug.xml +++ b/reference/solr/solrclient/getdebug.xml @@ -13,9 +13,9 @@ public stringSolrClient::getDebug - + Returns the debug data for the last connection attempt - + @@ -26,9 +26,9 @@ &reftitle.returnvalues; - + Returns a string on success and null if there is nothing to return. - + diff --git a/reference/solr/solrclient/getoptions.xml b/reference/solr/solrclient/getoptions.xml index 811728eb9..fa23f7cd8 100644 --- a/reference/solr/solrclient/getoptions.xml +++ b/reference/solr/solrclient/getoptions.xml @@ -13,9 +13,9 @@ public arraySolrClient::getOptions - + Returns the client options set internally. Very useful for debugging. The values returned are readonly and can only be set when the object is instantiated. - + @@ -26,11 +26,11 @@ &reftitle.returnvalues; - + Returns an array containing all the options for the SolrClient object set internally. - + - + &reftitle.seealso; diff --git a/reference/solr/solrclient/optimize.xml b/reference/solr/solrclient/optimize.xml index 1d73667f4..78c562082 100644 --- a/reference/solr/solrclient/optimize.xml +++ b/reference/solr/solrclient/optimize.xml @@ -15,9 +15,9 @@ boolsoftCommit&true; boolwaitSearcher&true; - + Defragments the index for faster search performance. - + @@ -28,25 +28,25 @@ maxSegments - + Optimizes down to at most this number of segments. Since Solr 1.3 - + softCommit - + This will refresh the 'view' of the index in a more performant manner, but without "on-disk" guarantees. (Solr4.0+) - + waitSearcher - - Block until a new searcher is opened and registered as the main query searcher, making the changes visible. - + + Block until a new searcher is opened and registered as the main query searcher, making the changes visible. + @@ -55,33 +55,33 @@ &reftitle.returnvalues; - + Returns a SolrUpdateResponse on success or throws an exception on failure. - + - + &reftitle.errors; - - Throws SolrClientException if the client had failed, or there was a connection issue. - - - Throws SolrServerException if the Solr Server had failed to process the request. - + + Throws SolrClientException if the client had failed, or there was a connection issue. + + + Throws SolrServerException if the Solr Server had failed to process the request. + - + &reftitle.notes; - - PECL Solr >= 2.0 only supports Solr Server >= 4.0 - - + + PECL Solr >= 2.0 only supports Solr Server >= 4.0 + + Prior to PECL Solr 2.0 this method used to accept these arguments "int $maxSegments, bool $waitFlush, bool $waitSearcher". - + - + &reftitle.seealso; diff --git a/reference/solr/solrclient/ping.xml b/reference/solr/solrclient/ping.xml index 9e2c7652a..974224f1c 100644 --- a/reference/solr/solrclient/ping.xml +++ b/reference/solr/solrclient/ping.xml @@ -13,9 +13,9 @@ public SolrPingResponseSolrClient::ping - + Checks if the Solr server is still alive. Sends a HEAD request to the Apache Solr server. - + @@ -26,21 +26,21 @@ &reftitle.returnvalues; - + Returns a SolrPingResponse object on success and throws an exception on failure. - + - + &reftitle.errors; - - Throws SolrClientException if the client had failed, or there was a connection issue. - - - Throws SolrServerException if the Solr Server had failed to satisfy the request. - + + Throws SolrClientException if the client had failed, or there was a connection issue. + + + Throws SolrServerException if the Solr Server had failed to satisfy the request. + - + &reftitle.examples; diff --git a/reference/solr/solrclient/query.xml b/reference/solr/solrclient/query.xml index c37b70e6f..23984725b 100644 --- a/reference/solr/solrclient/query.xml +++ b/reference/solr/solrclient/query.xml @@ -13,9 +13,9 @@ public SolrQueryResponseSolrClient::query SolrParamsquery - + Sends a query to the server. - + @@ -26,9 +26,9 @@ query - + A SolrParams object. It is recommended to use SolrQuery for advanced queries. - + @@ -37,19 +37,19 @@ &reftitle.returnvalues; - + Returns a SolrQueryResponse object on success and throws an exception on failure. - + - + &reftitle.errors; - - Throws SolrClientException if the client had failed, or there was a connection issue. - - - Throws SolrServerException if the Solr Server had failed to satisfy the query. - + + Throws SolrClientException if the client had failed, or there was a connection issue. + + + Throws SolrServerException if the Solr Server had failed to satisfy the query. + diff --git a/reference/solr/solrclient/request.xml b/reference/solr/solrclient/request.xml index 64991cefc..e5c1d6c4c 100644 --- a/reference/solr/solrclient/request.xml +++ b/reference/solr/solrclient/request.xml @@ -13,9 +13,9 @@ public SolrUpdateResponseSolrClient::request stringraw_request - + Sends a raw XML update request to the server - + @@ -26,9 +26,9 @@ raw_request - + An XML string with the raw request to the server. - + @@ -37,24 +37,24 @@ &reftitle.returnvalues; - + Returns a SolrUpdateResponse on success. Throws an exception on failure. - + - + &reftitle.errors; - - Throws SolrIllegalArgumentException if raw_request was an empty string - - - Throws SolrClientException if the client had failed, or there was a connection issue. - - - Throws SolrServerException if the Solr Server had failed to satisfy the query. - + + Throws SolrIllegalArgumentException if raw_request was an empty string + + + Throws SolrClientException if the client had failed, or there was a connection issue. + + + Throws SolrServerException if the Solr Server had failed to satisfy the query. + - + &reftitle.examples; diff --git a/reference/solr/solrclient/rollback.xml b/reference/solr/solrclient/rollback.xml index 465e1e596..24bba73de 100644 --- a/reference/solr/solrclient/rollback.xml +++ b/reference/solr/solrclient/rollback.xml @@ -13,9 +13,9 @@ public SolrUpdateResponseSolrClient::rollback - + Rollbacks all add/deletes made to the index since the last commit. It neither calls any event listeners nor creates a new searcher. - + @@ -26,11 +26,11 @@ &reftitle.returnvalues; - + Returns a SolrUpdateResponse on success or throws a SolrClientException on failure. - + - + &reftitle.seealso; diff --git a/reference/solr/solrclient/setresponsewriter.xml b/reference/solr/solrclient/setresponsewriter.xml index f51e17a76..4cc6d4ad9 100644 --- a/reference/solr/solrclient/setresponsewriter.xml +++ b/reference/solr/solrclient/setresponsewriter.xml @@ -13,9 +13,9 @@ public voidSolrClient::setResponseWriter stringresponseWriter - + Sets the response writer used to prepare the response from Solr - + @@ -26,7 +26,7 @@ responseWriter - One of the following: + One of the following: json phps @@ -40,11 +40,11 @@ &reftitle.returnvalues; - + &return.void; - + - + &reftitle.examples; @@ -61,16 +61,16 @@ class SolrClass public $_properties = array(); public function __get($property_name) { - + if (property_exists($this, $property_name)) { - + return $this->$property_name; - + } else if (isset($_properties[$property_name])) { - + return $_properties[$property_name]; } - + return null; } } diff --git a/reference/solr/solrclient/setservlet.xml b/reference/solr/solrclient/setservlet.xml index 22392cf62..c616c6bff 100644 --- a/reference/solr/solrclient/setservlet.xml +++ b/reference/solr/solrclient/setservlet.xml @@ -14,9 +14,9 @@ inttype stringvalue - + Changes the specified servlet type to a new value - + @@ -27,8 +27,8 @@ type - One of the following : - + One of the following : + - + value - + The new value for the servlet - + @@ -53,9 +53,9 @@ &reftitle.returnvalues; - + &return.success; - + diff --git a/reference/solr/solrclient/system.xml b/reference/solr/solrclient/system.xml index cfb20dc86..19d3952ee 100644 --- a/reference/solr/solrclient/system.xml +++ b/reference/solr/solrclient/system.xml @@ -13,9 +13,9 @@ public voidSolrClient::system - + Retrieve Solr Server information - + @@ -26,19 +26,19 @@ &reftitle.returnvalues; - + Returns a SolrGenericResponse object on success. - + - + &reftitle.errors; - - Emits SolrClientException if the client failed, or there was a connection issue. - - - Emits SolrServerException if the Solr Server failed to satisfy the query. - + + Emits SolrClientException if the client failed, or there was a connection issue. + + + Emits SolrServerException if the Solr Server failed to satisfy the query. + diff --git a/reference/solr/solrclient/threads.xml b/reference/solr/solrclient/threads.xml index e125c7df6..fa9bcf128 100644 --- a/reference/solr/solrclient/threads.xml +++ b/reference/solr/solrclient/threads.xml @@ -13,9 +13,9 @@ public voidSolrClient::threads - + Checks the threads status - + @@ -26,21 +26,21 @@ &reftitle.returnvalues; - + Returns a SolrGenericResponse object. - + - + &reftitle.errors; - - Throws SolrClientException if the client failed, or there was a connection issue. - - - throws SolrServerException if the Solr Server failed to process the request. - + + Throws SolrClientException if the client failed, or there was a connection issue. + + + throws SolrServerException if the Solr Server failed to process the request. + - +
    &reftitle.intro; - + An exception thrown when there is an error while making a request to the server from the client. - +
    @@ -29,21 +29,21 @@ SolrClientException - + extends SolrException - + &InheritedProperties; &Methods; - + &InheritedMethods; @@ -53,7 +53,7 @@
    - + &reference.solr.entities.solrclientexception; diff --git a/reference/solr/solrclientexception/getinternalinfo.xml b/reference/solr/solrclientexception/getinternalinfo.xml index c18f2f4dc..419e7df3c 100644 --- a/reference/solr/solrclientexception/getinternalinfo.xml +++ b/reference/solr/solrclientexception/getinternalinfo.xml @@ -13,9 +13,9 @@ public arraySolrClientException::getInternalInfo - + Returns internal information where the Exception was thrown. - + @@ -26,9 +26,9 @@ &reftitle.returnvalues; - + Returns an array containing internal information where the error was thrown. Used only for debugging by extension developers. - + diff --git a/reference/solr/solrcollapsefunction.xml b/reference/solr/solrcollapsefunction.xml index 17bd79f58..8c80a817c 100644 --- a/reference/solr/solrcollapsefunction.xml +++ b/reference/solr/solrcollapsefunction.xml @@ -11,9 +11,9 @@
    &reftitle.intro; - + - +
    @@ -67,21 +67,21 @@ SolrCollapseFunction::NULLPOLICY_IGNORE - + SolrCollapseFunction::NULLPOLICY_EXPAND - + SolrCollapseFunction::NULLPOLICY_COLLAPSE - + diff --git a/reference/solr/solrcollapsefunction/construct.xml b/reference/solr/solrcollapsefunction/construct.xml index 70f4d97f5..17ece190c 100644 --- a/reference/solr/solrcollapsefunction/construct.xml +++ b/reference/solr/solrcollapsefunction/construct.xml @@ -13,9 +13,9 @@ public SolrCollapseFunction::__construct stringfield - + Collapse Function constructor - + @@ -25,12 +25,12 @@ field - + The field name to collapse on. - - + + In order to collapse a result. The field type must be a single valued String, Int or Float. - + diff --git a/reference/solr/solrcollapsefunction/getfield.xml b/reference/solr/solrcollapsefunction/getfield.xml index 864a8077b..9766f8060 100644 --- a/reference/solr/solrcollapsefunction/getfield.xml +++ b/reference/solr/solrcollapsefunction/getfield.xml @@ -13,9 +13,9 @@ public stringSolrCollapseFunction::getField - + Returns the field that is being collapsed on. - + @@ -26,9 +26,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/solr/solrcollapsefunction/gethint.xml b/reference/solr/solrcollapsefunction/gethint.xml index bbbb2f952..f0d6e2ea9 100644 --- a/reference/solr/solrcollapsefunction/gethint.xml +++ b/reference/solr/solrcollapsefunction/gethint.xml @@ -13,9 +13,9 @@ public stringSolrCollapseFunction::getHint - + Returns collapse hint - + @@ -26,9 +26,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/solr/solrcollapsefunction/getmax.xml b/reference/solr/solrcollapsefunction/getmax.xml index f4c40fe25..7ba829339 100644 --- a/reference/solr/solrcollapsefunction/getmax.xml +++ b/reference/solr/solrcollapsefunction/getmax.xml @@ -13,9 +13,9 @@ public stringSolrCollapseFunction::getMax - + Returns max parameter - + @@ -25,9 +25,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/solr/solrcollapsefunction/getmin.xml b/reference/solr/solrcollapsefunction/getmin.xml index 7e66925b5..ca4813418 100644 --- a/reference/solr/solrcollapsefunction/getmin.xml +++ b/reference/solr/solrcollapsefunction/getmin.xml @@ -13,9 +13,9 @@ public stringSolrCollapseFunction::getMin - + Returns min parameter - + @@ -26,9 +26,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/solr/solrcollapsefunction/getnullpolicy.xml b/reference/solr/solrcollapsefunction/getnullpolicy.xml index a22b7d65d..ae16aa5d4 100644 --- a/reference/solr/solrcollapsefunction/getnullpolicy.xml +++ b/reference/solr/solrcollapsefunction/getnullpolicy.xml @@ -13,9 +13,9 @@ public stringSolrCollapseFunction::getNullPolicy - + Returns null policy used or null - + @@ -26,9 +26,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/solr/solrcollapsefunction/getsize.xml b/reference/solr/solrcollapsefunction/getsize.xml index ae8a58d24..9ecbf1854 100644 --- a/reference/solr/solrcollapsefunction/getsize.xml +++ b/reference/solr/solrcollapsefunction/getsize.xml @@ -13,9 +13,9 @@ public intSolrCollapseFunction::getSize - + Gets the initial size of the collapse data structures when collapsing on a numeric field only - + @@ -25,11 +25,11 @@ &reftitle.returnvalues; - - - + + + - + &reftitle.seealso; diff --git a/reference/solr/solrcollapsefunction/setfield.xml b/reference/solr/solrcollapsefunction/setfield.xml index 80baf7418..08b1dbcff 100644 --- a/reference/solr/solrcollapsefunction/setfield.xml +++ b/reference/solr/solrcollapsefunction/setfield.xml @@ -13,11 +13,11 @@ public SolrCollapseFunctionSolrCollapseFunction::setField stringfieldName - + The field name to collapse on. - + In order to collapse a result. The field type must be a single valued String, Int or Float. - + @@ -27,9 +27,9 @@ fieldName - - - + + + @@ -37,9 +37,9 @@ &reftitle.returnvalues; - + SolrCollapseFunction - + diff --git a/reference/solr/solrcollapsefunction/sethint.xml b/reference/solr/solrcollapsefunction/sethint.xml index 8fd999db3..efaa2f3f5 100644 --- a/reference/solr/solrcollapsefunction/sethint.xml +++ b/reference/solr/solrcollapsefunction/sethint.xml @@ -13,9 +13,9 @@ public SolrCollapseFunctionSolrCollapseFunction::setHint stringhint - + Sets collapse hint - + @@ -25,9 +25,9 @@ hint - + Currently there is only one hint available "top_fc", which stands for top level FieldCache - + @@ -35,9 +35,9 @@ &reftitle.returnvalues; - + SolrCollapseFunction - + @@ -61,7 +61,7 @@ - +
    &reftitle.intro; - + - +
    @@ -29,12 +29,12 @@ SolrDisMaxQuery - + extends SolrQuery - + Serializable @@ -44,11 +44,11 @@ &InheritedProperties; - + &Methods; - + &InheritedMethods; @@ -56,7 +56,7 @@
    - +
    &reftitle.constants; @@ -65,42 +65,42 @@ SolrDisMaxQuery::ORDER_ASC - Used to specify that the sorting should be in acending order (Duplicated for easier migration) + Used to specify that the sorting should be in acending order (Duplicated for easier migration) SolrDisMaxQuery::ORDER_DESC - Used to specify that the sorting should be in descending order (Duplicated for easier migration) + Used to specify that the sorting should be in descending order (Duplicated for easier migration) SolrDisMaxQuery::FACET_SORT_INDEX - Used to specify that the facet should sort by index (Duplicated for easier migration) + Used to specify that the facet should sort by index (Duplicated for easier migration) SolrDisMaxQuery::FACET_SORT_COUNT - Used to specify that the facet should sort by count (Duplicated for easier migration) + Used to specify that the facet should sort by count (Duplicated for easier migration) SolrDisMaxQuery::TERMS_SORT_INDEX - Used in the TermsComponent (Duplicated for easier migration) + Used in the TermsComponent (Duplicated for easier migration) SolrDisMaxQuery::TERMS_SORT_COUNT - Used in the TermsComponent (Duplicated for easier migration) + Used in the TermsComponent (Duplicated for easier migration) diff --git a/reference/solr/solrdismaxquery/addbigramphrasefield.xml b/reference/solr/solrdismaxquery/addbigramphrasefield.xml index 08c80ca0f..7de4be3ae 100644 --- a/reference/solr/solrdismaxquery/addbigramphrasefield.xml +++ b/reference/solr/solrdismaxquery/addbigramphrasefield.xml @@ -1,5 +1,5 @@ - + @@ -15,11 +15,11 @@ stringboost stringslop - + Adds a Phrase Bigram Field (pf2 parameter) output format: field~slop^boost OR field^boost Slop is optional - + @@ -29,25 +29,25 @@ field - - - + + + boost - - - + + + slop - - - + + + @@ -55,9 +55,9 @@ &reftitle.returnvalues; - + SolrDisMaxQuery - + diff --git a/reference/solr/solrdismaxquery/addboostquery.xml b/reference/solr/solrdismaxquery/addboostquery.xml index 865d14cc8..271530a5b 100644 --- a/reference/solr/solrdismaxquery/addboostquery.xml +++ b/reference/solr/solrdismaxquery/addboostquery.xml @@ -1,5 +1,5 @@ - + @@ -15,9 +15,9 @@ stringvalue stringboost - - Adds a Boost Query field with value [and boost] (bq parameter) - + + Adds a Boost Query field with value [and boost] (bq parameter) + @@ -27,25 +27,25 @@ field - - - + + + value - - - + + + boost - - - + + + @@ -53,9 +53,9 @@ &reftitle.returnvalues; - + SolrDisMaxQuery - + diff --git a/reference/solr/solrdismaxquery/addphrasefield.xml b/reference/solr/solrdismaxquery/addphrasefield.xml index be7ba0325..5b584346b 100644 --- a/reference/solr/solrdismaxquery/addphrasefield.xml +++ b/reference/solr/solrdismaxquery/addphrasefield.xml @@ -1,5 +1,5 @@ - + @@ -15,9 +15,9 @@ stringboost stringslop - + Adds a Phrase Field (pf parameter) - + @@ -27,25 +27,25 @@ field - + field name - + boost - - - + + + slop - - - + + + @@ -53,9 +53,9 @@ &reftitle.returnvalues; - + SolrDisMaxQuery - + diff --git a/reference/solr/solrdismaxquery/addqueryfield.xml b/reference/solr/solrdismaxquery/addqueryfield.xml index a8bba9b2a..702c6382b 100644 --- a/reference/solr/solrdismaxquery/addqueryfield.xml +++ b/reference/solr/solrdismaxquery/addqueryfield.xml @@ -1,5 +1,5 @@ - + @@ -14,9 +14,9 @@ stringfield stringboost - + Add a query field with optional boost (qf parameter) - + @@ -26,17 +26,17 @@ field - + field name - + boost - + Boost value. Boosts documents with matching terms. - + @@ -44,9 +44,9 @@ &reftitle.returnvalues; - + SolrDisMaxQuery - + diff --git a/reference/solr/solrdismaxquery/addtrigramphrasefield.xml b/reference/solr/solrdismaxquery/addtrigramphrasefield.xml index 9631a24df..23340ebd1 100644 --- a/reference/solr/solrdismaxquery/addtrigramphrasefield.xml +++ b/reference/solr/solrdismaxquery/addtrigramphrasefield.xml @@ -1,5 +1,5 @@ - + @@ -15,9 +15,9 @@ stringboost stringslop - + Adds a Trigram Phrase Field (pf3 parameter) - + @@ -27,25 +27,25 @@ field - + Field Name - + boost - + Field Boost - + slop - + Field Slop - + @@ -53,9 +53,9 @@ &reftitle.returnvalues; - + SolrDisMaxQuery - + diff --git a/reference/solr/solrdismaxquery/adduserfield.xml b/reference/solr/solrdismaxquery/adduserfield.xml index 5c70f6163..35eb4153f 100644 --- a/reference/solr/solrdismaxquery/adduserfield.xml +++ b/reference/solr/solrdismaxquery/adduserfield.xml @@ -1,5 +1,5 @@ - + @@ -13,9 +13,9 @@ public SolrDisMaxQuerySolrDisMaxQuery::addUserField stringfield - + Adds a field to The User Fields Parameter (uf) - + @@ -26,9 +26,9 @@ field - + Field Name - + @@ -36,9 +36,9 @@ &reftitle.returnvalues; - + SolrDisMaxQuery - + diff --git a/reference/solr/solrdismaxquery/construct.xml b/reference/solr/solrdismaxquery/construct.xml index b1fc1cc44..d685162f4 100644 --- a/reference/solr/solrdismaxquery/construct.xml +++ b/reference/solr/solrdismaxquery/construct.xml @@ -1,5 +1,5 @@ - + @@ -13,9 +13,9 @@ public SolrDisMaxQuery::__construct stringq - + Class constructor initializes the object and sets the q parameter if passed - + @@ -24,9 +24,9 @@ q - + Search Query (q parameter) - + @@ -34,16 +34,16 @@ &reftitle.returnvalues; - - - + + + - + &reftitle.errors; - - Emits SolrIllegalArgumentException in case of an invalid parameter was passed. - + + Emits SolrIllegalArgumentException in case of an invalid parameter was passed. + diff --git a/reference/solr/solrdismaxquery/removebigramphrasefield.xml b/reference/solr/solrdismaxquery/removebigramphrasefield.xml index 431b60c71..4e60eafe8 100644 --- a/reference/solr/solrdismaxquery/removebigramphrasefield.xml +++ b/reference/solr/solrdismaxquery/removebigramphrasefield.xml @@ -1,5 +1,5 @@ - + @@ -13,9 +13,9 @@ public SolrDisMaxQuerySolrDisMaxQuery::removeBigramPhraseField stringfield - + Removes a Bigram Phrase Field (pf2 parameter) that was previously added using SolrDisMaxQuery::addBigramPhraseField - + @@ -25,9 +25,9 @@ field - + The Field Name - + @@ -35,9 +35,9 @@ &reftitle.returnvalues; - + SolrDisMaxQuery - + diff --git a/reference/solr/solrdismaxquery/removeboostquery.xml b/reference/solr/solrdismaxquery/removeboostquery.xml index 546acf772..530d4a211 100644 --- a/reference/solr/solrdismaxquery/removeboostquery.xml +++ b/reference/solr/solrdismaxquery/removeboostquery.xml @@ -1,5 +1,5 @@ - + @@ -13,9 +13,9 @@ public SolrDisMaxQuerySolrDisMaxQuery::removeBoostQuery stringfield - + Removes a boost query partial from the existing query, only if SolrDisMaxQuery::addBoostQuery was used. - + &reftitle.parameters; @@ -23,9 +23,9 @@ field - + Field Name - + @@ -33,9 +33,9 @@ &reftitle.returnvalues; - + SolrDisMaxQuery - + diff --git a/reference/solr/solrdismaxquery/removephrasefield.xml b/reference/solr/solrdismaxquery/removephrasefield.xml index a81aff261..477a40f5f 100644 --- a/reference/solr/solrdismaxquery/removephrasefield.xml +++ b/reference/solr/solrdismaxquery/removephrasefield.xml @@ -13,9 +13,9 @@ public SolrDisMaxQuerySolrDisMaxQuery::removePhraseField stringfield - + Removes a Phrase Field (pf parameter) that was previously added using SolrDisMaxQuery::addPhraseField - + @@ -25,9 +25,9 @@ field - + Field Name - + @@ -35,9 +35,9 @@ &reftitle.returnvalues; - + SolrDisMaxQuery - + diff --git a/reference/solr/solrdismaxquery/removequeryfield.xml b/reference/solr/solrdismaxquery/removequeryfield.xml index 860735486..9b6e0a2ac 100644 --- a/reference/solr/solrdismaxquery/removequeryfield.xml +++ b/reference/solr/solrdismaxquery/removequeryfield.xml @@ -13,12 +13,12 @@ public SolrDisMaxQuerySolrDisMaxQuery::removeQueryField stringfield - + Removes a Query Field (qf parameter) from the field list added by SolrDisMaxQuery::addQueryField - - + + qf: When building DisjunctionMaxQueries from the user's query it specifies the fields to search in, and boosts for those fields. - + @@ -28,9 +28,9 @@ field - + Field Name - + @@ -38,9 +38,9 @@ &reftitle.returnvalues; - + SolrDisMaxQuery - + diff --git a/reference/solr/solrdismaxquery/removetrigramphrasefield.xml b/reference/solr/solrdismaxquery/removetrigramphrasefield.xml index 1885bc72e..e7488c6cd 100644 --- a/reference/solr/solrdismaxquery/removetrigramphrasefield.xml +++ b/reference/solr/solrdismaxquery/removetrigramphrasefield.xml @@ -1,5 +1,5 @@ - + @@ -13,9 +13,9 @@ public SolrDisMaxQuerySolrDisMaxQuery::removeTrigramPhraseField stringfield - + Removes a Trigram Phrase Field (pf3 parameter) - + @@ -25,9 +25,9 @@ field - + Field Name - + @@ -35,9 +35,9 @@ &reftitle.returnvalues; - + SolrDisMaxQuery - + diff --git a/reference/solr/solrdismaxquery/removeuserfield.xml b/reference/solr/solrdismaxquery/removeuserfield.xml index 5a1005943..de2f76c2e 100644 --- a/reference/solr/solrdismaxquery/removeuserfield.xml +++ b/reference/solr/solrdismaxquery/removeuserfield.xml @@ -13,9 +13,9 @@ public SolrDisMaxQuerySolrDisMaxQuery::removeUserField stringfield - + Removes a field from The User Fields Parameter (uf) - + &warn.undocumented.func; @@ -27,9 +27,9 @@ field - + Field Name - + @@ -37,9 +37,9 @@ &reftitle.returnvalues; - + SolrDisMaxQuery - + diff --git a/reference/solr/solrdismaxquery/setbigramphrasefields.xml b/reference/solr/solrdismaxquery/setbigramphrasefields.xml index b506674f2..b714078cd 100644 --- a/reference/solr/solrdismaxquery/setbigramphrasefields.xml +++ b/reference/solr/solrdismaxquery/setbigramphrasefields.xml @@ -1,5 +1,5 @@ - + @@ -13,9 +13,9 @@ public SolrDisMaxQuerySolrDisMaxQuery::setBigramPhraseFields stringfields - + Sets Bigram Phrase Fields (pf2) and their boosts (and slops) - + @@ -24,9 +24,9 @@ fields - + Fields boosts (slops) - + @@ -34,9 +34,9 @@ &reftitle.returnvalues; - + SolrDisMaxQuery - + diff --git a/reference/solr/solrdismaxquery/setbigramphraseslop.xml b/reference/solr/solrdismaxquery/setbigramphraseslop.xml index 41e489a23..12a26eb7c 100644 --- a/reference/solr/solrdismaxquery/setbigramphraseslop.xml +++ b/reference/solr/solrdismaxquery/setbigramphraseslop.xml @@ -1,5 +1,5 @@ - + @@ -13,9 +13,9 @@ public SolrDisMaxQuerySolrDisMaxQuery::setBigramPhraseSlop stringslop - + Sets Bigram Phrase Slop (ps2 parameter). A default slop for Bigram phrase fields. - + @@ -25,9 +25,9 @@ slop - - - + + + @@ -35,9 +35,9 @@ &reftitle.returnvalues; - + SolrDisMaxQuery - + diff --git a/reference/solr/solrdismaxquery/setboostfunction.xml b/reference/solr/solrdismaxquery/setboostfunction.xml index b5f9c9700..fd2119557 100644 --- a/reference/solr/solrdismaxquery/setboostfunction.xml +++ b/reference/solr/solrdismaxquery/setboostfunction.xml @@ -1,5 +1,5 @@ - + @@ -13,17 +13,17 @@ public SolrDisMaxQuerySolrDisMaxQuery::setBoostFunction stringfunction - + Sets Boost Function (bf parameter). - - + + Functions (with optional boosts) that will be included in the user's query to influence the score. Any function supported natively by Solr can be used, along with a boost value. e.g.: - - + + recip(rord(myfield),1,2,3)^1.5 - + @@ -32,9 +32,9 @@ function - - - + + + @@ -42,9 +42,9 @@ &reftitle.returnvalues; - + SolrDisMaxQuery - + diff --git a/reference/solr/solrdismaxquery/setboostquery.xml b/reference/solr/solrdismaxquery/setboostquery.xml index df122f4c4..a79ba8e7f 100644 --- a/reference/solr/solrdismaxquery/setboostquery.xml +++ b/reference/solr/solrdismaxquery/setboostquery.xml @@ -1,5 +1,5 @@ - + @@ -13,9 +13,9 @@ public SolrDisMaxQuerySolrDisMaxQuery::setBoostQuery stringq - + Sets Boost Query Parameter (bq) - + @@ -25,9 +25,9 @@ q - + query - + @@ -35,9 +35,9 @@ &reftitle.returnvalues; - + SolrDisMaxQuery - + diff --git a/reference/solr/solrdismaxquery/setminimummatch.xml b/reference/solr/solrdismaxquery/setminimummatch.xml index d01684a6c..f17d8cca8 100644 --- a/reference/solr/solrdismaxquery/setminimummatch.xml +++ b/reference/solr/solrdismaxquery/setminimummatch.xml @@ -1,5 +1,5 @@ - + @@ -13,9 +13,9 @@ public SolrDisMaxQuerySolrDisMaxQuery::setMinimumMatch stringvalue - - Set Minimum "Should" Match parameter (mm). If the default query operator is AND then mm=100%, if the default query operator (q.op) is OR, then mm=0%. - + + Set Minimum "Should" Match parameter (mm). If the default query operator is AND then mm=100%, if the default query operator (q.op) is OR, then mm=0%. + @@ -24,9 +24,9 @@ value - + Minimum match value/expression - + @@ -34,9 +34,9 @@ &reftitle.returnvalues; - + SolrDisMaxQuery - + diff --git a/reference/solr/solrdismaxquery/setphrasefields.xml b/reference/solr/solrdismaxquery/setphrasefields.xml index 30783ad29..cb1f5c873 100644 --- a/reference/solr/solrdismaxquery/setphrasefields.xml +++ b/reference/solr/solrdismaxquery/setphrasefields.xml @@ -1,5 +1,5 @@ - + @@ -13,9 +13,9 @@ public SolrDisMaxQuerySolrDisMaxQuery::setPhraseFields stringfields - + Sets Phrase Fields (pf) and their boosts (and slops) - + @@ -24,9 +24,9 @@ fields - + Fields, boosts [, slops] - + @@ -34,9 +34,9 @@ &reftitle.returnvalues; - + SolrDisMaxQuery - + diff --git a/reference/solr/solrdismaxquery/setphraseslop.xml b/reference/solr/solrdismaxquery/setphraseslop.xml index 639d97c09..f8b3dfca2 100644 --- a/reference/solr/solrdismaxquery/setphraseslop.xml +++ b/reference/solr/solrdismaxquery/setphraseslop.xml @@ -1,5 +1,5 @@ - + @@ -13,10 +13,10 @@ public SolrDisMaxQuerySolrDisMaxQuery::setPhraseSlop stringslop - + Sets the default amount of slop on phrase queries built with "pf", "pf2" and/or "pf3" fields (affects boosting). - "ps" parameter - + "ps" parameter + @@ -26,9 +26,9 @@ slop - - - + + + @@ -36,9 +36,9 @@ &reftitle.returnvalues; - + SolrDisMaxQuery - + diff --git a/reference/solr/solrdismaxquery/setqueryalt.xml b/reference/solr/solrdismaxquery/setqueryalt.xml index 3cd85b862..d9358d50c 100644 --- a/reference/solr/solrdismaxquery/setqueryalt.xml +++ b/reference/solr/solrdismaxquery/setqueryalt.xml @@ -1,5 +1,5 @@ - + @@ -13,12 +13,12 @@ public SolrDisMaxQuerySolrDisMaxQuery::setQueryAlt stringq - + Set Query Alternate (q.alt parameter) - - + + When the main q parameter is not specified or is blank. The q.alt parameter is used - + @@ -28,9 +28,9 @@ q - + Query String - + @@ -38,9 +38,9 @@ &reftitle.returnvalues; - + SolrDisMaxQuery - + diff --git a/reference/solr/solrdismaxquery/setqueryphraseslop.xml b/reference/solr/solrdismaxquery/setqueryphraseslop.xml index eff66b9b2..19f0079b2 100644 --- a/reference/solr/solrdismaxquery/setqueryphraseslop.xml +++ b/reference/solr/solrdismaxquery/setqueryphraseslop.xml @@ -1,5 +1,5 @@ - + @@ -13,12 +13,12 @@ public SolrDisMaxQuerySolrDisMaxQuery::setQueryPhraseSlop stringslop - + The Query Phrase Slop is the amount of slop permitted on phrase queries explicitly included in the user's query string with the qf parameter. - - + + slop refers to the number of positions one token needs to be moved in relation to another token in order to match a phrase specified in a query. - + @@ -28,9 +28,9 @@ slop - + Amount of slop - + @@ -38,9 +38,9 @@ &reftitle.returnvalues; - + SolrDisMaxQuery - + diff --git a/reference/solr/solrdismaxquery/settiebreaker.xml b/reference/solr/solrdismaxquery/settiebreaker.xml index 75e4553f6..a67c06bdb 100644 --- a/reference/solr/solrdismaxquery/settiebreaker.xml +++ b/reference/solr/solrdismaxquery/settiebreaker.xml @@ -1,5 +1,5 @@ - + @@ -13,9 +13,9 @@ public SolrDisMaxQuerySolrDisMaxQuery::setTieBreaker stringtieBreaker - + Sets Tie Breaker parameter (tie parameter) - + @@ -24,9 +24,9 @@ tieBreaker - + The tie parameter specifies a float value (which should be something much less than 1) to use as tiebreaker in DisMax queries. - + @@ -34,9 +34,9 @@ &reftitle.returnvalues; - + SolrDisMaxQuery - + diff --git a/reference/solr/solrdismaxquery/settrigramphrasefields.xml b/reference/solr/solrdismaxquery/settrigramphrasefields.xml index 7bed4ecf2..dc5a4ed7a 100644 --- a/reference/solr/solrdismaxquery/settrigramphrasefields.xml +++ b/reference/solr/solrdismaxquery/settrigramphrasefields.xml @@ -1,5 +1,5 @@ - + @@ -13,9 +13,9 @@ public SolrDisMaxQuerySolrDisMaxQuery::setTrigramPhraseFields stringfields - + Directly Sets Trigram Phrase Fields (pf3 parameter) - + @@ -25,9 +25,9 @@ fields - + Trigram Phrase Fields - + @@ -35,9 +35,9 @@ &reftitle.returnvalues; - + SolrDisMaxQuery - + diff --git a/reference/solr/solrdismaxquery/settrigramphraseslop.xml b/reference/solr/solrdismaxquery/settrigramphraseslop.xml index 80ac656f6..eda7049db 100644 --- a/reference/solr/solrdismaxquery/settrigramphraseslop.xml +++ b/reference/solr/solrdismaxquery/settrigramphraseslop.xml @@ -1,5 +1,5 @@ - + @@ -13,9 +13,9 @@ public SolrDisMaxQuerySolrDisMaxQuery::setTrigramPhraseSlop stringslop - + Sets Trigram Phrase Slop (ps3 parameter) - + @@ -25,9 +25,9 @@ slop - + Phrase slop - + @@ -35,9 +35,9 @@ &reftitle.returnvalues; - + SolrDisMaxQuery - + diff --git a/reference/solr/solrdismaxquery/setuserfields.xml b/reference/solr/solrdismaxquery/setuserfields.xml index d311b9d46..9367363b3 100644 --- a/reference/solr/solrdismaxquery/setuserfields.xml +++ b/reference/solr/solrdismaxquery/setuserfields.xml @@ -1,5 +1,5 @@ - + @@ -13,13 +13,13 @@ public SolrDisMaxQuerySolrDisMaxQuery::setUserFields stringfields - + Sets User Fields parameter (uf) - - - User Fields: Specifies which schema fields the end user shall be allowed to query. - - + + + User Fields: Specifies which schema fields the end user shall be allowed to query. + + @@ -28,12 +28,12 @@ fields - + Fields names separated by space - - - This parameter supports wildcards. - + + + This parameter supports wildcards. + @@ -41,9 +41,9 @@ &reftitle.returnvalues; - + SolrDisMaxQuery - + diff --git a/reference/solr/solrdismaxquery/usedismaxqueryparser.xml b/reference/solr/solrdismaxquery/usedismaxqueryparser.xml index 8ed928dd6..5a15676c6 100644 --- a/reference/solr/solrdismaxquery/usedismaxqueryparser.xml +++ b/reference/solr/solrdismaxquery/usedismaxqueryparser.xml @@ -1,5 +1,5 @@ - + @@ -13,9 +13,9 @@ public SolrDisMaxQuerySolrDisMaxQuery::useDisMaxQueryParser - + Switch QueryParser to be DisMax Query Parser - + @@ -26,9 +26,9 @@ &reftitle.returnvalues; - + SolrDisMaxQuery - + diff --git a/reference/solr/solrdismaxquery/useedismaxqueryparser.xml b/reference/solr/solrdismaxquery/useedismaxqueryparser.xml index e67e469a2..9c34a62b3 100644 --- a/reference/solr/solrdismaxquery/useedismaxqueryparser.xml +++ b/reference/solr/solrdismaxquery/useedismaxqueryparser.xml @@ -1,5 +1,5 @@ - + @@ -13,9 +13,9 @@ public SolrDisMaxQuerySolrDisMaxQuery::useEDisMaxQueryParser - + Switch QueryParser to be EDisMax. By default the query builder uses edismax, if it was switched using SolrDisMaxQuery::useDisMaxQueryParser, it can be switched back using this method. - + @@ -25,9 +25,9 @@ &reftitle.returnvalues; - + SolrDisMaxQuery - + diff --git a/reference/solr/solrdocument.xml b/reference/solr/solrdocument.xml index 08ed06e8f..c3e72b2b0 100644 --- a/reference/solr/solrdocument.xml +++ b/reference/solr/solrdocument.xml @@ -11,9 +11,9 @@
    &reftitle.intro; - + Represents a Solr document retrieved from a query response. - +
    @@ -30,7 +30,7 @@ final SolrDocument - + ArrayAccess @@ -81,7 +81,7 @@ SolrDocument::SORT_FIELD_BOOST_VALUE 4 - + &Methods; @@ -91,7 +91,7 @@
    - +
    &reftitle.constants; @@ -100,42 +100,42 @@ SolrDocument::SORT_DEFAULT - Default mode for sorting fields within the document. + Default mode for sorting fields within the document. SolrDocument::SORT_ASC - Sorts the fields in ascending order + Sorts the fields in ascending order SolrDocument::SORT_DESC - Sorts the fields in descending order + Sorts the fields in descending order SolrDocument::SORT_FIELD_NAME - Sorts the fields by field name. + Sorts the fields by field name. SolrDocument::SORT_FIELD_VALUE_COUNT - Sorts the fields by number of values in each field. + Sorts the fields by number of values in each field. SolrDocument::SORT_FIELD_BOOST_VALUE - Sorts the fields by their boost values. + Sorts the fields by their boost values. diff --git a/reference/solr/solrdocument/addfield.xml b/reference/solr/solrdocument/addfield.xml index dca46a778..a35018382 100644 --- a/reference/solr/solrdocument/addfield.xml +++ b/reference/solr/solrdocument/addfield.xml @@ -14,9 +14,9 @@ stringfieldName stringfieldValue - + This method adds a field to the SolrDocument instance. - + @@ -27,17 +27,17 @@ fieldName - + The name of the field - + fieldValue - + The value of the field. - + @@ -46,9 +46,9 @@ &reftitle.returnvalues; - + &return.success; - + diff --git a/reference/solr/solrdocument/clear.xml b/reference/solr/solrdocument/clear.xml index 0b3c001a1..b35a6e8a9 100644 --- a/reference/solr/solrdocument/clear.xml +++ b/reference/solr/solrdocument/clear.xml @@ -13,9 +13,9 @@ public boolSolrDocument::clear - + Resets the current object. Discards all the fields and resets the document boost to zero. - + @@ -26,9 +26,9 @@ &reftitle.returnvalues; - + &return.success; - + diff --git a/reference/solr/solrdocument/clone.xml b/reference/solr/solrdocument/clone.xml index ba03a02bc..af2eba67f 100644 --- a/reference/solr/solrdocument/clone.xml +++ b/reference/solr/solrdocument/clone.xml @@ -13,9 +13,9 @@ public voidSolrDocument::__clone - + Creates a copy of a SolrDocument object. Not to be called directly. - + @@ -26,9 +26,9 @@ &reftitle.returnvalues; - + None. - + diff --git a/reference/solr/solrdocument/construct.xml b/reference/solr/solrdocument/construct.xml index 35b28f643..0dc104afd 100644 --- a/reference/solr/solrdocument/construct.xml +++ b/reference/solr/solrdocument/construct.xml @@ -13,9 +13,9 @@ public SolrDocument::__construct - + Constructor for SolrDocument - + @@ -26,9 +26,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/solr/solrdocument/current.xml b/reference/solr/solrdocument/current.xml index 534a76f7a..423c762ad 100644 --- a/reference/solr/solrdocument/current.xml +++ b/reference/solr/solrdocument/current.xml @@ -13,9 +13,9 @@ public SolrDocumentFieldSolrDocument::current - + Retrieves the current field - + @@ -26,9 +26,9 @@ &reftitle.returnvalues; - + Returns the field - + diff --git a/reference/solr/solrdocument/deletefield.xml b/reference/solr/solrdocument/deletefield.xml index e91804563..c415c2a4f 100644 --- a/reference/solr/solrdocument/deletefield.xml +++ b/reference/solr/solrdocument/deletefield.xml @@ -13,11 +13,11 @@ public boolSolrDocument::deleteField stringfieldName - + Removes a field from the document. - + + - @@ -28,9 +28,9 @@ fieldName - + Name of the field - + @@ -39,9 +39,9 @@ &reftitle.returnvalues; - + &return.success; - + diff --git a/reference/solr/solrdocument/destruct.xml b/reference/solr/solrdocument/destruct.xml index 3ac50ed5d..03cec9d1c 100644 --- a/reference/solr/solrdocument/destruct.xml +++ b/reference/solr/solrdocument/destruct.xml @@ -13,9 +13,9 @@ public SolrDocument::__destruct - + Destructor for SolrDocument. - + @@ -26,9 +26,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/solr/solrdocument/fieldexists.xml b/reference/solr/solrdocument/fieldexists.xml index c69f1d151..0cd60d1ee 100644 --- a/reference/solr/solrdocument/fieldexists.xml +++ b/reference/solr/solrdocument/fieldexists.xml @@ -13,9 +13,9 @@ public boolSolrDocument::fieldExists stringfieldName - + Checks if the requested field as a valid fieldname in the document. - + @@ -26,9 +26,9 @@ fieldName - + The name of the field. - + @@ -37,9 +37,9 @@ &reftitle.returnvalues; - + Returns &true; if the field is present and &false; if it does not. - + diff --git a/reference/solr/solrdocument/get.xml b/reference/solr/solrdocument/get.xml index ceb77016a..02d1ea3db 100644 --- a/reference/solr/solrdocument/get.xml +++ b/reference/solr/solrdocument/get.xml @@ -13,11 +13,11 @@ public SolrDocumentFieldSolrDocument::__get stringfieldName - + Magic method for accessing the field as a property. - + + - @@ -28,9 +28,9 @@ fieldName - + The name of the field. - + @@ -39,9 +39,9 @@ &reftitle.returnvalues; - + Returns a SolrDocumentField instance. - + diff --git a/reference/solr/solrdocument/getchilddocuments.xml b/reference/solr/solrdocument/getchilddocuments.xml index 355c7c412..5475f9a41 100644 --- a/reference/solr/solrdocument/getchilddocuments.xml +++ b/reference/solr/solrdocument/getchilddocuments.xml @@ -13,9 +13,9 @@ public arraySolrDocument::getChildDocuments - + Returns an array of child documents (SolrDocument) - + @@ -25,15 +25,15 @@ &reftitle.returnvalues; - - - + + + &reftitle.seealso; - SolrDocument::hasChildDocuments + SolrDocument::hasChildDocuments SolrDocument::getChildDocumentsCount diff --git a/reference/solr/solrdocument/getchilddocumentscount.xml b/reference/solr/solrdocument/getchilddocumentscount.xml index a7098305c..ff098ba68 100644 --- a/reference/solr/solrdocument/getchilddocumentscount.xml +++ b/reference/solr/solrdocument/getchilddocumentscount.xml @@ -13,9 +13,9 @@ public intSolrDocument::getChildDocumentsCount - + Returns the number of child documents - + @@ -25,15 +25,15 @@ &reftitle.returnvalues; - - - + + + &reftitle.seealso; - SolrDocument::hasChildDocuments + SolrDocument::hasChildDocuments SolrDocument::getChildDocuments diff --git a/reference/solr/solrdocument/getfield.xml b/reference/solr/solrdocument/getfield.xml index a3b53d4db..71c3c3ce1 100644 --- a/reference/solr/solrdocument/getfield.xml +++ b/reference/solr/solrdocument/getfield.xml @@ -13,9 +13,9 @@ public SolrDocumentFieldSolrDocument::getField stringfieldName - + Retrieves a field by name. - + @@ -26,9 +26,9 @@ fieldName - + Name of the field. - + @@ -37,9 +37,9 @@ &reftitle.returnvalues; - + Returns a SolrDocumentField on success and &false; on failure. - + diff --git a/reference/solr/solrdocument/getfieldcount.xml b/reference/solr/solrdocument/getfieldcount.xml index 5e5d53933..6198fc1e3 100644 --- a/reference/solr/solrdocument/getfieldcount.xml +++ b/reference/solr/solrdocument/getfieldcount.xml @@ -13,11 +13,11 @@ public intSolrDocument::getFieldCount - + Returns the number of fields in this document. Multi-value fields are only counted once. - + + - @@ -28,9 +28,9 @@ &reftitle.returnvalues; - + Returns an integer on success and &false; on failure. - + diff --git a/reference/solr/solrdocument/getfieldnames.xml b/reference/solr/solrdocument/getfieldnames.xml index ad00efc09..cf0e39dd8 100644 --- a/reference/solr/solrdocument/getfieldnames.xml +++ b/reference/solr/solrdocument/getfieldnames.xml @@ -13,9 +13,9 @@ public arraySolrDocument::getFieldNames - + Returns an array of fields names in the document. - + @@ -26,9 +26,9 @@ &reftitle.returnvalues; - + Returns an array containing the names of the fields in this document. - + diff --git a/reference/solr/solrdocument/getinputdocument.xml b/reference/solr/solrdocument/getinputdocument.xml index c5fdb472e..d798f56b0 100644 --- a/reference/solr/solrdocument/getinputdocument.xml +++ b/reference/solr/solrdocument/getinputdocument.xml @@ -13,10 +13,10 @@ public SolrInputDocumentSolrDocument::getInputDocument - + Returns a SolrInputDocument equivalent of the object. This is useful if one wishes to resubmit/update a document retrieved from a query. - - + + @@ -26,9 +26,9 @@ &reftitle.returnvalues; - + Returns a SolrInputDocument on success and &null; on failure. - + diff --git a/reference/solr/solrdocument/haschilddocuments.xml b/reference/solr/solrdocument/haschilddocuments.xml index d8eb79be9..256e2021e 100644 --- a/reference/solr/solrdocument/haschilddocuments.xml +++ b/reference/solr/solrdocument/haschilddocuments.xml @@ -13,9 +13,9 @@ public boolSolrDocument::hasChildDocuments - + Checks whether the document has any child documents - + @@ -25,15 +25,15 @@ &reftitle.returnvalues; - - - + + + &reftitle.seealso; - SolrDocument::getChildDocuments + SolrDocument::getChildDocuments SolrDocument::getChildDocumentsCount diff --git a/reference/solr/solrdocument/isset.xml b/reference/solr/solrdocument/isset.xml index 48c2af060..e7c71a8f8 100644 --- a/reference/solr/solrdocument/isset.xml +++ b/reference/solr/solrdocument/isset.xml @@ -13,11 +13,11 @@ public boolSolrDocument::__isset stringfieldName - + Checks if a field exists - + + - @@ -28,9 +28,9 @@ fieldName - + Name of the field. - + @@ -39,9 +39,9 @@ &reftitle.returnvalues; - + &return.success; - + diff --git a/reference/solr/solrdocument/key.xml b/reference/solr/solrdocument/key.xml index 7a9664068..9955863de 100644 --- a/reference/solr/solrdocument/key.xml +++ b/reference/solr/solrdocument/key.xml @@ -13,9 +13,9 @@ public stringSolrDocument::key - - Retrieves the current key. - + + Retrieves the current key. + @@ -26,9 +26,9 @@ &reftitle.returnvalues; - + Returns the current key. - + diff --git a/reference/solr/solrdocument/merge.xml b/reference/solr/solrdocument/merge.xml index d8857d4d2..8f0e7a908 100644 --- a/reference/solr/solrdocument/merge.xml +++ b/reference/solr/solrdocument/merge.xml @@ -14,10 +14,10 @@ SolrDocumentsourceDoc booloverwrite&true; - + Merges source to the current SolrDocument. - - + + @@ -27,17 +27,17 @@ sourceDoc - + The source document. - + overwrite - + If this is &true; then fields with the same name in the destination document will be overwritten. - + @@ -46,9 +46,9 @@ &reftitle.returnvalues; - + &return.success; - + diff --git a/reference/solr/solrdocument/next.xml b/reference/solr/solrdocument/next.xml index 1a6dace9d..0ab54a5ef 100644 --- a/reference/solr/solrdocument/next.xml +++ b/reference/solr/solrdocument/next.xml @@ -13,11 +13,11 @@ public voidSolrDocument::next - + Moves the internal pointer to the next field. - + + - @@ -28,9 +28,9 @@ &reftitle.returnvalues; - + This method has no return value. - + diff --git a/reference/solr/solrdocument/offsetexists.xml b/reference/solr/solrdocument/offsetexists.xml index 82cf328a9..757d8db0b 100644 --- a/reference/solr/solrdocument/offsetexists.xml +++ b/reference/solr/solrdocument/offsetexists.xml @@ -13,9 +13,9 @@ public boolSolrDocument::offsetExists stringfieldName - + Checks if a particular field exists. This is used when the object is treated as an array. - + @@ -26,9 +26,9 @@ fieldName - + The name of the field. - + @@ -37,9 +37,9 @@ &reftitle.returnvalues; - + &return.success; - + diff --git a/reference/solr/solrdocument/offsetget.xml b/reference/solr/solrdocument/offsetget.xml index d616c56da..c9841d993 100644 --- a/reference/solr/solrdocument/offsetget.xml +++ b/reference/solr/solrdocument/offsetget.xml @@ -13,11 +13,11 @@ public SolrDocumentFieldSolrDocument::offsetGet stringfieldName - + This is used to retrieve the field when the object is treated as an array. - + + - @@ -28,9 +28,9 @@ fieldName - + The name of the field. - + @@ -39,9 +39,9 @@ &reftitle.returnvalues; - + Returns a SolrDocumentField object. - + diff --git a/reference/solr/solrdocument/offsetset.xml b/reference/solr/solrdocument/offsetset.xml index 193121a17..435be3b7b 100644 --- a/reference/solr/solrdocument/offsetset.xml +++ b/reference/solr/solrdocument/offsetset.xml @@ -14,9 +14,9 @@ stringfieldName stringfieldValue - + Used when the object is treated as an array to add a field to the document. - + @@ -27,17 +27,17 @@ fieldName - + The name of the field. - + fieldValue - + The value for this field. - + @@ -46,9 +46,9 @@ &reftitle.returnvalues; - + &return.success; - + diff --git a/reference/solr/solrdocument/offsetunset.xml b/reference/solr/solrdocument/offsetunset.xml index d8e167e38..20a1ca7e3 100644 --- a/reference/solr/solrdocument/offsetunset.xml +++ b/reference/solr/solrdocument/offsetunset.xml @@ -13,11 +13,11 @@ public voidSolrDocument::offsetUnset stringfieldName - + Removes a field from the document. - + + - @@ -28,9 +28,9 @@ fieldName - + The name of the field. - + @@ -39,9 +39,9 @@ &reftitle.returnvalues; - + No return value. - + diff --git a/reference/solr/solrdocument/reset.xml b/reference/solr/solrdocument/reset.xml index 716c1a189..f5c731795 100644 --- a/reference/solr/solrdocument/reset.xml +++ b/reference/solr/solrdocument/reset.xml @@ -13,11 +13,11 @@ public boolSolrDocument::reset - + This is an alias to SolrDocument::clear() - + + - @@ -28,9 +28,9 @@ &reftitle.returnvalues; - + &return.success; - + diff --git a/reference/solr/solrdocument/rewind.xml b/reference/solr/solrdocument/rewind.xml index 2a798ca23..a01fad24c 100644 --- a/reference/solr/solrdocument/rewind.xml +++ b/reference/solr/solrdocument/rewind.xml @@ -13,11 +13,11 @@ public voidSolrDocument::rewind - + Resets the internal pointer to the beginning. - + + - @@ -28,9 +28,9 @@ &reftitle.returnvalues; - + This method has no return value. - + diff --git a/reference/solr/solrdocument/serialize.xml b/reference/solr/solrdocument/serialize.xml index 607a4ff8d..01db8c6e7 100644 --- a/reference/solr/solrdocument/serialize.xml +++ b/reference/solr/solrdocument/serialize.xml @@ -13,11 +13,11 @@ public stringSolrDocument::serialize - + Used for custom serialization. - + + - @@ -28,9 +28,9 @@ &reftitle.returnvalues; - + Returns a string representing the serialized Solr document. - + diff --git a/reference/solr/solrdocument/set.xml b/reference/solr/solrdocument/set.xml index cfc74ac2a..efb6ccb71 100644 --- a/reference/solr/solrdocument/set.xml +++ b/reference/solr/solrdocument/set.xml @@ -14,9 +14,9 @@ stringfieldName stringfieldValue - + Adds another field to the document. Used to set the fields as new properties. - + @@ -27,17 +27,17 @@ fieldName - + Name of the field. - + fieldValue - + Field value. - + @@ -46,9 +46,9 @@ &reftitle.returnvalues; - + &return.success; - + diff --git a/reference/solr/solrdocument/sort.xml b/reference/solr/solrdocument/sort.xml index 9a446f51c..c1c1debdf 100644 --- a/reference/solr/solrdocument/sort.xml +++ b/reference/solr/solrdocument/sort.xml @@ -14,27 +14,27 @@ intsortOrderBy intsortDirectionSolrDocument::SORT_ASC - + - + @@ -44,17 +44,17 @@ sortOrderBy - + The sort criteria. - + sortDirection - + The sort direction. - + @@ -63,9 +63,9 @@ &reftitle.returnvalues; - + &return.success; - + diff --git a/reference/solr/solrdocument/toarray.xml b/reference/solr/solrdocument/toarray.xml index e0e7b3a4c..0e2d7fd73 100644 --- a/reference/solr/solrdocument/toarray.xml +++ b/reference/solr/solrdocument/toarray.xml @@ -13,9 +13,9 @@ public arraySolrDocument::toArray - + Returns an array representation of the document. - + @@ -26,11 +26,11 @@ &reftitle.returnvalues; - + Returns an array representation of the document. - + - + &reftitle.examples; diff --git a/reference/solr/solrdocument/unserialize.xml b/reference/solr/solrdocument/unserialize.xml index a24d6f710..8777bacee 100644 --- a/reference/solr/solrdocument/unserialize.xml +++ b/reference/solr/solrdocument/unserialize.xml @@ -13,11 +13,11 @@ public voidSolrDocument::unserialize stringserialized - + Custom serialization of SolrDocument objects - + + - @@ -28,9 +28,9 @@ serialized - + An XML representation of the document. - + @@ -39,9 +39,9 @@ &reftitle.returnvalues; - + None. - + diff --git a/reference/solr/solrdocument/unset.xml b/reference/solr/solrdocument/unset.xml index 4e59efcf3..c02e98cbc 100644 --- a/reference/solr/solrdocument/unset.xml +++ b/reference/solr/solrdocument/unset.xml @@ -13,11 +13,11 @@ public boolSolrDocument::__unset stringfieldName - + Removes a field from the document when the field is access as an object property. - + + - @@ -28,9 +28,9 @@ fieldName - + The name of the field. - + @@ -39,9 +39,9 @@ &reftitle.returnvalues; - + &return.success; - + diff --git a/reference/solr/solrdocument/valid.xml b/reference/solr/solrdocument/valid.xml index 167241301..7de02bd8b 100644 --- a/reference/solr/solrdocument/valid.xml +++ b/reference/solr/solrdocument/valid.xml @@ -13,9 +13,9 @@ public boolSolrDocument::valid - + Checks if the current position internally is still valid. It is used during foreach operations. - + @@ -26,9 +26,9 @@ &reftitle.returnvalues; - + Returns &true; on success and &false; if the current position is no longer valid. - + diff --git a/reference/solr/solrdocumentfield.xml b/reference/solr/solrdocumentfield.xml index ccb8ab0e2..d6bcb1b98 100644 --- a/reference/solr/solrdocumentfield.xml +++ b/reference/solr/solrdocumentfield.xml @@ -11,9 +11,9 @@
    &reftitle.intro; - + This represents a field in a Solr document. All its properties are read-only. - +
    @@ -52,7 +52,7 @@ values - + &Methods; @@ -61,7 +61,7 @@
    - +
    &reftitle.properties; @@ -69,19 +69,19 @@ name - The name of the field. + The name of the field. boost - The boost value for the field + The boost value for the field values - An array of values for this field + An array of values for this field diff --git a/reference/solr/solrdocumentfield/construct.xml b/reference/solr/solrdocumentfield/construct.xml index 6def2fdca..18fbb3d84 100644 --- a/reference/solr/solrdocumentfield/construct.xml +++ b/reference/solr/solrdocumentfield/construct.xml @@ -13,9 +13,9 @@ public SolrDocumentField::__construct - + Constructor. - + @@ -26,9 +26,9 @@ &reftitle.returnvalues; - + None. - + diff --git a/reference/solr/solrdocumentfield/destruct.xml b/reference/solr/solrdocumentfield/destruct.xml index 8dc732c39..d302da67d 100644 --- a/reference/solr/solrdocumentfield/destruct.xml +++ b/reference/solr/solrdocumentfield/destruct.xml @@ -13,10 +13,10 @@ public SolrDocumentField::__destruct - + Destructor. - - + + @@ -26,9 +26,9 @@ &reftitle.returnvalues; - + None. - + diff --git a/reference/solr/solrexception.xml b/reference/solr/solrexception.xml index c2079d73b..bf627e31e 100644 --- a/reference/solr/solrexception.xml +++ b/reference/solr/solrexception.xml @@ -11,9 +11,9 @@
    &reftitle.intro; - + This is the base class for all exception thrown by the Solr extension classes. - +
    @@ -29,7 +29,7 @@ SolrException - + extends Exception @@ -55,10 +55,10 @@ &InheritedProperties; - + &Methods; - + &InheritedMethods; @@ -67,7 +67,7 @@
    - +
    &reftitle.properties; @@ -75,19 +75,19 @@ sourceline - The line in c-space source file where exception was generated + The line in c-space source file where exception was generated sourcefile - The c-space source file where exception was generated + The c-space source file where exception was generated zif_name - The c-space function where exception was generated + The c-space function where exception was generated diff --git a/reference/solr/solrexception/getinternalinfo.xml b/reference/solr/solrexception/getinternalinfo.xml index e05e28488..ce2a37f3e 100644 --- a/reference/solr/solrexception/getinternalinfo.xml +++ b/reference/solr/solrexception/getinternalinfo.xml @@ -13,9 +13,9 @@ public arraySolrException::getInternalInfo - + Returns internal information where the Exception was thrown. - + @@ -26,9 +26,9 @@ &reftitle.returnvalues; - + Returns an array containing internal information where the error was thrown. Used only for debugging by extension developers. - + diff --git a/reference/solr/solrgenericresponse.xml b/reference/solr/solrgenericresponse.xml index 9b8f5b2dd..ffec0c00d 100644 --- a/reference/solr/solrgenericresponse.xml +++ b/reference/solr/solrgenericresponse.xml @@ -11,9 +11,9 @@
    &reftitle.intro; - + Represents a response from the solr server. - +
    @@ -30,7 +30,7 @@ final SolrGenericResponse - + extends SolrResponse @@ -53,11 +53,11 @@ &InheritedProperties; - + &Methods; - + &InheritedMethods; @@ -66,7 +66,7 @@
    - +
    &reftitle.constants; @@ -77,14 +77,14 @@ SolrGenericResponse::PARSE_SOLR_OBJ - Documents should be parsed as SolrObject instances + Documents should be parsed as SolrObject instances SolrGenericResponse::PARSE_SOLR_DOC - Documents should be parsed as SolrDocument instances. + Documents should be parsed as SolrDocument instances. diff --git a/reference/solr/solrgenericresponse/construct.xml b/reference/solr/solrgenericresponse/construct.xml index 34f689092..b8df840b9 100644 --- a/reference/solr/solrgenericresponse/construct.xml +++ b/reference/solr/solrgenericresponse/construct.xml @@ -13,9 +13,9 @@ public SolrGenericResponse::__construct - + Constructor - + @@ -26,9 +26,9 @@ &reftitle.returnvalues; - + None - + diff --git a/reference/solr/solrgenericresponse/destruct.xml b/reference/solr/solrgenericresponse/destruct.xml index b742e9124..967304007 100644 --- a/reference/solr/solrgenericresponse/destruct.xml +++ b/reference/solr/solrgenericresponse/destruct.xml @@ -13,9 +13,9 @@ public SolrGenericResponse::__destruct - + Destructor. - + @@ -25,9 +25,9 @@ &reftitle.returnvalues; - + None - + diff --git a/reference/solr/solrillegalargumentexception.xml b/reference/solr/solrillegalargumentexception.xml index f674dac42..2d8a9f048 100644 --- a/reference/solr/solrillegalargumentexception.xml +++ b/reference/solr/solrillegalargumentexception.xml @@ -11,9 +11,9 @@
    &reftitle.intro; - + This object is thrown when an illegal or invalid argument is passed to a method. - +
    @@ -29,7 +29,7 @@ SolrIllegalArgumentException - + extends SolrException @@ -39,10 +39,10 @@ &InheritedProperties; - + &Methods; - + &InheritedMethods; @@ -52,7 +52,7 @@
    - + &reference.solr.entities.solrillegalargumentexception; diff --git a/reference/solr/solrillegalargumentexception/getinternalinfo.xml b/reference/solr/solrillegalargumentexception/getinternalinfo.xml index b71bc780f..b36db6977 100644 --- a/reference/solr/solrillegalargumentexception/getinternalinfo.xml +++ b/reference/solr/solrillegalargumentexception/getinternalinfo.xml @@ -13,9 +13,9 @@ public arraySolrIllegalArgumentException::getInternalInfo - + Returns internal information where the Exception was thrown. - +     &warn.undocumented.func; @@ -28,9 +28,9 @@ &reftitle.returnvalues; - + Returns an array containing internal information where the error was thrown. Used only for debugging by extension developers. - +     diff --git a/reference/solr/solrillegaloperationexception.xml b/reference/solr/solrillegaloperationexception.xml index 68b0d6c70..a8e210e63 100644 --- a/reference/solr/solrillegaloperationexception.xml +++ b/reference/solr/solrillegaloperationexception.xml @@ -11,9 +11,9 @@
    &reftitle.intro; - + This object is thrown when an illegal or unsupported operation is performed on an object. - +
    @@ -29,7 +29,7 @@ SolrIllegalOperationException - + extends SolrException @@ -39,10 +39,10 @@ &InheritedProperties; - + &Methods; - + &InheritedMethods; @@ -52,7 +52,7 @@
    - + &reference.solr.entities.solrillegaloperationexception; diff --git a/reference/solr/solrillegaloperationexception/getinternalinfo.xml b/reference/solr/solrillegaloperationexception/getinternalinfo.xml index 03c086455..4173d8d45 100644 --- a/reference/solr/solrillegaloperationexception/getinternalinfo.xml +++ b/reference/solr/solrillegaloperationexception/getinternalinfo.xml @@ -13,9 +13,9 @@ public arraySolrIllegalOperationException::getInternalInfo - + Returns internal information where the Exception was thrown. - + &warn.undocumented.func; @@ -28,9 +28,9 @@ &reftitle.returnvalues; - + Returns an array containing internal information where the error was thrown. Used only for debugging by extension developers. - +     diff --git a/reference/solr/solrinputdocument.xml b/reference/solr/solrinputdocument.xml index 66cd28626..4755d20e5 100644 --- a/reference/solr/solrinputdocument.xml +++ b/reference/solr/solrinputdocument.xml @@ -11,9 +11,9 @@
    &reftitle.intro; - + This class represents a Solr document that is about to be submitted to the Solr index. - +
    @@ -69,7 +69,7 @@ SolrInputDocument::SORT_FIELD_BOOST_VALUE 4 - + &Methods; @@ -78,7 +78,7 @@ - +
    &reftitle.constants; @@ -89,42 +89,42 @@ SolrInputDocument::SORT_DEFAULT - Sorts the fields in ascending order. + Sorts the fields in ascending order. SolrInputDocument::SORT_ASC - Sorts the fields in ascending order. + Sorts the fields in ascending order. SolrInputDocument::SORT_DESC - Sorts the fields in descending order. + Sorts the fields in descending order. SolrInputDocument::SORT_FIELD_NAME - Sorts the fields by name + Sorts the fields by name SolrInputDocument::SORT_FIELD_VALUE_COUNT - Sorts the fields by number of values. + Sorts the fields by number of values. SolrInputDocument::SORT_FIELD_BOOST_VALUE - Sorts the fields by boost value. + Sorts the fields by boost value. diff --git a/reference/solr/solrinputdocument/addchilddocument.xml b/reference/solr/solrinputdocument/addchilddocument.xml index 325314f5d..68f19d2a6 100644 --- a/reference/solr/solrinputdocument/addchilddocument.xml +++ b/reference/solr/solrinputdocument/addchilddocument.xml @@ -13,9 +13,9 @@ public voidSolrInputDocument::addChildDocument SolrInputDocumentchild - + Adds a child document to construct a document block with nested documents. - + @@ -24,9 +24,9 @@ child - + A SolrInputDocument object. - + @@ -34,19 +34,19 @@ &reftitle.returnvalues; - + &return.void; - + &reftitle.errors; - - Throws SolrIllegalArgumentException on failure. - - - Throws SolrException on internal failure. - + + Throws SolrIllegalArgumentException on failure. + + + Throws SolrException on internal failure. + @@ -95,7 +95,7 @@ $large->addField('content_type', 'sku'); $large->addField('size', 'L'); $large->addField('inventory', 300); -// add child documents +// add child documents $product->addChildDocument($small); $product->addChildDocument($medium); $product->addChildDocument($large); diff --git a/reference/solr/solrinputdocument/addchilddocuments.xml b/reference/solr/solrinputdocument/addchilddocuments.xml index a2c56ae4c..a362b47fe 100644 --- a/reference/solr/solrinputdocument/addchilddocuments.xml +++ b/reference/solr/solrinputdocument/addchilddocuments.xml @@ -13,9 +13,9 @@ public voidSolrInputDocument::addChildDocuments arraydocs - + Adds an array of child documents to the current input document. - + @@ -25,9 +25,9 @@ docs - + An array of SolrInputDocument objects. - + @@ -35,19 +35,19 @@ &reftitle.returnvalues; - + &return.void; - + &reftitle.errors; - - Throws SolrIllegalArgumentException on failure. - - - Throws SolrException on internal failure. - + + Throws SolrIllegalArgumentException on failure. + + + Throws SolrException on internal failure. + @@ -96,7 +96,7 @@ $large->addField('content_type', 'sku'); $large->addField('size', 'L'); $large->addField('inventory', 300); -// add child documents +// add child documents $skus = [$small, $medium, $large]; $product->addChildDocuments($skus); diff --git a/reference/solr/solrinputdocument/addfield.xml b/reference/solr/solrinputdocument/addfield.xml index 5af9e4e65..081da5aae 100644 --- a/reference/solr/solrinputdocument/addfield.xml +++ b/reference/solr/solrinputdocument/addfield.xml @@ -15,9 +15,9 @@ stringfieldValue floatfieldBoostValue0.0 - + For multi-value fields, if a valid boost value is specified, the specified value will be multiplied by the current boost value for this field. - + @@ -28,25 +28,25 @@ fieldName - + The name of the field - + fieldValue - + The value for the field. - + fieldBoostValue - + The index time boost for the field. Though this cannot be negative, you can still pass values less than 1.0 but they must be greater than zero. - + @@ -55,9 +55,9 @@ &reftitle.returnvalues; - + &return.success; - + diff --git a/reference/solr/solrinputdocument/clear.xml b/reference/solr/solrinputdocument/clear.xml index 2e9921d68..fa284af02 100644 --- a/reference/solr/solrinputdocument/clear.xml +++ b/reference/solr/solrinputdocument/clear.xml @@ -13,10 +13,10 @@ public boolSolrInputDocument::clear - + Resets the document by dropping all the fields and resets the document boost to zero. - - + + @@ -26,9 +26,9 @@ &reftitle.returnvalues; - + &return.success; - + diff --git a/reference/solr/solrinputdocument/clone.xml b/reference/solr/solrinputdocument/clone.xml index d372d6c61..309431e00 100644 --- a/reference/solr/solrinputdocument/clone.xml +++ b/reference/solr/solrinputdocument/clone.xml @@ -13,10 +13,10 @@ public voidSolrInputDocument::__clone - + Should not be called directly. It is used to create a deep copy of a SolrInputDocument. - - + + @@ -26,9 +26,9 @@ &reftitle.returnvalues; - + Creates a new SolrInputDocument instance. - + diff --git a/reference/solr/solrinputdocument/construct.xml b/reference/solr/solrinputdocument/construct.xml index cd62c7b62..9856aea1e 100644 --- a/reference/solr/solrinputdocument/construct.xml +++ b/reference/solr/solrinputdocument/construct.xml @@ -13,9 +13,9 @@ public SolrInputDocument::__construct - + Constructor. - + @@ -26,9 +26,9 @@ &reftitle.returnvalues; - + None. - + diff --git a/reference/solr/solrinputdocument/deletefield.xml b/reference/solr/solrinputdocument/deletefield.xml index 2aca3b9e6..a080cdd46 100644 --- a/reference/solr/solrinputdocument/deletefield.xml +++ b/reference/solr/solrinputdocument/deletefield.xml @@ -13,9 +13,9 @@ public boolSolrInputDocument::deleteField stringfieldName - + Removes a field from the document. - + @@ -26,9 +26,9 @@ fieldName - + The name of the field. - + @@ -37,9 +37,9 @@ &reftitle.returnvalues; - + &return.success; - + diff --git a/reference/solr/solrinputdocument/destruct.xml b/reference/solr/solrinputdocument/destruct.xml index 3e7649fe3..a1dca706f 100644 --- a/reference/solr/solrinputdocument/destruct.xml +++ b/reference/solr/solrinputdocument/destruct.xml @@ -13,11 +13,11 @@ public SolrInputDocument::__destruct - + Destructor - + + - @@ -28,9 +28,9 @@ &reftitle.returnvalues; - + None. - + diff --git a/reference/solr/solrinputdocument/fieldexists.xml b/reference/solr/solrinputdocument/fieldexists.xml index d5c7594f0..670390737 100644 --- a/reference/solr/solrinputdocument/fieldexists.xml +++ b/reference/solr/solrinputdocument/fieldexists.xml @@ -13,9 +13,9 @@ public boolSolrInputDocument::fieldExists stringfieldName - + Checks if a field exists - + @@ -26,9 +26,9 @@ fieldName - + Name of the field. - + @@ -37,9 +37,9 @@ &reftitle.returnvalues; - + Returns &true; if the field was found and &false; if it was not found. - + diff --git a/reference/solr/solrinputdocument/getboost.xml b/reference/solr/solrinputdocument/getboost.xml index d607dd300..f84e302b0 100644 --- a/reference/solr/solrinputdocument/getboost.xml +++ b/reference/solr/solrinputdocument/getboost.xml @@ -13,11 +13,11 @@ public floatSolrInputDocument::getBoost - + Retrieves the current boost value for the document. - + + - @@ -28,9 +28,9 @@ &reftitle.returnvalues; - + Returns the boost value on success and &false; on failure. - + diff --git a/reference/solr/solrinputdocument/getchilddocuments.xml b/reference/solr/solrinputdocument/getchilddocuments.xml index c9b777276..309b122d4 100644 --- a/reference/solr/solrinputdocument/getchilddocuments.xml +++ b/reference/solr/solrinputdocument/getchilddocuments.xml @@ -13,9 +13,9 @@ public arraySolrInputDocument::getChildDocuments - + Returns an array of child documents (SolrInputDocument) - + @@ -25,15 +25,15 @@ &reftitle.returnvalues; - - - + + + &reftitle.seealso; - SolrInputDocument::addChildDocument + SolrInputDocument::addChildDocument SolrInputDocument::addChildDocuments SolrInputDocument::hasChildDocuments SolrInputDocument::getChildDocumentsCount diff --git a/reference/solr/solrinputdocument/getchilddocumentscount.xml b/reference/solr/solrinputdocument/getchilddocumentscount.xml index cced021d0..c10b0fe06 100644 --- a/reference/solr/solrinputdocument/getchilddocumentscount.xml +++ b/reference/solr/solrinputdocument/getchilddocumentscount.xml @@ -13,9 +13,9 @@ public intSolrInputDocument::getChildDocumentsCount - + Returns the number of child documents - + @@ -25,15 +25,15 @@ &reftitle.returnvalues; - - - + + + &reftitle.seealso; - SolrInputDocument::addChildDocument + SolrInputDocument::addChildDocument SolrInputDocument::addChildDocuments SolrInputDocument::hasChildDocuments SolrInputDocument::getChildDocuments diff --git a/reference/solr/solrinputdocument/getfield.xml b/reference/solr/solrinputdocument/getfield.xml index 07e4a918a..102d8c910 100644 --- a/reference/solr/solrinputdocument/getfield.xml +++ b/reference/solr/solrinputdocument/getfield.xml @@ -13,9 +13,9 @@ public SolrDocumentFieldSolrInputDocument::getField stringfieldName - + Retrieves a field in the document. - + @@ -26,9 +26,9 @@ fieldName - + The name of the field. - + @@ -37,9 +37,9 @@ &reftitle.returnvalues; - + Returns a SolrDocumentField object on success and &false; on failure. - + diff --git a/reference/solr/solrinputdocument/getfieldboost.xml b/reference/solr/solrinputdocument/getfieldboost.xml index 02562be4e..49159c933 100644 --- a/reference/solr/solrinputdocument/getfieldboost.xml +++ b/reference/solr/solrinputdocument/getfieldboost.xml @@ -13,9 +13,9 @@ public floatSolrInputDocument::getFieldBoost stringfieldName - + Retrieves the boost value for a particular field. - + @@ -26,9 +26,9 @@ fieldName - + The name of the field. - + @@ -37,9 +37,9 @@ &reftitle.returnvalues; - + Returns the boost value for the field or &false; if there was an error. - + diff --git a/reference/solr/solrinputdocument/getfieldcount.xml b/reference/solr/solrinputdocument/getfieldcount.xml index eabfeb5ab..2921f8baf 100644 --- a/reference/solr/solrinputdocument/getfieldcount.xml +++ b/reference/solr/solrinputdocument/getfieldcount.xml @@ -13,9 +13,9 @@ public intfalseSolrInputDocument::getFieldCount - + Returns the number of fields in the document. - + @@ -26,9 +26,9 @@ &reftitle.returnvalues; - + Returns an integer on success&return.falseforfailure;. - + diff --git a/reference/solr/solrinputdocument/getfieldnames.xml b/reference/solr/solrinputdocument/getfieldnames.xml index dda4b6368..726a55f99 100644 --- a/reference/solr/solrinputdocument/getfieldnames.xml +++ b/reference/solr/solrinputdocument/getfieldnames.xml @@ -13,9 +13,9 @@ public arraySolrInputDocument::getFieldNames - + Returns an array containing all the fields in the document. - + @@ -26,9 +26,9 @@ &reftitle.returnvalues; - + Returns an array on success and &false; on failure. - + diff --git a/reference/solr/solrinputdocument/haschilddocuments.xml b/reference/solr/solrinputdocument/haschilddocuments.xml index aa25dce3e..f90446224 100644 --- a/reference/solr/solrinputdocument/haschilddocuments.xml +++ b/reference/solr/solrinputdocument/haschilddocuments.xml @@ -13,9 +13,9 @@ public boolSolrInputDocument::hasChildDocuments - + Checks whether the document has any child documents - + @@ -25,21 +25,21 @@ &reftitle.returnvalues; - - - + + + &reftitle.seealso; - SolrInputDocument::addChildDocument + SolrInputDocument::addChildDocument SolrInputDocument::addChildDocuments SolrInputDocument::getChildDocuments SolrInputDocument::getChildDocumentsCount - +
    &reftitle.intro; - + - +
    @@ -29,7 +29,7 @@ SolrMissingMandatoryParameterException - + extends SolrException @@ -40,7 +40,7 @@ - diff --git a/reference/solr/solrmodifiableparams.xml b/reference/solr/solrmodifiableparams.xml index 4288151ba..00f869f38 100644 --- a/reference/solr/solrmodifiableparams.xml +++ b/reference/solr/solrmodifiableparams.xml @@ -11,9 +11,9 @@
    &reftitle.intro; - + Represents a collection of name-value pairs sent to the Solr server during a request. - +
    @@ -29,22 +29,22 @@ SolrModifiableParams - + extends SolrParams - + Serializable - + &Methods; - + &InheritedMethods; diff --git a/reference/solr/solrmodifiableparams/construct.xml b/reference/solr/solrmodifiableparams/construct.xml index c4c1f164b..12f55eecf 100644 --- a/reference/solr/solrmodifiableparams/construct.xml +++ b/reference/solr/solrmodifiableparams/construct.xml @@ -13,9 +13,9 @@ public SolrModifiableParams::__construct - + Constructor - +     @@ -26,9 +26,9 @@ &reftitle.returnvalues; - + None - + diff --git a/reference/solr/solrmodifiableparams/destruct.xml b/reference/solr/solrmodifiableparams/destruct.xml index 60f318193..ef442bec2 100644 --- a/reference/solr/solrmodifiableparams/destruct.xml +++ b/reference/solr/solrmodifiableparams/destruct.xml @@ -13,9 +13,9 @@ public SolrModifiableParams::__destruct - + Destructor - + @@ -26,9 +26,9 @@ &reftitle.returnvalues; - + None - + diff --git a/reference/solr/solrobject.xml b/reference/solr/solrobject.xml index 1b348965c..8f22f9895 100644 --- a/reference/solr/solrobject.xml +++ b/reference/solr/solrobject.xml @@ -11,9 +11,9 @@
    &reftitle.intro; - + This is an object whose properties can also by accessed using the array syntax. All its properties are read-only. - +
    @@ -30,13 +30,13 @@ final SolrObject - + ArrayAccess - + &Methods; diff --git a/reference/solr/solrobject/construct.xml b/reference/solr/solrobject/construct.xml index 19ddfd32e..289d9371f 100644 --- a/reference/solr/solrobject/construct.xml +++ b/reference/solr/solrobject/construct.xml @@ -13,9 +13,9 @@ public SolrObject::__construct - + Creates Solr object. - + @@ -26,9 +26,9 @@ &reftitle.returnvalues; - + None - + diff --git a/reference/solr/solrobject/destruct.xml b/reference/solr/solrobject/destruct.xml index 2c9ac1401..f9599a772 100644 --- a/reference/solr/solrobject/destruct.xml +++ b/reference/solr/solrobject/destruct.xml @@ -13,9 +13,9 @@ public SolrObject::__destruct - + The destructor - + @@ -26,9 +26,9 @@ &reftitle.returnvalues; - + None. - + diff --git a/reference/solr/solrobject/getpropertynames.xml b/reference/solr/solrobject/getpropertynames.xml index 0d165fd26..3d1b22f1f 100644 --- a/reference/solr/solrobject/getpropertynames.xml +++ b/reference/solr/solrobject/getpropertynames.xml @@ -13,9 +13,9 @@ public arraySolrObject::getPropertyNames - + Returns an array of all the names of the properties - + @@ -26,9 +26,9 @@ &reftitle.returnvalues; - + Returns an array. - + diff --git a/reference/solr/solrobject/offsetexists.xml b/reference/solr/solrobject/offsetexists.xml index c33bfd1e3..5281ecb62 100644 --- a/reference/solr/solrobject/offsetexists.xml +++ b/reference/solr/solrobject/offsetexists.xml @@ -13,9 +13,9 @@ public boolSolrObject::offsetExists stringproperty_name - + Checks if the property exists. This is used when the object is treated as an array. - + @@ -26,9 +26,9 @@ property_name - + The name of the property. - + @@ -37,9 +37,9 @@ &reftitle.returnvalues; - + &return.success; - + diff --git a/reference/solr/solrobject/offsetget.xml b/reference/solr/solrobject/offsetget.xml index b33b07b75..4654656e5 100644 --- a/reference/solr/solrobject/offsetget.xml +++ b/reference/solr/solrobject/offsetget.xml @@ -13,9 +13,9 @@ public mixedSolrObject::offsetGet stringproperty_name - + Used to get the value of a property. This is used when the object is treated as an array. - + @@ -25,9 +25,9 @@ property_name - + Name of the property. - + @@ -36,9 +36,9 @@ &reftitle.returnvalues; - + Returns the property value. - + diff --git a/reference/solr/solrobject/offsetset.xml b/reference/solr/solrobject/offsetset.xml index afeecfbb8..5061a6bb7 100644 --- a/reference/solr/solrobject/offsetset.xml +++ b/reference/solr/solrobject/offsetset.xml @@ -14,9 +14,9 @@ stringproperty_name stringproperty_value - + Sets the value for a property. This is used when the object is treated as an array. This object is read-only. This should never be attempted. - + @@ -27,17 +27,17 @@ property_name - + The name of the property. - + property_value - + The new value. - + @@ -46,9 +46,9 @@ &reftitle.returnvalues; - + None. - + diff --git a/reference/solr/solrobject/offsetunset.xml b/reference/solr/solrobject/offsetunset.xml index 7c842b867..3784ac4af 100644 --- a/reference/solr/solrobject/offsetunset.xml +++ b/reference/solr/solrobject/offsetunset.xml @@ -13,9 +13,9 @@ public voidSolrObject::offsetUnset stringproperty_name - + Unsets the value for the property. This is used when the object is treated as an array. This object is read-only. This should never be attempted. - + @@ -26,9 +26,9 @@ property_name - + The name of the property. - + @@ -37,9 +37,9 @@ &reftitle.returnvalues; - + &return.success; - + diff --git a/reference/solr/solrparams.xml b/reference/solr/solrparams.xml index c8a84f1f6..6dbef5ae5 100644 --- a/reference/solr/solrparams.xml +++ b/reference/solr/solrparams.xml @@ -11,9 +11,9 @@
    &reftitle.intro; - + Represents a collection of name-value pairs sent to the Solr server during a request. - +
    @@ -30,14 +30,14 @@ abstract SolrParams - + Serializable - + &Methods; diff --git a/reference/solr/solrparams/add.xml b/reference/solr/solrparams/add.xml index da7cab6fb..9372d1fa0 100644 --- a/reference/solr/solrparams/add.xml +++ b/reference/solr/solrparams/add.xml @@ -14,9 +14,9 @@ stringname stringvalue - + This is an alias for SolrParams::addParam - +     @@ -27,17 +27,17 @@ name - + The name of the parameter - + value - - The value of the parameter - + + The value of the parameter + @@ -46,9 +46,9 @@ &reftitle.returnvalues; - + Returns a SolrParams instance on success - + diff --git a/reference/solr/solrparams/addparam.xml b/reference/solr/solrparams/addparam.xml index 53d74b3fd..c3fcb2c59 100644 --- a/reference/solr/solrparams/addparam.xml +++ b/reference/solr/solrparams/addparam.xml @@ -14,9 +14,9 @@ stringname stringvalue - + Adds a parameter to the object. This is used for parameters that can be specified multiple times. - + @@ -26,17 +26,17 @@ name - + Name of parameter - + value - + Value of parameter - + @@ -45,9 +45,9 @@ &reftitle.returnvalues; - + Returns a SolrParam object on success and &false; on failure. - + diff --git a/reference/solr/solrparams/get.xml b/reference/solr/solrparams/get.xml index f7d12d45d..ccedc5937 100644 --- a/reference/solr/solrparams/get.xml +++ b/reference/solr/solrparams/get.xml @@ -13,9 +13,9 @@ final public mixedSolrParams::get stringparam_name - + This is an alias for SolrParams::getParam - + @@ -26,9 +26,9 @@ param_name - + Then name of the parameter - + @@ -37,9 +37,9 @@ &reftitle.returnvalues; - + Returns an array or string depending on the type of parameter - + diff --git a/reference/solr/solrparams/getparam.xml b/reference/solr/solrparams/getparam.xml index d1ed755cb..15ab3adda 100644 --- a/reference/solr/solrparams/getparam.xml +++ b/reference/solr/solrparams/getparam.xml @@ -13,10 +13,10 @@ final public mixedSolrParams::getParam stringparam_name - + Returns a parameter with name param_name. - - + + @@ -26,9 +26,9 @@ param_name - + The name of the parameter. - + @@ -37,9 +37,9 @@ &reftitle.returnvalues; - + Returns a &string; or an &array; depending on the type of the parameter. - + diff --git a/reference/solr/solrparams/getparams.xml b/reference/solr/solrparams/getparams.xml index 1d2295e07..511510bc0 100644 --- a/reference/solr/solrparams/getparams.xml +++ b/reference/solr/solrparams/getparams.xml @@ -13,9 +13,9 @@ final public arraySolrParams::getParams - + Returns an array of non URL-encoded parameters - + @@ -26,9 +26,9 @@ &reftitle.returnvalues; - + Returns an array of non URL-encoded parameters - + diff --git a/reference/solr/solrparams/getpreparedparams.xml b/reference/solr/solrparams/getpreparedparams.xml index f38f9c8ea..be4cf0c01 100644 --- a/reference/solr/solrparams/getpreparedparams.xml +++ b/reference/solr/solrparams/getpreparedparams.xml @@ -13,9 +13,9 @@ final public arraySolrParams::getPreparedParams - + Returns an array on URL-encoded parameters - + @@ -26,9 +26,9 @@ &reftitle.returnvalues; - + Returns an array on URL-encoded parameters - + diff --git a/reference/solr/solrparams/serialize.xml b/reference/solr/solrparams/serialize.xml index e6d193bd6..c207bf0c8 100644 --- a/reference/solr/solrparams/serialize.xml +++ b/reference/solr/solrparams/serialize.xml @@ -13,9 +13,9 @@ final public stringSolrParams::serialize - + Used for custom serialization - + @@ -25,9 +25,9 @@ &reftitle.returnvalues; - + Used for custom serialization - + diff --git a/reference/solr/solrparams/set.xml b/reference/solr/solrparams/set.xml index ee22bd40c..6d7b8a526 100644 --- a/reference/solr/solrparams/set.xml +++ b/reference/solr/solrparams/set.xml @@ -14,9 +14,9 @@ stringname stringvalue - + An alias of SolrParams::setParam - + @@ -26,17 +26,17 @@ name - + Then name of the parameter - + value - + The parameter value - + @@ -45,9 +45,9 @@ &reftitle.returnvalues; - + Returns an instance of the SolrParams object on success - + diff --git a/reference/solr/solrparams/setparam.xml b/reference/solr/solrparams/setparam.xml index 14ba4203f..6868e8adc 100644 --- a/reference/solr/solrparams/setparam.xml +++ b/reference/solr/solrparams/setparam.xml @@ -14,9 +14,9 @@ stringname stringvalue - + Sets the query parameter to the specified value. This is used for parameters that can only be specified once. Subsequent calls with the same parameter name will override the existing value - + @@ -27,17 +27,17 @@ name - + Name of the parameter - + value - + Value of the parameter - + @@ -46,9 +46,9 @@ &reftitle.returnvalues; - + Returns a SolrParam object on success and &false; on value. - + diff --git a/reference/solr/solrparams/tostring.xml b/reference/solr/solrparams/tostring.xml index 6e7f2c989..0451e0bb1 100644 --- a/reference/solr/solrparams/tostring.xml +++ b/reference/solr/solrparams/tostring.xml @@ -13,9 +13,9 @@ final public stringSolrParams::toString boolurl_encode&false; - + Returns all the name-value pair parameters in the object - + @@ -26,9 +26,9 @@ url_encode - + Whether to return URL-encoded values - + @@ -37,9 +37,9 @@ &reftitle.returnvalues; - + Returns a string on success and &false; on failure. - + diff --git a/reference/solr/solrparams/unserialize.xml b/reference/solr/solrparams/unserialize.xml index 62b5e6d20..75727df79 100644 --- a/reference/solr/solrparams/unserialize.xml +++ b/reference/solr/solrparams/unserialize.xml @@ -13,9 +13,9 @@ final public voidSolrParams::unserialize stringserialized - + Used for custom serialization - + @@ -25,9 +25,9 @@ serialized - + The serialized representation of the object - + @@ -36,9 +36,9 @@ &reftitle.returnvalues; - + None - + diff --git a/reference/solr/solrpingresponse.xml b/reference/solr/solrpingresponse.xml index d6f277b27..ac2c6d8bc 100644 --- a/reference/solr/solrpingresponse.xml +++ b/reference/solr/solrpingresponse.xml @@ -11,9 +11,9 @@
    &reftitle.intro; - + Represents a response to a ping request to the server - +
    @@ -30,7 +30,7 @@ final SolrPingResponse - + extends SolrResponse @@ -53,12 +53,12 @@ &Properties; - + &Methods; - + &InheritedMethods; @@ -67,7 +67,7 @@
    - +
    &reftitle.properties; @@ -75,68 +75,68 @@ http_status - The http status of the response. + The http status of the response. parser_mode - Whether to parse the solr documents as SolrObject or SolrDocument instances. + Whether to parse the solr documents as SolrObject or SolrDocument instances. success - Was there an error during the request + Was there an error during the request http_status_message - Detailed message on http status + Detailed message on http status http_request_url - The request URL + The request URL http_raw_request_headers - A string of raw headers sent during the request + A string of raw headers sent during the request http_raw_request - The raw request sent to the server + The raw request sent to the server http_raw_response_headers - Response headers from the Solr server + Response headers from the Solr server http_raw_response - The response message from the server + The response message from the server http_digested_response - The response in PHP serialized format. + The response in PHP serialized format.
    - +
    &reftitle.constants; @@ -147,14 +147,14 @@ SolrPingResponse::PARSE_SOLR_OBJ - Documents should be parsed as SolrObject instances + Documents should be parsed as SolrObject instances SolrPingResponse::PARSE_SOLR_DOC - Documents should be parsed as SolrDocument instances. + Documents should be parsed as SolrDocument instances. diff --git a/reference/solr/solrpingresponse/construct.xml b/reference/solr/solrpingresponse/construct.xml index b675465cc..455db64a2 100644 --- a/reference/solr/solrpingresponse/construct.xml +++ b/reference/solr/solrpingresponse/construct.xml @@ -13,11 +13,11 @@ public SolrPingResponse::__construct - + Constructor - + + - @@ -28,9 +28,9 @@ &reftitle.returnvalues; - + None - + diff --git a/reference/solr/solrpingresponse/destruct.xml b/reference/solr/solrpingresponse/destruct.xml index d52c0e201..cfa3955b7 100644 --- a/reference/solr/solrpingresponse/destruct.xml +++ b/reference/solr/solrpingresponse/destruct.xml @@ -13,9 +13,9 @@ public SolrPingResponse::__destruct - + Destructor - + @@ -25,9 +25,9 @@ &reftitle.returnvalues; - + None - + diff --git a/reference/solr/solrpingresponse/getresponse.xml b/reference/solr/solrpingresponse/getresponse.xml index 033dad2a0..4d38b9382 100644 --- a/reference/solr/solrpingresponse/getresponse.xml +++ b/reference/solr/solrpingresponse/getresponse.xml @@ -13,9 +13,9 @@ public stringSolrPingResponse::getResponse - + Returns the response from the server. This should be empty because the request as a HEAD request. - + @@ -26,9 +26,9 @@ &reftitle.returnvalues; - + Returns an empty string. - + diff --git a/reference/solr/solrquery.xml b/reference/solr/solrquery.xml index 0e9c18ed6..e585b7e17 100644 --- a/reference/solr/solrquery.xml +++ b/reference/solr/solrquery.xml @@ -11,9 +11,9 @@
    &reftitle.intro; - + Represents a collection of name-value pairs sent to the Solr server during a request. - +
    @@ -29,12 +29,12 @@ SolrQuery - + extends SolrModifiableParams - + Serializable @@ -80,12 +80,12 @@ &Properties; - + &Methods; - + &InheritedMethods; @@ -95,7 +95,7 @@
    - +
    &reftitle.constants; @@ -104,42 +104,42 @@ SolrQuery::ORDER_ASC - Used to specify that the sorting should be in acending order + Used to specify that the sorting should be in acending order SolrQuery::ORDER_DESC - Used to specify that the sorting should be in descending order + Used to specify that the sorting should be in descending order SolrQuery::FACET_SORT_INDEX - Used to specify that the facet should sort by index + Used to specify that the facet should sort by index SolrQuery::FACET_SORT_COUNT - Used to specify that the facet should sort by count + Used to specify that the facet should sort by count SolrQuery::TERMS_SORT_INDEX - Used in the TermsComponent + Used in the TermsComponent SolrQuery::TERMS_SORT_COUNT - Used in the TermsComponent + Used in the TermsComponent diff --git a/reference/solr/solrquery/addexpandfilterquery.xml b/reference/solr/solrquery/addexpandfilterquery.xml index 59880b876..985815b24 100644 --- a/reference/solr/solrquery/addexpandfilterquery.xml +++ b/reference/solr/solrquery/addexpandfilterquery.xml @@ -13,9 +13,9 @@ public SolrQuerySolrQuery::addExpandFilterQuery stringfq - + Overrides main filter query, determines which documents to include in the main group. - + @@ -25,9 +25,9 @@ fq - - - + + + @@ -35,9 +35,9 @@ &reftitle.returnvalues; - + SolrQuery - + @@ -51,7 +51,7 @@ SolrQuery::removeExpandFilterQuery - +
    &reftitle.intro; - + Represents a response to a query request. - +
    @@ -30,7 +30,7 @@ final SolrQueryResponse - + extends SolrResponse @@ -53,11 +53,11 @@ &InheritedProperties; - + &Methods; - + &InheritedMethods; @@ -66,7 +66,7 @@
    - +
    &reftitle.constants; @@ -77,14 +77,14 @@ SolrQueryResponse::PARSE_SOLR_OBJ - Documents should be parsed as SolrObject instances + Documents should be parsed as SolrObject instances SolrQueryResponse::PARSE_SOLR_DOC - Documents should be parsed as SolrDocument instances. + Documents should be parsed as SolrDocument instances. diff --git a/reference/solr/solrqueryresponse/construct.xml b/reference/solr/solrqueryresponse/construct.xml index ff97d7a5d..070af130f 100644 --- a/reference/solr/solrqueryresponse/construct.xml +++ b/reference/solr/solrqueryresponse/construct.xml @@ -13,9 +13,9 @@ public SolrQueryResponse::__construct - + Constructor - + @@ -25,9 +25,9 @@ &reftitle.returnvalues; - + None - + diff --git a/reference/solr/solrqueryresponse/destruct.xml b/reference/solr/solrqueryresponse/destruct.xml index e0e0509fd..2c3b296c8 100644 --- a/reference/solr/solrqueryresponse/destruct.xml +++ b/reference/solr/solrqueryresponse/destruct.xml @@ -13,9 +13,9 @@ public SolrQueryResponse::__destruct - + Destructor. - + @@ -26,9 +26,9 @@ &reftitle.returnvalues; - + None - + diff --git a/reference/solr/solrresponse.xml b/reference/solr/solrresponse.xml index 6fe3b8acd..3fbd19160 100644 --- a/reference/solr/solrresponse.xml +++ b/reference/solr/solrresponse.xml @@ -11,9 +11,9 @@
    &reftitle.intro; - + Represents a response from the Solr server. - +
    @@ -98,7 +98,7 @@ http_digested_response - + &Methods; @@ -106,7 +106,7 @@
    - +
    &reftitle.properties; @@ -114,68 +114,68 @@ http_status - The http status of the response. + The http status of the response. parser_mode - Whether to parse the solr documents as SolrObject or SolrDocument instances. + Whether to parse the solr documents as SolrObject or SolrDocument instances. success - Was there an error during the request + Was there an error during the request http_status_message - Detailed message on http status + Detailed message on http status http_request_url - The request URL + The request URL http_raw_request_headers - A string of raw headers sent during the request. + A string of raw headers sent during the request. http_raw_request - The raw request sent to the server + The raw request sent to the server http_raw_response_headers - Response headers from the Solr server. + Response headers from the Solr server. http_raw_response - The response message from the server. + The response message from the server. http_digested_response - The response in PHP serialized format. + The response in PHP serialized format.
    - +
    &reftitle.constants; @@ -186,14 +186,14 @@ SolrResponse::PARSE_SOLR_OBJ - Documents should be parsed as SolrObject instances + Documents should be parsed as SolrObject instances SolrResponse::PARSE_SOLR_DOC - Documents should be parsed as SolrDocument instances. + Documents should be parsed as SolrDocument instances. diff --git a/reference/solr/solrresponse/getdigestedresponse.xml b/reference/solr/solrresponse/getdigestedresponse.xml index 841b3ea60..f3c7e403b 100644 --- a/reference/solr/solrresponse/getdigestedresponse.xml +++ b/reference/solr/solrresponse/getdigestedresponse.xml @@ -13,9 +13,9 @@ public stringSolrResponse::getDigestedResponse - + Returns the XML response as serialized PHP data - + @@ -25,9 +25,9 @@ &reftitle.returnvalues; - + Returns the XML response as serialized PHP data - + diff --git a/reference/solr/solrresponse/gethttpstatus.xml b/reference/solr/solrresponse/gethttpstatus.xml index beb79495e..7e5e20c7d 100644 --- a/reference/solr/solrresponse/gethttpstatus.xml +++ b/reference/solr/solrresponse/gethttpstatus.xml @@ -13,9 +13,9 @@ public intSolrResponse::getHttpStatus - + Returns the HTTP status of the response. - + @@ -26,9 +26,9 @@ &reftitle.returnvalues; - + Returns the HTTP status of the response. - + diff --git a/reference/solr/solrresponse/gethttpstatusmessage.xml b/reference/solr/solrresponse/gethttpstatusmessage.xml index 0df1f0c36..c317261ba 100644 --- a/reference/solr/solrresponse/gethttpstatusmessage.xml +++ b/reference/solr/solrresponse/gethttpstatusmessage.xml @@ -13,9 +13,9 @@ public stringSolrResponse::getHttpStatusMessage - + Returns more details on the HTTP status. - + @@ -26,9 +26,9 @@ &reftitle.returnvalues; - + Returns more details on the HTTP status - + diff --git a/reference/solr/solrresponse/getrawrequest.xml b/reference/solr/solrresponse/getrawrequest.xml index 81d46b240..5e7994970 100644 --- a/reference/solr/solrresponse/getrawrequest.xml +++ b/reference/solr/solrresponse/getrawrequest.xml @@ -13,9 +13,9 @@ public stringSolrResponse::getRawRequest - + Returns the raw request sent to the Solr server. - + @@ -26,9 +26,9 @@ &reftitle.returnvalues; - + Returns the raw request sent to the Solr server - + diff --git a/reference/solr/solrresponse/getrawrequestheaders.xml b/reference/solr/solrresponse/getrawrequestheaders.xml index 68c820d04..585863b46 100644 --- a/reference/solr/solrresponse/getrawrequestheaders.xml +++ b/reference/solr/solrresponse/getrawrequestheaders.xml @@ -13,9 +13,9 @@ public stringSolrResponse::getRawRequestHeaders - + Returns the raw request headers sent to the Solr server. - + @@ -26,9 +26,9 @@ &reftitle.returnvalues; - + Returns the raw request headers sent to the Solr server - + diff --git a/reference/solr/solrresponse/getrawresponse.xml b/reference/solr/solrresponse/getrawresponse.xml index 9ab10de29..cb66720c7 100644 --- a/reference/solr/solrresponse/getrawresponse.xml +++ b/reference/solr/solrresponse/getrawresponse.xml @@ -13,9 +13,9 @@ public stringSolrResponse::getRawResponse - + Returns the raw response from the server. - + @@ -26,9 +26,9 @@ &reftitle.returnvalues; - + Returns the raw response from the server. - + diff --git a/reference/solr/solrresponse/getrawresponseheaders.xml b/reference/solr/solrresponse/getrawresponseheaders.xml index 59a59d11a..5d66b5cfb 100644 --- a/reference/solr/solrresponse/getrawresponseheaders.xml +++ b/reference/solr/solrresponse/getrawresponseheaders.xml @@ -13,9 +13,9 @@ public stringSolrResponse::getRawResponseHeaders - + Returns the raw response headers from the server. - + @@ -26,9 +26,9 @@ &reftitle.returnvalues; - + Returns the raw response headers from the server. - + diff --git a/reference/solr/solrresponse/getrequesturl.xml b/reference/solr/solrresponse/getrequesturl.xml index 7d4973697..670e604f2 100644 --- a/reference/solr/solrresponse/getrequesturl.xml +++ b/reference/solr/solrresponse/getrequesturl.xml @@ -13,9 +13,9 @@ public stringSolrResponse::getRequestUrl - + Returns the full URL the request was sent to. - + @@ -25,9 +25,9 @@ &reftitle.returnvalues; - + Returns the full URL the request was sent to - + diff --git a/reference/solr/solrresponse/getresponse.xml b/reference/solr/solrresponse/getresponse.xml index d5b634d98..f10c5b4b9 100644 --- a/reference/solr/solrresponse/getresponse.xml +++ b/reference/solr/solrresponse/getresponse.xml @@ -13,9 +13,9 @@ public SolrObjectSolrResponse::getResponse - + Returns a SolrObject representing the XML response from the server. - + @@ -25,9 +25,9 @@ &reftitle.returnvalues; - + Returns a SolrObject representing the XML response from the server - + diff --git a/reference/solr/solrresponse/setparsemode.xml b/reference/solr/solrresponse/setparsemode.xml index 7f512a768..239f09dba 100644 --- a/reference/solr/solrresponse/setparsemode.xml +++ b/reference/solr/solrresponse/setparsemode.xml @@ -13,9 +13,9 @@ public boolSolrResponse::setParseMode intparser_mode0 - + Sets the parse mode. - + @@ -26,9 +26,9 @@ parser_mode - + SolrResponse::PARSE_SOLR_DOC parses documents in SolrDocument instances. SolrResponse::PARSE_SOLR_OBJ parses document into SolrObjects. - + @@ -37,9 +37,9 @@ &reftitle.returnvalues; - + &return.success; - + diff --git a/reference/solr/solrresponse/success.xml b/reference/solr/solrresponse/success.xml index 729d71e32..0b5c324db 100644 --- a/reference/solr/solrresponse/success.xml +++ b/reference/solr/solrresponse/success.xml @@ -13,9 +13,9 @@ public boolSolrResponse::success - + Used to check if the request to the server was successful. - + @@ -26,9 +26,9 @@ &reftitle.returnvalues; - + Returns &true; if it was successful and &false; if it was not. - + diff --git a/reference/solr/solrserverexception.xml b/reference/solr/solrserverexception.xml index d587393e9..37f6ab215 100644 --- a/reference/solr/solrserverexception.xml +++ b/reference/solr/solrserverexception.xml @@ -11,9 +11,9 @@
    &reftitle.intro; - + An exception thrown when there is an error produced by the Solr Server itself. - +
    @@ -29,21 +29,21 @@ SolrServerException - + extends SolrException - + &InheritedProperties; &Methods; - + &InheritedMethods; @@ -53,7 +53,7 @@
    - + &reference.solr.entities.solrserverexception; diff --git a/reference/solr/solrserverexception/getinternalinfo.xml b/reference/solr/solrserverexception/getinternalinfo.xml index e6e4130da..e18473554 100644 --- a/reference/solr/solrserverexception/getinternalinfo.xml +++ b/reference/solr/solrserverexception/getinternalinfo.xml @@ -13,9 +13,9 @@ public arraySolrServerException::getInternalInfo - + Returns internal information where the Exception was thrown. - + @@ -26,9 +26,9 @@ &reftitle.returnvalues; - + Returns an array containing internal information where the error was thrown. Used only for debugging by extension developers. - +     diff --git a/reference/solr/solrupdateresponse.xml b/reference/solr/solrupdateresponse.xml index 5611caa99..c88317a04 100644 --- a/reference/solr/solrupdateresponse.xml +++ b/reference/solr/solrupdateresponse.xml @@ -11,9 +11,9 @@
    &reftitle.intro; - + Represents a response to an update request. - +
    @@ -30,7 +30,7 @@ final SolrUpdateResponse - + extends SolrResponse @@ -53,11 +53,11 @@ &InheritedProperties; - + &Methods; - + &InheritedMethods; @@ -66,7 +66,7 @@ - +
    &reftitle.constants; @@ -77,14 +77,14 @@ SolrUpdateResponse::PARSE_SOLR_OBJ - Documents should be parsed as SolrObject instances + Documents should be parsed as SolrObject instances SolrUpdateResponse::PARSE_SOLR_DOC - Documents should be parsed as SolrDocument instances. + Documents should be parsed as SolrDocument instances. diff --git a/reference/solr/solrupdateresponse/construct.xml b/reference/solr/solrupdateresponse/construct.xml index 9a148cad3..e4cfb92f3 100644 --- a/reference/solr/solrupdateresponse/construct.xml +++ b/reference/solr/solrupdateresponse/construct.xml @@ -13,9 +13,9 @@ public SolrUpdateResponse::__construct - + Constructor - + @@ -26,9 +26,9 @@ &reftitle.returnvalues; - + None - + diff --git a/reference/solr/solrupdateresponse/destruct.xml b/reference/solr/solrupdateresponse/destruct.xml index a0bf1ce4a..ff89dbe46 100644 --- a/reference/solr/solrupdateresponse/destruct.xml +++ b/reference/solr/solrupdateresponse/destruct.xml @@ -13,11 +13,11 @@ public SolrUpdateResponse::__destruct - + Destructor - + + - @@ -28,9 +28,9 @@ &reftitle.returnvalues; - + None - + diff --git a/reference/solr/solrutils.xml b/reference/solr/solrutils.xml index 7e08be2de..b5409e2c2 100644 --- a/reference/solr/solrutils.xml +++ b/reference/solr/solrutils.xml @@ -11,10 +11,10 @@
    &reftitle.intro; - + Contains utility methods for retrieving the current extension version and preparing query phrases. - - Also contains method for escaping query strings and parsing XML responses. + + Also contains method for escaping query strings and parsing XML responses.
    @@ -33,7 +33,7 @@ - + &Methods; diff --git a/reference/solr/solrutils/digestxmlresponse.xml b/reference/solr/solrutils/digestxmlresponse.xml index 3c0e797d8..d82a92090 100644 --- a/reference/solr/solrutils/digestxmlresponse.xml +++ b/reference/solr/solrutils/digestxmlresponse.xml @@ -14,9 +14,9 @@ stringxmlresponse intparse_mode0 - + This method parses an response XML string from the Apache Solr server into a SolrObject. It throws a SolrException if there was an error. - + @@ -27,17 +27,17 @@ xmlresponse - + The XML response string from the Solr server. - + parse_mode - + Use SolrResponse::PARSE_SOLR_OBJ or SolrResponse::PARSE_SOLR_DOC - + @@ -46,14 +46,14 @@ &reftitle.returnvalues; - + Returns the SolrObject representing the XML response. - - - If the parse_mode parameter is set to SolrResponse::PARSE_SOLR_OBJ Solr documents will be parses as SolrObject instances. - - If it is set to SolrResponse::PARSE_SOLR_DOC, they will be parsed as SolrDocument instances. - + + + If the parse_mode parameter is set to SolrResponse::PARSE_SOLR_OBJ Solr documents will be parses as SolrObject instances. + + If it is set to SolrResponse::PARSE_SOLR_DOC, they will be parsed as SolrDocument instances. + diff --git a/reference/solr/solrutils/escapequerychars.xml b/reference/solr/solrutils/escapequerychars.xml index 854c93ad6..1234e0b26 100644 --- a/reference/solr/solrutils/escapequerychars.xml +++ b/reference/solr/solrutils/escapequerychars.xml @@ -13,18 +13,18 @@ public static stringfalseSolrUtils::escapeQueryChars stringstr - + Lucene supports escaping special characters that are part of the query syntax. - + - The current list special characters are: - + The current list special characters are: + - These characters are part of the query syntax and must be escaped + +]]> + These characters are part of the query syntax and must be escaped @@ -35,9 +35,9 @@ str - + This is the query string to be escaped. - + @@ -46,9 +46,9 @@ &reftitle.returnvalues; - + Returns the escaped string&return.falseforfailure;. - + diff --git a/reference/solr/solrutils/getsolrversion.xml b/reference/solr/solrutils/getsolrversion.xml index 56295f2a1..328c2f93f 100644 --- a/reference/solr/solrutils/getsolrversion.xml +++ b/reference/solr/solrutils/getsolrversion.xml @@ -13,9 +13,9 @@ public static stringSolrUtils::getSolrVersion - + Returns the current Solr version. - + @@ -26,9 +26,9 @@ &reftitle.returnvalues; - + The current version of the Apache Solr extension. - + diff --git a/reference/solr/solrutils/queryphrase.xml b/reference/solr/solrutils/queryphrase.xml index ae8715e1a..6c3149dcd 100644 --- a/reference/solr/solrutils/queryphrase.xml +++ b/reference/solr/solrutils/queryphrase.xml @@ -13,9 +13,9 @@ public static stringSolrUtils::queryPhrase stringstr - + Prepares a phrase from an unescaped lucene string. - + @@ -26,9 +26,9 @@ str - + The lucene phrase. - + @@ -37,9 +37,9 @@ &reftitle.returnvalues; - + Returns the phrase contained in double quotes. - + diff --git a/reference/sqlsrv/book.xml b/reference/sqlsrv/book.xml index e21045332..16705300c 100644 --- a/reference/sqlsrv/book.xml +++ b/reference/sqlsrv/book.xml @@ -1,6 +1,6 @@ - + Microsoft SQL Server Driver for PHP SQLSRV diff --git a/reference/sqlsrv/configure.xml b/reference/sqlsrv/configure.xml index 3b2910e48..843d2ba5a 100644 --- a/reference/sqlsrv/configure.xml +++ b/reference/sqlsrv/configure.xml @@ -1,6 +1,6 @@ -
    +
    &reftitle.install; The SQLSRV extension is enabled by adding appropriate DLL file to your PHP diff --git a/reference/sqlsrv/functions/sqlsrv-begin-transaction.xml b/reference/sqlsrv/functions/sqlsrv-begin-transaction.xml index 93a458acc..550c9a257 100644 --- a/reference/sqlsrv/functions/sqlsrv-begin-transaction.xml +++ b/reference/sqlsrv/functions/sqlsrv-begin-transaction.xml @@ -1,6 +1,6 @@ - + sqlsrv_begin_transaction Begins a database transaction diff --git a/reference/sqlsrv/functions/sqlsrv-cancel.xml b/reference/sqlsrv/functions/sqlsrv-cancel.xml index b7552aae2..87015f287 100644 --- a/reference/sqlsrv/functions/sqlsrv-cancel.xml +++ b/reference/sqlsrv/functions/sqlsrv-cancel.xml @@ -1,6 +1,6 @@ - + sqlsrv_cancel Cancels a statement diff --git a/reference/sqlsrv/functions/sqlsrv-client-info.xml b/reference/sqlsrv/functions/sqlsrv-client-info.xml index de8d04037..e301a5edf 100644 --- a/reference/sqlsrv/functions/sqlsrv-client-info.xml +++ b/reference/sqlsrv/functions/sqlsrv-client-info.xml @@ -1,6 +1,6 @@ - + sqlsrv_client_info Returns information about the client and specified connection diff --git a/reference/sqlsrv/functions/sqlsrv-commit.xml b/reference/sqlsrv/functions/sqlsrv-commit.xml index 2d79896aa..f255c3afb 100644 --- a/reference/sqlsrv/functions/sqlsrv-commit.xml +++ b/reference/sqlsrv/functions/sqlsrv-commit.xml @@ -1,6 +1,6 @@ - + sqlsrv_commit Commits a transaction that was begun with sqlsrv_begin_transaction diff --git a/reference/sqlsrv/functions/sqlsrv-configure.xml b/reference/sqlsrv/functions/sqlsrv-configure.xml index d6ae7acf7..bde6b55e0 100644 --- a/reference/sqlsrv/functions/sqlsrv-configure.xml +++ b/reference/sqlsrv/functions/sqlsrv-configure.xml @@ -1,6 +1,6 @@ - + sqlsrv_configure Changes the driver error handling and logging configurations diff --git a/reference/sqlsrv/functions/sqlsrv-connect.xml b/reference/sqlsrv/functions/sqlsrv-connect.xml index f0cb13fc7..2dd7d58ae 100644 --- a/reference/sqlsrv/functions/sqlsrv-connect.xml +++ b/reference/sqlsrv/functions/sqlsrv-connect.xml @@ -1,6 +1,6 @@ - + sqlsrv_connect Opens a connection to a Microsoft SQL Server database diff --git a/reference/sqlsrv/functions/sqlsrv-errors.xml b/reference/sqlsrv/functions/sqlsrv-errors.xml index f3a5b390b..067751e19 100644 --- a/reference/sqlsrv/functions/sqlsrv-errors.xml +++ b/reference/sqlsrv/functions/sqlsrv-errors.xml @@ -1,6 +1,6 @@ - + sqlsrv_errors Returns error and warning information about the last SQLSRV operation performed diff --git a/reference/sqlsrv/functions/sqlsrv-execute.xml b/reference/sqlsrv/functions/sqlsrv-execute.xml index 18e33dc8b..3ec9c42f5 100644 --- a/reference/sqlsrv/functions/sqlsrv-execute.xml +++ b/reference/sqlsrv/functions/sqlsrv-execute.xml @@ -1,6 +1,6 @@ - + sqlsrv_execute Executes a statement prepared with sqlsrv_prepare diff --git a/reference/sqlsrv/functions/sqlsrv-fetch-array.xml b/reference/sqlsrv/functions/sqlsrv-fetch-array.xml index b727a40f4..7517120c4 100644 --- a/reference/sqlsrv/functions/sqlsrv-fetch-array.xml +++ b/reference/sqlsrv/functions/sqlsrv-fetch-array.xml @@ -1,6 +1,6 @@ - + sqlsrv_fetch_array Returns a row as an array diff --git a/reference/sqlsrv/functions/sqlsrv-fetch-object.xml b/reference/sqlsrv/functions/sqlsrv-fetch-object.xml index 6d9e375a0..b8b923847 100644 --- a/reference/sqlsrv/functions/sqlsrv-fetch-object.xml +++ b/reference/sqlsrv/functions/sqlsrv-fetch-object.xml @@ -1,6 +1,6 @@ - + sqlsrv_fetch_object Retrieves the next row of data in a result set as an object diff --git a/reference/sqlsrv/functions/sqlsrv-fetch.xml b/reference/sqlsrv/functions/sqlsrv-fetch.xml index 14a9c3610..7395a13dc 100644 --- a/reference/sqlsrv/functions/sqlsrv-fetch.xml +++ b/reference/sqlsrv/functions/sqlsrv-fetch.xml @@ -1,6 +1,6 @@ - + sqlsrv_fetch Makes the next row in a result set available for reading diff --git a/reference/sqlsrv/functions/sqlsrv-field-metadata.xml b/reference/sqlsrv/functions/sqlsrv-field-metadata.xml index 8b3d7c06c..2791452c2 100644 --- a/reference/sqlsrv/functions/sqlsrv-field-metadata.xml +++ b/reference/sqlsrv/functions/sqlsrv-field-metadata.xml @@ -1,6 +1,6 @@ - + sqlsrv_field_metadata Retrieves metadata for the fields of a statement prepared by diff --git a/reference/sqlsrv/functions/sqlsrv-free-stmt.xml b/reference/sqlsrv/functions/sqlsrv-free-stmt.xml index a4232d0ee..707dd6e9b 100644 --- a/reference/sqlsrv/functions/sqlsrv-free-stmt.xml +++ b/reference/sqlsrv/functions/sqlsrv-free-stmt.xml @@ -1,6 +1,6 @@ - + sqlsrv_free_stmt Frees all resources for the specified statement diff --git a/reference/sqlsrv/functions/sqlsrv-get-config.xml b/reference/sqlsrv/functions/sqlsrv-get-config.xml index 674922673..196382e22 100644 --- a/reference/sqlsrv/functions/sqlsrv-get-config.xml +++ b/reference/sqlsrv/functions/sqlsrv-get-config.xml @@ -1,6 +1,6 @@ - + sqlsrv_get_config Returns the value of the specified configuration setting diff --git a/reference/sqlsrv/functions/sqlsrv-get-field.xml b/reference/sqlsrv/functions/sqlsrv-get-field.xml index 031f24c52..e89bd8d8a 100644 --- a/reference/sqlsrv/functions/sqlsrv-get-field.xml +++ b/reference/sqlsrv/functions/sqlsrv-get-field.xml @@ -1,6 +1,6 @@ - + sqlsrv_get_field Gets field data from the currently selected row diff --git a/reference/sqlsrv/functions/sqlsrv-has-rows.xml b/reference/sqlsrv/functions/sqlsrv-has-rows.xml index 8d70d0b6e..0973d0b87 100644 --- a/reference/sqlsrv/functions/sqlsrv-has-rows.xml +++ b/reference/sqlsrv/functions/sqlsrv-has-rows.xml @@ -1,6 +1,6 @@ - + sqlsrv_has_rows Indicates whether the specified statement has rows diff --git a/reference/sqlsrv/functions/sqlsrv-next-result.xml b/reference/sqlsrv/functions/sqlsrv-next-result.xml index 8964f6194..51fbe8727 100644 --- a/reference/sqlsrv/functions/sqlsrv-next-result.xml +++ b/reference/sqlsrv/functions/sqlsrv-next-result.xml @@ -1,6 +1,6 @@ - + sqlsrv_next_result Makes the next result of the specified statement active diff --git a/reference/sqlsrv/functions/sqlsrv-num-fields.xml b/reference/sqlsrv/functions/sqlsrv-num-fields.xml index e66ce8043..03ddeb9d4 100644 --- a/reference/sqlsrv/functions/sqlsrv-num-fields.xml +++ b/reference/sqlsrv/functions/sqlsrv-num-fields.xml @@ -1,6 +1,6 @@ - + sqlsrv_num_fields Retrieves the number of fields (columns) on a statement diff --git a/reference/sqlsrv/functions/sqlsrv-prepare.xml b/reference/sqlsrv/functions/sqlsrv-prepare.xml index d42cd8f47..0fe6b40d7 100644 --- a/reference/sqlsrv/functions/sqlsrv-prepare.xml +++ b/reference/sqlsrv/functions/sqlsrv-prepare.xml @@ -1,6 +1,6 @@ - + sqlsrv_prepare Prepares a query for execution diff --git a/reference/sqlsrv/functions/sqlsrv-query.xml b/reference/sqlsrv/functions/sqlsrv-query.xml index 113e740df..242670938 100644 --- a/reference/sqlsrv/functions/sqlsrv-query.xml +++ b/reference/sqlsrv/functions/sqlsrv-query.xml @@ -1,6 +1,6 @@ - + sqlsrv_query Prepares and executes a query diff --git a/reference/sqlsrv/functions/sqlsrv-rollback.xml b/reference/sqlsrv/functions/sqlsrv-rollback.xml index 1bcf2fd0b..ce93d6a78 100644 --- a/reference/sqlsrv/functions/sqlsrv-rollback.xml +++ b/reference/sqlsrv/functions/sqlsrv-rollback.xml @@ -1,6 +1,6 @@ - + sqlsrv_rollback Rolls back a transaction that was begun with diff --git a/reference/sqlsrv/functions/sqlsrv-rows-affected.xml b/reference/sqlsrv/functions/sqlsrv-rows-affected.xml index fd42ec1fe..5e4d79a10 100644 --- a/reference/sqlsrv/functions/sqlsrv-rows-affected.xml +++ b/reference/sqlsrv/functions/sqlsrv-rows-affected.xml @@ -1,6 +1,6 @@ - + sqlsrv_rows_affected Returns the number of rows modified by the last INSERT, UPDATE, or diff --git a/reference/sqlsrv/functions/sqlsrv-send-stream-data.xml b/reference/sqlsrv/functions/sqlsrv-send-stream-data.xml index 19b78c7d1..30c4e2dd8 100644 --- a/reference/sqlsrv/functions/sqlsrv-send-stream-data.xml +++ b/reference/sqlsrv/functions/sqlsrv-send-stream-data.xml @@ -1,6 +1,6 @@ - + sqlsrv_send_stream_data Sends data from parameter streams to the server diff --git a/reference/sqlsrv/functions/sqlsrv-server-info.xml b/reference/sqlsrv/functions/sqlsrv-server-info.xml index 3cded37ca..4937bdc05 100644 --- a/reference/sqlsrv/functions/sqlsrv-server-info.xml +++ b/reference/sqlsrv/functions/sqlsrv-server-info.xml @@ -1,6 +1,6 @@ - + sqlsrv_server_info Returns information about the server diff --git a/reference/sqlsrv/ini.xml b/reference/sqlsrv/ini.xml index d1399f268..2b9538606 100644 --- a/reference/sqlsrv/ini.xml +++ b/reference/sqlsrv/ini.xml @@ -1,6 +1,6 @@ -
    +
    &reftitle.runtime; &extension.runtime; The following table lists the configuration options available in the SQLSRV diff --git a/reference/sqlsrv/setup.xml b/reference/sqlsrv/setup.xml index 802a26873..d38411cad 100644 --- a/reference/sqlsrv/setup.xml +++ b/reference/sqlsrv/setup.xml @@ -1,6 +1,6 @@ - + &reftitle.setup; diff --git a/reference/ssdeep/book.xml b/reference/ssdeep/book.xml index 198cd3fe3..164592d26 100644 --- a/reference/ssdeep/book.xml +++ b/reference/ssdeep/book.xml @@ -1,5 +1,5 @@ - + ssdeep Fuzzy Hashing ssdeep diff --git a/reference/ssdeep/configure.xml b/reference/ssdeep/configure.xml index 3dd67e0c6..777e4fe13 100644 --- a/reference/ssdeep/configure.xml +++ b/reference/ssdeep/configure.xml @@ -1,6 +1,6 @@ -
    +
    &reftitle.install; diff --git a/reference/ssdeep/functions/ssdeep-fuzzy-compare.xml b/reference/ssdeep/functions/ssdeep-fuzzy-compare.xml index 797b2bcac..fea3ce836 100644 --- a/reference/ssdeep/functions/ssdeep-fuzzy-compare.xml +++ b/reference/ssdeep/functions/ssdeep-fuzzy-compare.xml @@ -1,6 +1,6 @@ - + ssdeep_fuzzy_compare Calculates the match score between two fuzzy hash signatures diff --git a/reference/ssdeep/functions/ssdeep-fuzzy-hash-filename.xml b/reference/ssdeep/functions/ssdeep-fuzzy-hash-filename.xml index 7de46bd82..b0d2191b4 100644 --- a/reference/ssdeep/functions/ssdeep-fuzzy-hash-filename.xml +++ b/reference/ssdeep/functions/ssdeep-fuzzy-hash-filename.xml @@ -1,6 +1,6 @@ - + ssdeep_fuzzy_hash_filename Create a fuzzy hash from a file diff --git a/reference/ssdeep/functions/ssdeep-fuzzy-hash.xml b/reference/ssdeep/functions/ssdeep-fuzzy-hash.xml index 4c2aced18..c1904c1b2 100644 --- a/reference/ssdeep/functions/ssdeep-fuzzy-hash.xml +++ b/reference/ssdeep/functions/ssdeep-fuzzy-hash.xml @@ -1,6 +1,6 @@ - + ssdeep_fuzzy_hash Create a fuzzy hash from a string diff --git a/reference/ssdeep/setup.xml b/reference/ssdeep/setup.xml index f1e004cb9..186c63b30 100644 --- a/reference/ssdeep/setup.xml +++ b/reference/ssdeep/setup.xml @@ -1,6 +1,6 @@ - + &reftitle.setup;
    diff --git a/reference/ssh2/book.xml b/reference/ssh2/book.xml index dea838953..08f9b1c35 100644 --- a/reference/ssh2/book.xml +++ b/reference/ssh2/book.xml @@ -1,6 +1,6 @@ - + Secure Shell2 SSH2 diff --git a/reference/ssh2/functions/ssh2-auth-agent.xml b/reference/ssh2/functions/ssh2-auth-agent.xml index fa8e7c166..d56d093eb 100644 --- a/reference/ssh2/functions/ssh2-auth-agent.xml +++ b/reference/ssh2/functions/ssh2-auth-agent.xml @@ -1,6 +1,6 @@ - + ssh2_auth_agent Authenticate over SSH using the ssh agent diff --git a/reference/ssh2/functions/ssh2-auth-hostbased-file.xml b/reference/ssh2/functions/ssh2-auth-hostbased-file.xml index c56743301..65fbd7eb6 100644 --- a/reference/ssh2/functions/ssh2-auth-hostbased-file.xml +++ b/reference/ssh2/functions/ssh2-auth-hostbased-file.xml @@ -1,6 +1,6 @@ - + ssh2_auth_hostbased_file Authenticate using a public hostkey diff --git a/reference/ssh2/functions/ssh2-auth-none.xml b/reference/ssh2/functions/ssh2-auth-none.xml index 153f99c66..cd8200cca 100644 --- a/reference/ssh2/functions/ssh2-auth-none.xml +++ b/reference/ssh2/functions/ssh2-auth-none.xml @@ -1,6 +1,6 @@ - + ssh2_auth_none Authenticate as "none" diff --git a/reference/ssh2/functions/ssh2-auth-password.xml b/reference/ssh2/functions/ssh2-auth-password.xml index 8710f9c90..d42f5ea28 100644 --- a/reference/ssh2/functions/ssh2-auth-password.xml +++ b/reference/ssh2/functions/ssh2-auth-password.xml @@ -1,6 +1,6 @@ - + ssh2_auth_password Authenticate over SSH using a plain password diff --git a/reference/ssh2/functions/ssh2-auth-pubkey-file.xml b/reference/ssh2/functions/ssh2-auth-pubkey-file.xml index 8519a945c..62020e123 100644 --- a/reference/ssh2/functions/ssh2-auth-pubkey-file.xml +++ b/reference/ssh2/functions/ssh2-auth-pubkey-file.xml @@ -1,6 +1,6 @@ - + ssh2_auth_pubkey_file Authenticate using a public key read from a file diff --git a/reference/ssh2/functions/ssh2-auth-pubkey.xml b/reference/ssh2/functions/ssh2-auth-pubkey.xml index a8661f8e3..fad47b213 100644 --- a/reference/ssh2/functions/ssh2-auth-pubkey.xml +++ b/reference/ssh2/functions/ssh2-auth-pubkey.xml @@ -1,6 +1,6 @@ - + ssh2_auth_pubkey Authenticate using a public key in a variable diff --git a/reference/ssh2/functions/ssh2-connect.xml b/reference/ssh2/functions/ssh2-connect.xml index 5a6ce3316..b0d1af68b 100644 --- a/reference/ssh2/functions/ssh2-connect.xml +++ b/reference/ssh2/functions/ssh2-connect.xml @@ -1,6 +1,6 @@ - + ssh2_connect Connect to an SSH server diff --git a/reference/ssh2/functions/ssh2-exec.xml b/reference/ssh2/functions/ssh2-exec.xml index 10068837f..88ad07b2d 100644 --- a/reference/ssh2/functions/ssh2-exec.xml +++ b/reference/ssh2/functions/ssh2-exec.xml @@ -1,6 +1,6 @@ - + ssh2_exec Execute a command on a remote server diff --git a/reference/ssh2/functions/ssh2-fetch-stream.xml b/reference/ssh2/functions/ssh2-fetch-stream.xml index 0a7f07fb5..2afcdc950 100644 --- a/reference/ssh2/functions/ssh2-fetch-stream.xml +++ b/reference/ssh2/functions/ssh2-fetch-stream.xml @@ -1,6 +1,6 @@ - + ssh2_fetch_stream Fetch an extended data stream diff --git a/reference/ssh2/functions/ssh2-fingerprint.xml b/reference/ssh2/functions/ssh2-fingerprint.xml index 09f0f3c9e..d02e212c6 100644 --- a/reference/ssh2/functions/ssh2-fingerprint.xml +++ b/reference/ssh2/functions/ssh2-fingerprint.xml @@ -1,6 +1,6 @@ - + ssh2_fingerprint Retrieve fingerprint of remote server diff --git a/reference/ssh2/functions/ssh2-forward-accept.xml b/reference/ssh2/functions/ssh2-forward-accept.xml index ad1fa84c8..57145f745 100644 --- a/reference/ssh2/functions/ssh2-forward-accept.xml +++ b/reference/ssh2/functions/ssh2-forward-accept.xml @@ -1,6 +1,6 @@ - + ssh2_forward_accept Accept a connection created by a listener diff --git a/reference/ssh2/functions/ssh2-forward-listen.xml b/reference/ssh2/functions/ssh2-forward-listen.xml index 17eca78e2..7fd1f12f2 100644 --- a/reference/ssh2/functions/ssh2-forward-listen.xml +++ b/reference/ssh2/functions/ssh2-forward-listen.xml @@ -1,6 +1,6 @@ - + ssh2_forward_listen Bind a port on the remote server and listen for connections diff --git a/reference/ssh2/functions/ssh2-methods-negotiated.xml b/reference/ssh2/functions/ssh2-methods-negotiated.xml index ffa7cb10d..30e1775ba 100644 --- a/reference/ssh2/functions/ssh2-methods-negotiated.xml +++ b/reference/ssh2/functions/ssh2-methods-negotiated.xml @@ -1,6 +1,6 @@ - + ssh2_methods_negotiated Return list of negotiated methods diff --git a/reference/ssh2/functions/ssh2-poll.xml b/reference/ssh2/functions/ssh2-poll.xml index 16a3ee8b1..93c8435bc 100644 --- a/reference/ssh2/functions/ssh2-poll.xml +++ b/reference/ssh2/functions/ssh2-poll.xml @@ -1,6 +1,6 @@ - + ssh2_poll Poll the channels/listeners/streams for events diff --git a/reference/ssh2/functions/ssh2-publickey-add.xml b/reference/ssh2/functions/ssh2-publickey-add.xml index 0b279afce..327b2c798 100644 --- a/reference/ssh2/functions/ssh2-publickey-add.xml +++ b/reference/ssh2/functions/ssh2-publickey-add.xml @@ -1,6 +1,6 @@ - + ssh2_publickey_add diff --git a/reference/ssh2/functions/ssh2-publickey-init.xml b/reference/ssh2/functions/ssh2-publickey-init.xml index 88add4ed5..44ea17938 100644 --- a/reference/ssh2/functions/ssh2-publickey-init.xml +++ b/reference/ssh2/functions/ssh2-publickey-init.xml @@ -1,6 +1,6 @@ - + ssh2_publickey_init diff --git a/reference/ssh2/functions/ssh2-publickey-list.xml b/reference/ssh2/functions/ssh2-publickey-list.xml index d2bf0f985..5fc1c26fa 100644 --- a/reference/ssh2/functions/ssh2-publickey-list.xml +++ b/reference/ssh2/functions/ssh2-publickey-list.xml @@ -1,6 +1,6 @@ - + ssh2_publickey_list diff --git a/reference/ssh2/functions/ssh2-publickey-remove.xml b/reference/ssh2/functions/ssh2-publickey-remove.xml index 317083d28..890e63f43 100644 --- a/reference/ssh2/functions/ssh2-publickey-remove.xml +++ b/reference/ssh2/functions/ssh2-publickey-remove.xml @@ -1,6 +1,6 @@ - + ssh2_publickey_remove diff --git a/reference/ssh2/functions/ssh2-scp-recv.xml b/reference/ssh2/functions/ssh2-scp-recv.xml index eb42d23f0..a362e53ec 100644 --- a/reference/ssh2/functions/ssh2-scp-recv.xml +++ b/reference/ssh2/functions/ssh2-scp-recv.xml @@ -1,6 +1,6 @@ - + ssh2_scp_recv Request a file via SCP diff --git a/reference/ssh2/functions/ssh2-scp-send.xml b/reference/ssh2/functions/ssh2-scp-send.xml index 210294f1a..74264e08b 100644 --- a/reference/ssh2/functions/ssh2-scp-send.xml +++ b/reference/ssh2/functions/ssh2-scp-send.xml @@ -1,6 +1,6 @@ - + ssh2_scp_send Send a file via SCP diff --git a/reference/ssh2/functions/ssh2-sftp-chmod.xml b/reference/ssh2/functions/ssh2-sftp-chmod.xml index 2c4c01644..69ec84433 100644 --- a/reference/ssh2/functions/ssh2-sftp-chmod.xml +++ b/reference/ssh2/functions/ssh2-sftp-chmod.xml @@ -1,6 +1,6 @@ - + ssh2_sftp_chmod Changes file mode diff --git a/reference/ssh2/functions/ssh2-sftp-mkdir.xml b/reference/ssh2/functions/ssh2-sftp-mkdir.xml index f5f9af99f..6be2d7dda 100644 --- a/reference/ssh2/functions/ssh2-sftp-mkdir.xml +++ b/reference/ssh2/functions/ssh2-sftp-mkdir.xml @@ -1,6 +1,6 @@ - + ssh2_sftp_mkdir Create a directory diff --git a/reference/ssh2/functions/ssh2-sftp-rename.xml b/reference/ssh2/functions/ssh2-sftp-rename.xml index e0b4f4109..d316c71a8 100644 --- a/reference/ssh2/functions/ssh2-sftp-rename.xml +++ b/reference/ssh2/functions/ssh2-sftp-rename.xml @@ -1,6 +1,6 @@ - + ssh2_sftp_rename Rename a remote file diff --git a/reference/ssh2/functions/ssh2-sftp-rmdir.xml b/reference/ssh2/functions/ssh2-sftp-rmdir.xml index 4c9a4597b..f706c2308 100644 --- a/reference/ssh2/functions/ssh2-sftp-rmdir.xml +++ b/reference/ssh2/functions/ssh2-sftp-rmdir.xml @@ -1,6 +1,6 @@ - + ssh2_sftp_rmdir Remove a directory diff --git a/reference/ssh2/functions/ssh2-sftp-symlink.xml b/reference/ssh2/functions/ssh2-sftp-symlink.xml index 347381b91..930796aab 100644 --- a/reference/ssh2/functions/ssh2-sftp-symlink.xml +++ b/reference/ssh2/functions/ssh2-sftp-symlink.xml @@ -1,6 +1,6 @@ - + ssh2_sftp_symlink Create a symlink diff --git a/reference/ssh2/functions/ssh2-sftp-unlink.xml b/reference/ssh2/functions/ssh2-sftp-unlink.xml index 18db54488..7cf8d2766 100644 --- a/reference/ssh2/functions/ssh2-sftp-unlink.xml +++ b/reference/ssh2/functions/ssh2-sftp-unlink.xml @@ -1,6 +1,6 @@ - + ssh2_sftp_unlink Delete a file diff --git a/reference/ssh2/functions/ssh2-sftp.xml b/reference/ssh2/functions/ssh2-sftp.xml index 3c7059bca..999a4a652 100644 --- a/reference/ssh2/functions/ssh2-sftp.xml +++ b/reference/ssh2/functions/ssh2-sftp.xml @@ -1,6 +1,6 @@ - + ssh2_sftp Initialize SFTP subsystem diff --git a/reference/ssh2/functions/ssh2-shell.xml b/reference/ssh2/functions/ssh2-shell.xml index 693685092..b56d1c30f 100644 --- a/reference/ssh2/functions/ssh2-shell.xml +++ b/reference/ssh2/functions/ssh2-shell.xml @@ -1,6 +1,6 @@ - + ssh2_shell Request an interactive shell diff --git a/reference/ssh2/functions/ssh2-tunnel.xml b/reference/ssh2/functions/ssh2-tunnel.xml index bf0b38eca..79b448495 100644 --- a/reference/ssh2/functions/ssh2-tunnel.xml +++ b/reference/ssh2/functions/ssh2-tunnel.xml @@ -1,6 +1,6 @@ - + ssh2_tunnel Open a tunnel through a remote server diff --git a/reference/ssh2/installation.xml b/reference/ssh2/installation.xml index 6378e4390..5a0fa3e22 100644 --- a/reference/ssh2/installation.xml +++ b/reference/ssh2/installation.xml @@ -1,6 +1,6 @@ -
    +
    &reftitle.install; diff --git a/reference/ssh2/setup.xml b/reference/ssh2/setup.xml index d1c341fd2..1b4791042 100644 --- a/reference/ssh2/setup.xml +++ b/reference/ssh2/setup.xml @@ -1,6 +1,6 @@ - + &reftitle.setup; diff --git a/reference/stats/functions/stats-rand-gen-f.xml b/reference/stats/functions/stats-rand-gen-f.xml index e55ba3e1f..223b027e8 100644 --- a/reference/stats/functions/stats-rand-gen-f.xml +++ b/reference/stats/functions/stats-rand-gen-f.xml @@ -25,17 +25,17 @@ dfn - + The degrees of freedom in the numerator - + dfd - + The degrees of freedom in the denominator - + @@ -44,9 +44,9 @@ &reftitle.returnvalues; - + A random deviate - + diff --git a/reference/stats/functions/stats-standard-deviation.xml b/reference/stats/functions/stats-standard-deviation.xml index 3ffa3ad8c..6a7acd323 100644 --- a/reference/stats/functions/stats-standard-deviation.xml +++ b/reference/stats/functions/stats-standard-deviation.xml @@ -12,9 +12,9 @@ arraya boolsample&false; - + Returns the standard deviation of the values in a. - + &reftitle.parameters; @@ -44,9 +44,9 @@ &reftitle.returnvalues; - + Returns the standard deviation on success; &false; on failure. - + diff --git a/reference/stats/functions/stats-variance.xml b/reference/stats/functions/stats-variance.xml index 0b711ae38..707366d5d 100644 --- a/reference/stats/functions/stats-variance.xml +++ b/reference/stats/functions/stats-variance.xml @@ -12,9 +12,9 @@ arraya boolsample&false; - + Returns the variance of the values in a. - + &reftitle.parameters; @@ -44,9 +44,9 @@ &reftitle.returnvalues; - + Returns the variance on success; &false; on failure. - + diff --git a/reference/stats/setup.xml b/reference/stats/setup.xml index 38de124f5..2aa949ffd 100644 --- a/reference/stats/setup.xml +++ b/reference/stats/setup.xml @@ -7,25 +7,25 @@
    &reftitle.required; - + No external libraries are needed. The extension comes bundled with the libraries used. - +
    &reftitle.install; - + &pecl.moved; - - + + &pecl.info.dead; &url.pecl.package;stats. - - + + &pecl.windows.download.avail; - +
    diff --git a/reference/stomp/book.xml b/reference/stomp/book.xml index 00ea816c2..f36730c4a 100644 --- a/reference/stomp/book.xml +++ b/reference/stomp/book.xml @@ -1,6 +1,6 @@ - + Stomp Client Stomp diff --git a/reference/stomp/examples.xml b/reference/stomp/examples.xml index d093b0572..8e5cc17ae 100644 --- a/reference/stomp/examples.xml +++ b/reference/stomp/examples.xml @@ -1,6 +1,6 @@ - + &reftitle.examples; diff --git a/reference/stomp/functions/stomp-connect-error.xml b/reference/stomp/functions/stomp-connect-error.xml index e63c64f90..1c48db80f 100644 --- a/reference/stomp/functions/stomp-connect-error.xml +++ b/reference/stomp/functions/stomp-connect-error.xml @@ -1,6 +1,6 @@ - + stomp_connect_error Returns a string description of the last connect error diff --git a/reference/stomp/functions/stomp-version.xml b/reference/stomp/functions/stomp-version.xml index 79146bdb4..1d161c544 100644 --- a/reference/stomp/functions/stomp-version.xml +++ b/reference/stomp/functions/stomp-version.xml @@ -1,6 +1,6 @@ - + stomp_version Gets the current stomp extension version diff --git a/reference/stomp/ini.xml b/reference/stomp/ini.xml index 8e0cb0685..a5724a5b8 100644 --- a/reference/stomp/ini.xml +++ b/reference/stomp/ini.xml @@ -1,6 +1,6 @@ -
    +
    &reftitle.runtime; &extension.runtime;
    diff --git a/reference/stomp/setup.xml b/reference/stomp/setup.xml index 46df8a9fc..de0a6f584 100644 --- a/reference/stomp/setup.xml +++ b/reference/stomp/setup.xml @@ -1,6 +1,6 @@ - + &reftitle.setup;
    diff --git a/reference/stomp/stomp.xml b/reference/stomp/stomp.xml index 5298b7c30..573a47e84 100644 --- a/reference/stomp/stomp.xml +++ b/reference/stomp/stomp.xml @@ -1,6 +1,6 @@ - + The Stomp class Stomp diff --git a/reference/stomp/stomp/abort.xml b/reference/stomp/stomp/abort.xml index ae1f25c7a..a9bdc35b5 100644 --- a/reference/stomp/stomp/abort.xml +++ b/reference/stomp/stomp/abort.xml @@ -1,6 +1,6 @@ - + Stomp::abort stomp_abort diff --git a/reference/stomp/stomp/ack.xml b/reference/stomp/stomp/ack.xml index 745eebbf1..15d194980 100644 --- a/reference/stomp/stomp/ack.xml +++ b/reference/stomp/stomp/ack.xml @@ -1,6 +1,6 @@ - + Stomp::ack stomp_ack diff --git a/reference/stomp/stomp/begin.xml b/reference/stomp/stomp/begin.xml index c206436f9..6a44378af 100644 --- a/reference/stomp/stomp/begin.xml +++ b/reference/stomp/stomp/begin.xml @@ -1,6 +1,6 @@ - + Stomp::begin stomp_begin diff --git a/reference/stomp/stomp/commit.xml b/reference/stomp/stomp/commit.xml index c27aa4f47..faca231ac 100644 --- a/reference/stomp/stomp/commit.xml +++ b/reference/stomp/stomp/commit.xml @@ -1,6 +1,6 @@ - + Stomp::commit stomp_commit diff --git a/reference/stomp/stomp/construct.xml b/reference/stomp/stomp/construct.xml index 93b5d191a..995564601 100644 --- a/reference/stomp/stomp/construct.xml +++ b/reference/stomp/stomp/construct.xml @@ -1,6 +1,6 @@ - + Stomp::__construct stomp_connect diff --git a/reference/stomp/stomp/destruct.xml b/reference/stomp/stomp/destruct.xml index 0aa8e8b7c..0cd367d9f 100644 --- a/reference/stomp/stomp/destruct.xml +++ b/reference/stomp/stomp/destruct.xml @@ -1,6 +1,6 @@ - + Stomp::__destruct stomp_close diff --git a/reference/stomp/stomp/error.xml b/reference/stomp/stomp/error.xml index 0ee9e66c7..e1126ca95 100644 --- a/reference/stomp/stomp/error.xml +++ b/reference/stomp/stomp/error.xml @@ -1,6 +1,6 @@ - + Stomp::error stomp_error diff --git a/reference/stomp/stomp/getreadtimeout.xml b/reference/stomp/stomp/getreadtimeout.xml index aa2464e7f..3e57114c1 100644 --- a/reference/stomp/stomp/getreadtimeout.xml +++ b/reference/stomp/stomp/getreadtimeout.xml @@ -1,6 +1,6 @@ - + Stomp::getReadTimeout stomp_get_read_timeout diff --git a/reference/stomp/stomp/getsessionid.xml b/reference/stomp/stomp/getsessionid.xml index 976d685fe..1aecc17d3 100644 --- a/reference/stomp/stomp/getsessionid.xml +++ b/reference/stomp/stomp/getsessionid.xml @@ -1,6 +1,6 @@ - + Stomp::getSessionId stomp_get_session_id diff --git a/reference/stomp/stomp/hasframe.xml b/reference/stomp/stomp/hasframe.xml index 8934e9c58..42f826cd4 100644 --- a/reference/stomp/stomp/hasframe.xml +++ b/reference/stomp/stomp/hasframe.xml @@ -1,6 +1,6 @@ - + Stomp::hasFrame stomp_has_frame diff --git a/reference/stomp/stomp/readframe.xml b/reference/stomp/stomp/readframe.xml index 77e0362ea..b0ee90ef3 100644 --- a/reference/stomp/stomp/readframe.xml +++ b/reference/stomp/stomp/readframe.xml @@ -1,6 +1,6 @@ - + Stomp::readFrame stomp_read_frame diff --git a/reference/stomp/stomp/send.xml b/reference/stomp/stomp/send.xml index 503b712e6..1c9f2c1ad 100644 --- a/reference/stomp/stomp/send.xml +++ b/reference/stomp/stomp/send.xml @@ -1,6 +1,6 @@ - + Stomp::send stomp_send diff --git a/reference/stomp/stomp/setreadtimeout.xml b/reference/stomp/stomp/setreadtimeout.xml index 77dcf81f8..64ac3dea7 100644 --- a/reference/stomp/stomp/setreadtimeout.xml +++ b/reference/stomp/stomp/setreadtimeout.xml @@ -1,6 +1,6 @@ - + Stomp::setReadTimeout stomp_set_read_timeout diff --git a/reference/stomp/stomp/subscribe.xml b/reference/stomp/stomp/subscribe.xml index cf07173ca..47e2727f8 100644 --- a/reference/stomp/stomp/subscribe.xml +++ b/reference/stomp/stomp/subscribe.xml @@ -1,6 +1,6 @@ - + Stomp::subscribe stomp_subscribe diff --git a/reference/stomp/stomp/unsubscribe.xml b/reference/stomp/stomp/unsubscribe.xml index faa20fafb..148ee4915 100644 --- a/reference/stomp/stomp/unsubscribe.xml +++ b/reference/stomp/stomp/unsubscribe.xml @@ -1,6 +1,6 @@ - + Stomp::unsubscribe stomp_unsubscribe diff --git a/reference/stomp/stompexception.xml b/reference/stomp/stompexception.xml index 30877492c..0fa26ab37 100644 --- a/reference/stomp/stompexception.xml +++ b/reference/stomp/stompexception.xml @@ -1,6 +1,6 @@ - + The StompException class StompException diff --git a/reference/stomp/stompexception/getdetails.xml b/reference/stomp/stompexception/getdetails.xml index d098dc8d9..f0db5621d 100644 --- a/reference/stomp/stompexception/getdetails.xml +++ b/reference/stomp/stompexception/getdetails.xml @@ -1,6 +1,6 @@ - + StompException::getDetails Get exception details diff --git a/reference/stomp/stompframe.xml b/reference/stomp/stompframe.xml index 161ddc476..0ed98468c 100644 --- a/reference/stomp/stompframe.xml +++ b/reference/stomp/stompframe.xml @@ -1,6 +1,6 @@ - + The StompFrame class StompFrame diff --git a/reference/stomp/stompframe/construct.xml b/reference/stomp/stompframe/construct.xml index 6da14748e..d678ca46f 100644 --- a/reference/stomp/stompframe/construct.xml +++ b/reference/stomp/stompframe/construct.xml @@ -1,6 +1,6 @@ - + StompFrame::__construct Constructor diff --git a/reference/svm/book.xml b/reference/svm/book.xml index a0118a2cc..9bebe2b95 100644 --- a/reference/svm/book.xml +++ b/reference/svm/book.xml @@ -1,7 +1,7 @@ - + Support Vector Machine SVM diff --git a/reference/svm/configure.xml b/reference/svm/configure.xml index d37c7fb29..25ef15fa8 100644 --- a/reference/svm/configure.xml +++ b/reference/svm/configure.xml @@ -1,6 +1,6 @@ -
    +
    &reftitle.install; diff --git a/reference/svm/examples.xml b/reference/svm/examples.xml index a9ae39d00..573736915 100644 --- a/reference/svm/examples.xml +++ b/reference/svm/examples.xml @@ -1,6 +1,6 @@ - + &reftitle.examples; diff --git a/reference/svm/setup.xml b/reference/svm/setup.xml index 37b68cee6..2328e2d4d 100644 --- a/reference/svm/setup.xml +++ b/reference/svm/setup.xml @@ -1,6 +1,6 @@ - + &reftitle.setup;
    diff --git a/reference/svm/svm.xml b/reference/svm/svm.xml index 913588775..b5b4133bb 100644 --- a/reference/svm/svm.xml +++ b/reference/svm/svm.xml @@ -1,6 +1,6 @@ - + The SVM class SVM diff --git a/reference/svm/svm/construct.xml b/reference/svm/svm/construct.xml index 20791b6ab..fb415177e 100644 --- a/reference/svm/svm/construct.xml +++ b/reference/svm/svm/construct.xml @@ -1,6 +1,6 @@ - + SVM::__construct Construct a new SVM object @@ -26,7 +26,7 @@ &reftitle.errors; - Throws a SVMException if the libsvm + Throws a SVMException if the libsvm library could not be loaded. diff --git a/reference/svm/svm/crossvalidate.xml b/reference/svm/svm/crossvalidate.xml index 032ecc15f..d631247aa 100644 --- a/reference/svm/svm/crossvalidate.xml +++ b/reference/svm/svm/crossvalidate.xml @@ -1,6 +1,6 @@ - + SVM::crossvalidate Test training params on subsets of the training data diff --git a/reference/svm/svm/getoptions.xml b/reference/svm/svm/getoptions.xml index 51c8a188a..c838d52b5 100644 --- a/reference/svm/svm/getoptions.xml +++ b/reference/svm/svm/getoptions.xml @@ -1,6 +1,6 @@ - + SVM::getOptions Return the current training parameters diff --git a/reference/svm/svm/setoptions.xml b/reference/svm/svm/setoptions.xml index fde81fd0a..2969072e0 100644 --- a/reference/svm/svm/setoptions.xml +++ b/reference/svm/svm/setoptions.xml @@ -1,6 +1,6 @@ - + SVM::setOptions Set training parameters diff --git a/reference/svm/svm/train.xml b/reference/svm/svm/train.xml index 6d7e378e1..9e95d657b 100644 --- a/reference/svm/svm/train.xml +++ b/reference/svm/svm/train.xml @@ -1,6 +1,6 @@ - + SVM::train Create a SVMModel based on training data diff --git a/reference/svm/svmexception.xml b/reference/svm/svmexception.xml index 7ee17a5da..90bb1322c 100644 --- a/reference/svm/svmexception.xml +++ b/reference/svm/svmexception.xml @@ -1,6 +1,6 @@ - + The SVMException class SVMException diff --git a/reference/svm/svmmodel.xml b/reference/svm/svmmodel.xml index af151a7cd..7ceba0d37 100644 --- a/reference/svm/svmmodel.xml +++ b/reference/svm/svmmodel.xml @@ -1,6 +1,6 @@ - + The SVMModel class SVMModel diff --git a/reference/svm/svmmodel/checkprobabilitymodel.xml b/reference/svm/svmmodel/checkprobabilitymodel.xml index d0c8eb96a..a68809076 100644 --- a/reference/svm/svmmodel/checkprobabilitymodel.xml +++ b/reference/svm/svmmodel/checkprobabilitymodel.xml @@ -1,6 +1,6 @@ - + SVMModel::checkProbabilityModel Returns true if the model has probability information diff --git a/reference/svm/svmmodel/construct.xml b/reference/svm/svmmodel/construct.xml index 473228eba..6042558a6 100644 --- a/reference/svm/svmmodel/construct.xml +++ b/reference/svm/svmmodel/construct.xml @@ -1,6 +1,6 @@ - + SVMModel::__construct Construct a new SVMModel @@ -36,7 +36,7 @@ &reftitle.errors; - Throws a SVMException on error + Throws a SVMException on error diff --git a/reference/svm/svmmodel/getlabels.xml b/reference/svm/svmmodel/getlabels.xml index 81ca072d2..ddd73dc54 100644 --- a/reference/svm/svmmodel/getlabels.xml +++ b/reference/svm/svmmodel/getlabels.xml @@ -1,6 +1,6 @@ - + SVMModel::getLabels Get the labels the model was trained on diff --git a/reference/svm/svmmodel/getnrclass.xml b/reference/svm/svmmodel/getnrclass.xml index 2c8e7bb87..b8c6ffade 100644 --- a/reference/svm/svmmodel/getnrclass.xml +++ b/reference/svm/svmmodel/getnrclass.xml @@ -1,6 +1,6 @@ - + SVMModel::getNrClass Returns the number of classes the model was trained with diff --git a/reference/svm/svmmodel/getsvmtype.xml b/reference/svm/svmmodel/getsvmtype.xml index 941d4b707..ed38b2612 100644 --- a/reference/svm/svmmodel/getsvmtype.xml +++ b/reference/svm/svmmodel/getsvmtype.xml @@ -1,6 +1,6 @@ - + SVMModel::getSvmType Get the SVM type the model was trained with diff --git a/reference/svm/svmmodel/getsvrprobability.xml b/reference/svm/svmmodel/getsvrprobability.xml index d63a040e2..34aef1b89 100644 --- a/reference/svm/svmmodel/getsvrprobability.xml +++ b/reference/svm/svmmodel/getsvrprobability.xml @@ -1,6 +1,6 @@ - + SVMModel::getSvrProbability Get the sigma value for regression types diff --git a/reference/svm/svmmodel/load.xml b/reference/svm/svmmodel/load.xml index 185b8c6c3..ade37c02c 100644 --- a/reference/svm/svmmodel/load.xml +++ b/reference/svm/svmmodel/load.xml @@ -1,6 +1,6 @@ - + SVMModel::load Load a saved SVM Model diff --git a/reference/svm/svmmodel/predict-probability.xml b/reference/svm/svmmodel/predict-probability.xml index 4d570082a..b1ef78962 100644 --- a/reference/svm/svmmodel/predict-probability.xml +++ b/reference/svm/svmmodel/predict-probability.xml @@ -1,6 +1,6 @@ - + SVMModel::predict_probability Return class probabilities for previous unseen data diff --git a/reference/svm/svmmodel/predict.xml b/reference/svm/svmmodel/predict.xml index ff8b26f78..2dfac9bb9 100644 --- a/reference/svm/svmmodel/predict.xml +++ b/reference/svm/svmmodel/predict.xml @@ -1,6 +1,6 @@ - + SVMModel::predict Predict a value for previously unseen data diff --git a/reference/svm/svmmodel/save.xml b/reference/svm/svmmodel/save.xml index 3b0d35d1e..9027d3b00 100644 --- a/reference/svm/svmmodel/save.xml +++ b/reference/svm/svmmodel/save.xml @@ -1,6 +1,6 @@ - + SVMModel::save Save a model to a file diff --git a/reference/svn/book.xml b/reference/svn/book.xml index c753ead26..8342fcda2 100644 --- a/reference/svn/book.xml +++ b/reference/svn/book.xml @@ -1,7 +1,7 @@ - + Subversion SVN diff --git a/reference/svn/configure.xml b/reference/svn/configure.xml index f77dc938a..4624fa672 100644 --- a/reference/svn/configure.xml +++ b/reference/svn/configure.xml @@ -1,6 +1,6 @@ -
    +
    &reftitle.install; &pecl.info; diff --git a/reference/svn/constants.xml b/reference/svn/constants.xml index dfd7c2da0..95ee01f04 100644 --- a/reference/svn/constants.xml +++ b/reference/svn/constants.xml @@ -20,7 +20,7 @@ Constants usable with <function>svn_auth_set_parameter</function> - SVN_AUTH_PARAM_DEFAULT_USERNAME + SVN_AUTH_PARAM_DEFAULT_USERNAME (string) @@ -31,7 +31,7 @@ - SVN_AUTH_PARAM_DEFAULT_PASSWORD + SVN_AUTH_PARAM_DEFAULT_PASSWORD (string) @@ -42,63 +42,63 @@ - SVN_AUTH_PARAM_NON_INTERACTIVE + SVN_AUTH_PARAM_NON_INTERACTIVE (string) - SVN_AUTH_PARAM_DONT_STORE_PASSWORDS + SVN_AUTH_PARAM_DONT_STORE_PASSWORDS (string) - SVN_AUTH_PARAM_NO_AUTH_CACHE + SVN_AUTH_PARAM_NO_AUTH_CACHE (string) - SVN_AUTH_PARAM_SSL_SERVER_FAILURES + SVN_AUTH_PARAM_SSL_SERVER_FAILURES (string) - SVN_AUTH_PARAM_SSL_SERVER_CERT_INFO + SVN_AUTH_PARAM_SSL_SERVER_CERT_INFO (string) - SVN_AUTH_PARAM_CONFIG + SVN_AUTH_PARAM_CONFIG (string) - SVN_AUTH_PARAM_SERVER_GROUP + SVN_AUTH_PARAM_SERVER_GROUP (string) - SVN_AUTH_PARAM_CONFIG_DIR + SVN_AUTH_PARAM_CONFIG_DIR (string) - PHP_SVN_AUTH_PARAM_IGNORE_SSL_VERIFY_ERRORS + PHP_SVN_AUTH_PARAM_IGNORE_SSL_VERIFY_ERRORS (string) @@ -112,7 +112,7 @@ Filesystem constants - SVN_FS_CONFIG_FS_TYPE + SVN_FS_CONFIG_FS_TYPE (string) @@ -123,7 +123,7 @@ - SVN_FS_TYPE_BDB + SVN_FS_TYPE_BDB (string) @@ -134,7 +134,7 @@ - SVN_FS_TYPE_FSFS + SVN_FS_TYPE_FSFS (string) @@ -148,7 +148,7 @@ Reserved property constants - SVN_PROP_REVISION_DATE + SVN_PROP_REVISION_DATE (string) @@ -159,7 +159,7 @@ - SVN_PROP_REVISION_ORIG_DATE + SVN_PROP_REVISION_ORIG_DATE (string) @@ -170,7 +170,7 @@ - SVN_PROP_REVISION_AUTHOR + SVN_PROP_REVISION_AUTHOR (string) @@ -181,7 +181,7 @@ - SVN_PROP_REVISION_LOG + SVN_PROP_REVISION_LOG (string) @@ -195,7 +195,7 @@ Working copy status constants - SVN_WC_STATUS_NONE + SVN_WC_STATUS_NONE (int) @@ -206,7 +206,7 @@ - SVN_WC_STATUS_UNVERSIONED + SVN_WC_STATUS_UNVERSIONED (int) @@ -217,7 +217,7 @@ - SVN_WC_STATUS_NORMAL + SVN_WC_STATUS_NORMAL (int) @@ -228,7 +228,7 @@ - SVN_WC_STATUS_ADDED + SVN_WC_STATUS_ADDED (int) @@ -239,7 +239,7 @@ - SVN_WC_STATUS_MISSING + SVN_WC_STATUS_MISSING (int) @@ -250,7 +250,7 @@ - SVN_WC_STATUS_DELETED + SVN_WC_STATUS_DELETED (int) @@ -261,7 +261,7 @@ - SVN_WC_STATUS_REPLACED + SVN_WC_STATUS_REPLACED (int) @@ -272,7 +272,7 @@ - SVN_WC_STATUS_MODIFIED + SVN_WC_STATUS_MODIFIED (int) @@ -283,7 +283,7 @@ - SVN_WC_STATUS_MERGED + SVN_WC_STATUS_MERGED (int) @@ -294,7 +294,7 @@ - SVN_WC_STATUS_CONFLICTED + SVN_WC_STATUS_CONFLICTED (int) @@ -305,7 +305,7 @@ - SVN_WC_STATUS_IGNORED + SVN_WC_STATUS_IGNORED (int) @@ -316,7 +316,7 @@ - SVN_WC_STATUS_OBSTRUCTED + SVN_WC_STATUS_OBSTRUCTED (int) @@ -327,7 +327,7 @@ - SVN_WC_STATUS_EXTERNAL + SVN_WC_STATUS_EXTERNAL (int) @@ -338,7 +338,7 @@ - SVN_WC_STATUS_INCOMPLETE + SVN_WC_STATUS_INCOMPLETE (int) @@ -352,7 +352,7 @@ Node type constants - SVN_NODE_NONE + SVN_NODE_NONE (int) @@ -363,7 +363,7 @@ - SVN_NODE_FILE + SVN_NODE_FILE (int) @@ -374,7 +374,7 @@ - SVN_NODE_DIR + SVN_NODE_DIR (int) @@ -385,7 +385,7 @@ - SVN_NODE_UNKNOWN + SVN_NODE_UNKNOWN (int) diff --git a/reference/svn/functions/svn-blame.xml b/reference/svn/functions/svn-blame.xml index 5f84cc354..73f2df47e 100644 --- a/reference/svn/functions/svn-blame.xml +++ b/reference/svn/functions/svn-blame.xml @@ -1,6 +1,6 @@ - + svn_blame Get the SVN blame for a file diff --git a/reference/svn/functions/svn-delete.xml b/reference/svn/functions/svn-delete.xml index e162c25aa..c36af4b0e 100644 --- a/reference/svn/functions/svn-delete.xml +++ b/reference/svn/functions/svn-delete.xml @@ -1,6 +1,6 @@ - + svn_delete Delete items from a working copy or repository diff --git a/reference/svn/functions/svn-export.xml b/reference/svn/functions/svn-export.xml index b596b5668..22af71ca2 100644 --- a/reference/svn/functions/svn-export.xml +++ b/reference/svn/functions/svn-export.xml @@ -1,6 +1,6 @@ - + svn_export Export the contents of a SVN directory diff --git a/reference/svn/functions/svn-ls.xml b/reference/svn/functions/svn-ls.xml index 2b19e991f..aaa7b10a5 100644 --- a/reference/svn/functions/svn-ls.xml +++ b/reference/svn/functions/svn-ls.xml @@ -1,6 +1,6 @@ - + svn_ls Returns list of directory contents in repository URL, optionally at revision number diff --git a/reference/svn/functions/svn-mkdir.xml b/reference/svn/functions/svn-mkdir.xml index 3d004d113..9525ad037 100644 --- a/reference/svn/functions/svn-mkdir.xml +++ b/reference/svn/functions/svn-mkdir.xml @@ -1,6 +1,6 @@ - + svn_mkdir Creates a directory in a working copy or repository diff --git a/reference/svn/functions/svn-revert.xml b/reference/svn/functions/svn-revert.xml index 1c21077c3..903018f1b 100644 --- a/reference/svn/functions/svn-revert.xml +++ b/reference/svn/functions/svn-revert.xml @@ -1,6 +1,6 @@ - + svn_revert Revert changes to the working copy diff --git a/reference/svn/setup.xml b/reference/svn/setup.xml index 531ca92fe..05d784ab1 100644 --- a/reference/svn/setup.xml +++ b/reference/svn/setup.xml @@ -1,6 +1,6 @@ - + &reftitle.setup; diff --git a/reference/swoole/book.xml b/reference/swoole/book.xml index 88e2cea06..3847f0a10 100644 --- a/reference/swoole/book.xml +++ b/reference/swoole/book.xml @@ -1,15 +1,15 @@ - + Swoole Swoole - + &reftitle.intro; - + Swoole is a parallel network communication engine based on asynchronous event-driven and coroutine, written in C++, providing coroutine and high-performance network programming support for PHP. It provides various network server and client modules for multiple communication protocols, making it easy to @@ -18,11 +18,11 @@ To get started, please check the Swoole Docs. - + ¬e.no-windows.extension; - + &reference.swoole.setup; &reference.swoole.constants; &reference.swoole.reference; diff --git a/reference/swoole/configure.xml b/reference/swoole/configure.xml index a6b3947e5..40cfe0d23 100644 --- a/reference/swoole/configure.xml +++ b/reference/swoole/configure.xml @@ -4,12 +4,12 @@
    &reftitle.install; - + Use when compiling PHP. - - - + + + &pecl.info; &url.pecl.package;swoole - +
    \ No newline at end of file diff --git a/reference/swoole/functions/swoole-async-dns-lookup.xml b/reference/swoole/functions/swoole-async-dns-lookup.xml index 0fc4097f9..11ab13ad8 100644 --- a/reference/swoole/functions/swoole-async-dns-lookup.xml +++ b/reference/swoole/functions/swoole-async-dns-lookup.xml @@ -14,9 +14,9 @@ stringhostname callablecallback - + - + @@ -26,9 +26,9 @@ hostname - + The host name. - + @@ -44,17 +44,17 @@ hostname - + The host name. - + IP - + The IP address. - + @@ -65,9 +65,9 @@ &reftitle.returnvalues; - + &return.success; - + diff --git a/reference/swoole/functions/swoole-async-read.xml b/reference/swoole/functions/swoole-async-read.xml index 2fae5fd37..8b09f4a38 100644 --- a/reference/swoole/functions/swoole-async-read.xml +++ b/reference/swoole/functions/swoole-async-read.xml @@ -16,9 +16,9 @@ intchunk_size65536 intoffset0 - + - + @@ -28,9 +28,9 @@ filename - + The filename of the file being read. - + @@ -45,9 +45,9 @@ filename - + The name of the file. - + @@ -64,17 +64,17 @@ chunk_size - + The chunk length. - + offset - + The offset. - + @@ -82,9 +82,9 @@ &reftitle.returnvalues; - + Whether the read is succeed. - + diff --git a/reference/swoole/functions/swoole-async-readfile.xml b/reference/swoole/functions/swoole-async-readfile.xml index 410f9f3e0..4797a8c0e 100644 --- a/reference/swoole/functions/swoole-async-readfile.xml +++ b/reference/swoole/functions/swoole-async-readfile.xml @@ -14,9 +14,9 @@ stringfilename callablecallback - + - + @@ -26,9 +26,9 @@ filename - + The filename of the file being read. - + @@ -43,17 +43,17 @@ filename - + The name of the file. - + content - + The content read from the file. - + @@ -64,9 +64,9 @@ &reftitle.returnvalues; - + &return.success; - + diff --git a/reference/swoole/functions/swoole-async-set.xml b/reference/swoole/functions/swoole-async-set.xml index 6b7f22b6b..bae06db34 100644 --- a/reference/swoole/functions/swoole-async-set.xml +++ b/reference/swoole/functions/swoole-async-set.xml @@ -13,9 +13,9 @@ voidswoole_async_set arraysettings - - - + + + @@ -25,9 +25,9 @@ settings - - - + + + @@ -35,9 +35,9 @@ &reftitle.returnvalues; - + &return.void; - + diff --git a/reference/swoole/functions/swoole-async-write.xml b/reference/swoole/functions/swoole-async-write.xml index d401c3090..4c458dd84 100644 --- a/reference/swoole/functions/swoole-async-write.xml +++ b/reference/swoole/functions/swoole-async-write.xml @@ -16,9 +16,9 @@ intoffset callablecallback - + - + @@ -28,33 +28,33 @@ filename - + The filename being written. - + content - + The content writing to the file. - + offset - + The offset. - + callback - - - + + + @@ -62,9 +62,9 @@ &reftitle.returnvalues; - + &return.success; - + diff --git a/reference/swoole/functions/swoole-async-writefile.xml b/reference/swoole/functions/swoole-async-writefile.xml index d644b847a..4b0ab2c97 100644 --- a/reference/swoole/functions/swoole-async-writefile.xml +++ b/reference/swoole/functions/swoole-async-writefile.xml @@ -16,9 +16,9 @@ callablecallback intflags0 - + - + @@ -28,33 +28,33 @@ filename - - The filename being written. - + + The filename being written. + content - - The content writing to the file. - + + The content writing to the file. + callback - - - + + + flags - - - + + + @@ -62,9 +62,9 @@ &reftitle.returnvalues; - + &return.success; - + diff --git a/reference/swoole/functions/swoole-clear-error.xml b/reference/swoole/functions/swoole-clear-error.xml index 59262127d..b7cfd26ed 100644 --- a/reference/swoole/functions/swoole-clear-error.xml +++ b/reference/swoole/functions/swoole-clear-error.xml @@ -13,9 +13,9 @@ voidswoole_clear_error - + Clear errors in the socket or on the last error code. - + @@ -25,9 +25,9 @@ &reftitle.returnvalues; - + &return.void; - + diff --git a/reference/swoole/functions/swoole-client-select.xml b/reference/swoole/functions/swoole-client-select.xml index 783031aae..5db769998 100644 --- a/reference/swoole/functions/swoole-client-select.xml +++ b/reference/swoole/functions/swoole-client-select.xml @@ -16,9 +16,9 @@ arrayerror_array floattimeout0.5 - + - + @@ -28,33 +28,33 @@ read_array - - - + + + write_array - - - + + + error_array - - - + + + timeout - - - + + + @@ -62,9 +62,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/swoole/functions/swoole-cpu-num.xml b/reference/swoole/functions/swoole-cpu-num.xml index f76426910..5ae0ddc89 100644 --- a/reference/swoole/functions/swoole-cpu-num.xml +++ b/reference/swoole/functions/swoole-cpu-num.xml @@ -13,9 +13,9 @@ intswoole_cpu_num - + - + @@ -25,9 +25,9 @@ &reftitle.returnvalues; - + The number of CPU. - + diff --git a/reference/swoole/functions/swoole-errno.xml b/reference/swoole/functions/swoole-errno.xml index 5bea35a4d..353cb5edf 100644 --- a/reference/swoole/functions/swoole-errno.xml +++ b/reference/swoole/functions/swoole-errno.xml @@ -13,9 +13,9 @@ intswoole_errno - + - + @@ -26,9 +26,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/swoole/functions/swoole-error-log.xml b/reference/swoole/functions/swoole-error-log.xml index ec99fb9ad..f51f37114 100644 --- a/reference/swoole/functions/swoole-error-log.xml +++ b/reference/swoole/functions/swoole-error-log.xml @@ -14,9 +14,9 @@ intlevel stringmsg - + Output error messages to the log. - + @@ -25,7 +25,7 @@ level - + Log Level, constants can be used: SWOOLE_LOG_DEBUG, SWOOLE_LOG_TRACE, SWOOLE_LOG_INFO, @@ -33,15 +33,15 @@ SWOOLE_LOG_WARNING, SWOOLE_LOG_ERROR, SWOOLE_LOG_NONE - + msg - + Message content to be written to the log. - + @@ -49,9 +49,9 @@ &reftitle.returnvalues; - + &return.void; - + diff --git a/reference/swoole/functions/swoole-event-add.xml b/reference/swoole/functions/swoole-event-add.xml index d2591f6e5..432e0effe 100644 --- a/reference/swoole/functions/swoole-event-add.xml +++ b/reference/swoole/functions/swoole-event-add.xml @@ -16,9 +16,9 @@ callablewrite_callback intevents0 - + - + @@ -28,33 +28,33 @@ fd - - - + + + read_callback - - - + + + write_callback - - - + + + events - - - + + + @@ -62,9 +62,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/swoole/functions/swoole-event-defer.xml b/reference/swoole/functions/swoole-event-defer.xml index e44692ef2..fd3ea23a8 100644 --- a/reference/swoole/functions/swoole-event-defer.xml +++ b/reference/swoole/functions/swoole-event-defer.xml @@ -13,9 +13,9 @@ boolswoole_event_defer callablecallback - + - + @@ -25,9 +25,9 @@ callback - - - + + + @@ -35,9 +35,9 @@ &reftitle.returnvalues; - + &return.success; - + diff --git a/reference/swoole/functions/swoole-event-del.xml b/reference/swoole/functions/swoole-event-del.xml index 89a108e13..b2c3bc4bb 100644 --- a/reference/swoole/functions/swoole-event-del.xml +++ b/reference/swoole/functions/swoole-event-del.xml @@ -13,9 +13,9 @@ boolswoole_event_del intfd - + - + @@ -25,9 +25,9 @@ fd - - - + + + @@ -35,9 +35,9 @@ &reftitle.returnvalues; - + &return.success; - + diff --git a/reference/swoole/functions/swoole-event-exit.xml b/reference/swoole/functions/swoole-event-exit.xml index 4b1fcceed..691a3b1c7 100644 --- a/reference/swoole/functions/swoole-event-exit.xml +++ b/reference/swoole/functions/swoole-event-exit.xml @@ -13,9 +13,9 @@ voidswoole_event_exit - + - + @@ -26,9 +26,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/swoole/functions/swoole-event-set.xml b/reference/swoole/functions/swoole-event-set.xml index 049ab15c8..5ae7d1efd 100644 --- a/reference/swoole/functions/swoole-event-set.xml +++ b/reference/swoole/functions/swoole-event-set.xml @@ -16,9 +16,9 @@ callablewrite_callback intevents0 - + - + @@ -28,33 +28,33 @@ fd - - - + + + read_callback - - - + + + write_callback - - - + + + events - - - + + + @@ -62,9 +62,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/swoole/functions/swoole-event-wait.xml b/reference/swoole/functions/swoole-event-wait.xml index 86d454cbb..6b87b5c3d 100644 --- a/reference/swoole/functions/swoole-event-wait.xml +++ b/reference/swoole/functions/swoole-event-wait.xml @@ -13,9 +13,9 @@ voidswoole_event_wait - + - + @@ -26,9 +26,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/swoole/functions/swoole-event-write.xml b/reference/swoole/functions/swoole-event-write.xml index 87a84eead..3842600bf 100644 --- a/reference/swoole/functions/swoole-event-write.xml +++ b/reference/swoole/functions/swoole-event-write.xml @@ -14,9 +14,9 @@ intfd stringdata - + - + @@ -26,17 +26,17 @@ fd - - - + + + data - - - + + + @@ -44,9 +44,9 @@ &reftitle.returnvalues; - + &return.success; - + diff --git a/reference/swoole/functions/swoole-get-local-ip.xml b/reference/swoole/functions/swoole-get-local-ip.xml index 97856c840..3466fbad0 100644 --- a/reference/swoole/functions/swoole-get-local-ip.xml +++ b/reference/swoole/functions/swoole-get-local-ip.xml @@ -13,9 +13,9 @@ arrayswoole_get_local_ip - + - + @@ -26,9 +26,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/swoole/functions/swoole-last-error.xml b/reference/swoole/functions/swoole-last-error.xml index eb2814b84..beeba6ec2 100644 --- a/reference/swoole/functions/swoole-last-error.xml +++ b/reference/swoole/functions/swoole-last-error.xml @@ -13,9 +13,9 @@ intswoole_last_error - + - + @@ -26,9 +26,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/swoole/functions/swoole-load-module.xml b/reference/swoole/functions/swoole-load-module.xml index 88f8f37d4..09d22362b 100644 --- a/reference/swoole/functions/swoole-load-module.xml +++ b/reference/swoole/functions/swoole-load-module.xml @@ -13,9 +13,9 @@ mixedswoole_load_module stringfilename - + - + @@ -26,9 +26,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/swoole/functions/swoole-select.xml b/reference/swoole/functions/swoole-select.xml index 9b575039e..9aae60da9 100644 --- a/reference/swoole/functions/swoole-select.xml +++ b/reference/swoole/functions/swoole-select.xml @@ -16,9 +16,9 @@ arrayerror_array floattimeout - + - + @@ -28,33 +28,33 @@ read_array - - - + + + write_array - - - + + + error_array - - - + + + timeout - - - + + + @@ -62,9 +62,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/swoole/functions/swoole-set-process-name.xml b/reference/swoole/functions/swoole-set-process-name.xml index ca62f2f54..e7ff14c5c 100644 --- a/reference/swoole/functions/swoole-set-process-name.xml +++ b/reference/swoole/functions/swoole-set-process-name.xml @@ -14,9 +14,9 @@ stringprocess_name intsize128 - + - + @@ -26,9 +26,9 @@ process_name - - - + + + @@ -36,9 +36,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/swoole/functions/swoole-strerror.xml b/reference/swoole/functions/swoole-strerror.xml index d4807931a..03e404a6e 100644 --- a/reference/swoole/functions/swoole-strerror.xml +++ b/reference/swoole/functions/swoole-strerror.xml @@ -14,9 +14,9 @@ interrno interror_type0 - + - + @@ -26,9 +26,9 @@ errno - - - + + + @@ -36,9 +36,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/swoole/functions/swoole-timer-after.xml b/reference/swoole/functions/swoole-timer-after.xml index 53c30ff90..28b1fea6d 100644 --- a/reference/swoole/functions/swoole-timer-after.xml +++ b/reference/swoole/functions/swoole-timer-after.xml @@ -15,9 +15,9 @@ callablecallback mixedparam - + - + @@ -27,25 +27,25 @@ ms - - - + + + callback - - - + + + param - - - + + + @@ -53,9 +53,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/swoole/functions/swoole-timer-exists.xml b/reference/swoole/functions/swoole-timer-exists.xml index 44c8de59e..b7ab1adfb 100644 --- a/reference/swoole/functions/swoole-timer-exists.xml +++ b/reference/swoole/functions/swoole-timer-exists.xml @@ -13,9 +13,9 @@ boolswoole_timer_exists inttimer_id - + - + @@ -25,9 +25,9 @@ timer_id - - - + + + @@ -35,9 +35,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/swoole/functions/swoole-timer-tick.xml b/reference/swoole/functions/swoole-timer-tick.xml index b70a9dc30..131c0f31e 100644 --- a/reference/swoole/functions/swoole-timer-tick.xml +++ b/reference/swoole/functions/swoole-timer-tick.xml @@ -15,9 +15,9 @@ callablecallback mixedparam - + - + @@ -27,17 +27,17 @@ ms - - - + + + callback - - - + + + @@ -45,9 +45,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/swoole/functions/swoole-version.xml b/reference/swoole/functions/swoole-version.xml index 9f5dadfe4..6bb0c4cc7 100644 --- a/reference/swoole/functions/swoole-version.xml +++ b/reference/swoole/functions/swoole-version.xml @@ -13,9 +13,9 @@ stringswoole_version - + - + @@ -26,9 +26,9 @@ &reftitle.returnvalues; - + The version of Swoole. - + diff --git a/reference/swoole/ini.xml b/reference/swoole/ini.xml index 545f63cde..d58b2d5db 100644 --- a/reference/swoole/ini.xml +++ b/reference/swoole/ini.xml @@ -68,9 +68,9 @@ string - + Enable/disable the extension's built-in library. - + @@ -79,9 +79,9 @@ string - + Enable/disable use the xdebug extension to debug Swoole programs. - + @@ -90,9 +90,9 @@ string - + Prevent some coroutines from consuming CPU time for too long in a tight loop (10ms of CPU time), preventing other coroutines from getting scheduled. - + @@ -101,9 +101,9 @@ string - + Enable/disable displaying Swoole error messages. - + @@ -112,9 +112,9 @@ string - + Enable/disable short aliases. - + @@ -123,9 +123,9 @@ int - + Set the size of the Socket buffer for inter-process communication. - + diff --git a/reference/swoole/setup.xml b/reference/swoole/setup.xml index 78b1e18d8..2ac7feacf 100644 --- a/reference/swoole/setup.xml +++ b/reference/swoole/setup.xml @@ -6,37 +6,37 @@
    &reftitle.required; - + Swoole requires the libbrotli library. - - + + Enabling --enable-swoole-curl option requires the libcurl library, and both PHP and Swoole must link to the same libcurl shared library and headers to avoid undefined behavior. - - + + Enabling --enable-iouring option requires liburing library (version >= 2.0) and Linux kernel (version >= 5.12). - - + + Enabling --enable-swoole-thread option requires PHP to be in ZTS (Zend Thread Safety) mode. - - + + Enabling the --enable-cares option requires the libc-ares library. - - + + Enabling the --enable-zstd option requires the libzstd library (version >= 1.4.0). - - + + Enabling the --enable-swoole-sqlite option requires the libsqlite library. - - + + Enabling the --enable-swoole-pgsql option requires the libpq library. - - + + Enabling the --with-swoole-odbc option requires the unixodbc-dev library. - - + + Enabling the --with-swoole-oracle option requires the Oracle Instant Client libraries. - +
    diff --git a/reference/swoole/swoole.async.xml b/reference/swoole/swoole.async.xml index cd574e085..dc7fcc467 100644 --- a/reference/swoole/swoole.async.xml +++ b/reference/swoole/swoole.async.xml @@ -11,9 +11,9 @@
    &reftitle.intro; - + - +
    @@ -31,7 +31,7 @@ - + &Methods; diff --git a/reference/swoole/swoole.atomic.xml b/reference/swoole/swoole.atomic.xml index ecc7cdef9..9e319f6a3 100644 --- a/reference/swoole/swoole.atomic.xml +++ b/reference/swoole/swoole.atomic.xml @@ -11,9 +11,9 @@
    &reftitle.intro; - + - +
    @@ -31,7 +31,7 @@ - + &Methods; diff --git a/reference/swoole/swoole.buffer.xml b/reference/swoole/swoole.buffer.xml index dc91b9c24..b5acd1141 100644 --- a/reference/swoole/swoole.buffer.xml +++ b/reference/swoole/swoole.buffer.xml @@ -11,9 +11,9 @@
    &reftitle.intro; - + - +
    @@ -31,7 +31,7 @@ - + &Methods; diff --git a/reference/swoole/swoole.channel.xml b/reference/swoole/swoole.channel.xml index 069131cf9..5a3d3a433 100644 --- a/reference/swoole/swoole.channel.xml +++ b/reference/swoole/swoole.channel.xml @@ -11,9 +11,9 @@
    &reftitle.intro; - + - +
    @@ -31,7 +31,7 @@ - + &Methods; diff --git a/reference/swoole/swoole.client.xml b/reference/swoole/swoole.client.xml index edfd68947..4d4bb024b 100644 --- a/reference/swoole/swoole.client.xml +++ b/reference/swoole/swoole.client.xml @@ -11,9 +11,9 @@
    &reftitle.intro; - + - +
    @@ -91,25 +91,25 @@ errCode - + sock - + reuse - + reuseCount - + @@ -125,28 +125,28 @@ Swoole\Client::MSG_OOB - + Swoole\Client::MSG_PEEK - + Swoole\Client::MSG_DONTWAIT - + Swoole\Client::MSG_WAITALL - + diff --git a/reference/swoole/swoole.connection.iterator.xml b/reference/swoole/swoole.connection.iterator.xml index 606297721..f6559e5f6 100644 --- a/reference/swoole/swoole.connection.iterator.xml +++ b/reference/swoole/swoole.connection.iterator.xml @@ -11,9 +11,9 @@
    &reftitle.intro; - + - +
    @@ -29,7 +29,7 @@ Swoole\Connection\Iterator - + Iterator @@ -43,7 +43,7 @@ - + &Methods; diff --git a/reference/swoole/swoole.coroutine.client.xml b/reference/swoole/swoole.coroutine.client.xml index bd732fadf..a5bbcade0 100644 --- a/reference/swoole/swoole.coroutine.client.xml +++ b/reference/swoole/swoole.coroutine.client.xml @@ -11,9 +11,9 @@
    &reftitle.intro; - + - +
    @@ -82,13 +82,13 @@ errCode - + sock - + @@ -104,28 +104,28 @@ Swoole\Coroutine\Client::MSG_OOB - + Swoole\Coroutine\Client::MSG_PEEK - + Swoole\Coroutine\Client::MSG_DONTWAIT - + Swoole\Coroutine\Client::MSG_WAITALL - + diff --git a/reference/swoole/swoole.coroutine.http.client.xml b/reference/swoole/swoole.coroutine.http.client.xml index df629fdeb..19be842ca 100644 --- a/reference/swoole/swoole.coroutine.http.client.xml +++ b/reference/swoole/swoole.coroutine.http.client.xml @@ -11,9 +11,9 @@
    &reftitle.intro; - + - +
    @@ -41,7 +41,7 @@ sock - + &Methods; @@ -49,7 +49,7 @@
    - +
    &reftitle.properties; @@ -57,13 +57,13 @@ errCode - + sock - + diff --git a/reference/swoole/swoole.coroutine.lock.xml b/reference/swoole/swoole.coroutine.lock.xml index d536aeca8..fd082bb0e 100644 --- a/reference/swoole/swoole.coroutine.lock.xml +++ b/reference/swoole/swoole.coroutine.lock.xml @@ -11,38 +11,38 @@
    &reftitle.intro; - + Swoole 6.0.1 introduced a coroutine lock that supports inter-process and inter-thread sharing. This lock is designed with non-blocking behavior and enables efficient coroutine synchronization in multi-process and multi-thread environments. - - + + When compiled with the --enable-iouring option and the Linux kernel supports the io_uring futex feature, Swoole's coroutine lock implements synchronization using io_uring futex. In this case, coroutines wait for lock wakeups using an efficient queuing mechanism, significantly improving performance. - - + + Without io_uring futex, the coroutine lock falls back to an exponential backoff sleep mechanism, where the wait time increases by 2^n milliseconds (n being the number of failures) after each failed attempt to acquire the lock. While this approach avoids busy waiting, it introduces additional CPU scheduling overhead and latency. - - + + The coroutine lock is reentrant, allowing the currently holding coroutine to safely perform multiple lock operations. - + - + Do not create locks in callback functions like onReceive, as this will cause continuous memory growth and lead to memory leaks. - + - + Locking and unlocking must be performed in the same coroutine, otherwise it will break static conditions. - +
    diff --git a/reference/swoole/swoole.coroutine.mysql.exception.xml b/reference/swoole/swoole.coroutine.mysql.exception.xml index 5bcff61f2..9f195d1d1 100644 --- a/reference/swoole/swoole.coroutine.mysql.exception.xml +++ b/reference/swoole/swoole.coroutine.mysql.exception.xml @@ -11,9 +11,9 @@
    &reftitle.intro; - + - +
    @@ -29,12 +29,12 @@ Swoole\Coroutine\MySQL\Exception - + extends Exception - + Throwable diff --git a/reference/swoole/swoole.coroutine.mysql.xml b/reference/swoole/swoole.coroutine.mysql.xml index c1cecd30a..dd1122470 100644 --- a/reference/swoole/swoole.coroutine.mysql.xml +++ b/reference/swoole/swoole.coroutine.mysql.xml @@ -11,9 +11,9 @@
    &reftitle.intro; - + - +
    @@ -65,7 +65,7 @@ errno - + &Methods; @@ -73,7 +73,7 @@
    - +
    &reftitle.properties; @@ -81,49 +81,49 @@ sock - + connected - + connect_error - + connect_errno - + affected_rows - + insert_id - + error - + errno - + diff --git a/reference/swoole/swoole.coroutine.xml b/reference/swoole/swoole.coroutine.xml index 3a3fa69bf..17021fca4 100644 --- a/reference/swoole/swoole.coroutine.xml +++ b/reference/swoole/swoole.coroutine.xml @@ -11,9 +11,9 @@
    &reftitle.intro; - + - +
    @@ -31,7 +31,7 @@ - + &Methods; diff --git a/reference/swoole/swoole.event.xml b/reference/swoole/swoole.event.xml index d4cb09ec8..a9400bc07 100644 --- a/reference/swoole/swoole.event.xml +++ b/reference/swoole/swoole.event.xml @@ -101,7 +101,7 @@ - + &Methods; diff --git a/reference/swoole/swoole.exception.xml b/reference/swoole/swoole.exception.xml index 38bf56259..6dcd6a969 100644 --- a/reference/swoole/swoole.exception.xml +++ b/reference/swoole/swoole.exception.xml @@ -11,9 +11,9 @@
    &reftitle.intro; - + - +
    @@ -29,12 +29,12 @@ Swoole\Exception - + extends Exception - + Throwable diff --git a/reference/swoole/swoole.http.client.xml b/reference/swoole/swoole.http.client.xml index 82f6c335c..c71b6b6f8 100644 --- a/reference/swoole/swoole.http.client.xml +++ b/reference/swoole/swoole.http.client.xml @@ -11,9 +11,9 @@
    &reftitle.intro; - + - +
    @@ -41,7 +41,7 @@ sock - + &Methods; @@ -49,7 +49,7 @@
    - +
    &reftitle.properties; @@ -57,13 +57,13 @@ errCode - + sock - + diff --git a/reference/swoole/swoole.http.request.xml b/reference/swoole/swoole.http.request.xml index ac696c7e3..4e1f6fdf2 100644 --- a/reference/swoole/swoole.http.request.xml +++ b/reference/swoole/swoole.http.request.xml @@ -11,9 +11,9 @@
    &reftitle.intro; - + - +
    @@ -31,7 +31,7 @@ - + &Methods; diff --git a/reference/swoole/swoole.http.response.xml b/reference/swoole/swoole.http.response.xml index 202af8911..128f4f002 100644 --- a/reference/swoole/swoole.http.response.xml +++ b/reference/swoole/swoole.http.response.xml @@ -11,9 +11,9 @@
    &reftitle.intro; - + - +
    @@ -31,7 +31,7 @@ - + &Methods; diff --git a/reference/swoole/swoole.http.server.xml b/reference/swoole/swoole.http.server.xml index 81ad542fa..37594e9db 100644 --- a/reference/swoole/swoole.http.server.xml +++ b/reference/swoole/swoole.http.server.xml @@ -11,9 +11,9 @@
    &reftitle.intro; - + - +
    @@ -29,17 +29,17 @@ Swoole\Http\Server - + extends Swoole\Server - + &Methods; - + &InheritedMethods; diff --git a/reference/swoole/swoole.lock.xml b/reference/swoole/swoole.lock.xml index 534f732ff..6f1292b85 100644 --- a/reference/swoole/swoole.lock.xml +++ b/reference/swoole/swoole.lock.xml @@ -11,9 +11,9 @@
    &reftitle.intro; - + - +
    @@ -31,7 +31,7 @@ - + &Methods; diff --git a/reference/swoole/swoole.mmap.xml b/reference/swoole/swoole.mmap.xml index 559f6ccac..9bccbbffa 100644 --- a/reference/swoole/swoole.mmap.xml +++ b/reference/swoole/swoole.mmap.xml @@ -11,9 +11,9 @@
    &reftitle.intro; - + - +
    @@ -31,7 +31,7 @@ - + &Methods; diff --git a/reference/swoole/swoole.module.xml b/reference/swoole/swoole.module.xml index 3378860b9..86e203444 100644 --- a/reference/swoole/swoole.module.xml +++ b/reference/swoole/swoole.module.xml @@ -11,9 +11,9 @@
    &reftitle.intro; - + - +
    @@ -31,7 +31,7 @@ - + diff --git a/reference/swoole/swoole.mysql.exception.xml b/reference/swoole/swoole.mysql.exception.xml index d28af0064..db39b277e 100644 --- a/reference/swoole/swoole.mysql.exception.xml +++ b/reference/swoole/swoole.mysql.exception.xml @@ -11,9 +11,9 @@
    &reftitle.intro; - + - +
    @@ -29,12 +29,12 @@ Swoole\MySQL\Exception - + extends Exception - + Throwable diff --git a/reference/swoole/swoole.mysql.xml b/reference/swoole/swoole.mysql.xml index 1a5faa42a..4170da6b2 100644 --- a/reference/swoole/swoole.mysql.xml +++ b/reference/swoole/swoole.mysql.xml @@ -11,9 +11,9 @@
    &reftitle.intro; - + - +
    @@ -31,7 +31,7 @@ - + &Methods; diff --git a/reference/swoole/swoole.process.xml b/reference/swoole/swoole.process.xml index cdcd85849..1b5e5e4bf 100644 --- a/reference/swoole/swoole.process.xml +++ b/reference/swoole/swoole.process.xml @@ -11,9 +11,9 @@
    &reftitle.intro; - + - +
    @@ -54,7 +54,7 @@ Swoole\Process::IPC_NOWAIT - + diff --git a/reference/swoole/swoole.redis.server.xml b/reference/swoole/swoole.redis.server.xml index 3c7d5f64e..4d7bd1027 100644 --- a/reference/swoole/swoole.redis.server.xml +++ b/reference/swoole/swoole.redis.server.xml @@ -11,9 +11,9 @@
    &reftitle.intro; - + - +
    @@ -99,49 +99,49 @@ Swoole\Redis\Server::NIL - + Swoole\Redis\Server::ERROR - + Swoole\Redis\Server::STATUS - + Swoole\Redis\Server::INT - + Swoole\Redis\Server::STRING - + Swoole\Redis\Server::SET - + Swoole\Redis\Server::MAP - + diff --git a/reference/swoole/swoole.runtime.xml b/reference/swoole/swoole.runtime.xml index d96fd45b9..6f27cc3c4 100644 --- a/reference/swoole/swoole.runtime.xml +++ b/reference/swoole/swoole.runtime.xml @@ -11,10 +11,10 @@
    &reftitle.intro; - + Swoole\Runtime provides coroutine support for various PHP functions through hook mechanism, allowing synchronous code to work asynchronously in coroutine environment. - +
    diff --git a/reference/swoole/swoole.serialize.xml b/reference/swoole/swoole.serialize.xml index 1cab8e2d9..762c9ede8 100644 --- a/reference/swoole/swoole.serialize.xml +++ b/reference/swoole/swoole.serialize.xml @@ -11,9 +11,9 @@
    &reftitle.intro; - + - +
    @@ -31,7 +31,7 @@ - + &Methods; diff --git a/reference/swoole/swoole.server.port.xml b/reference/swoole/swoole.server.port.xml index 58ce58da5..8b12c93d3 100644 --- a/reference/swoole/swoole.server.port.xml +++ b/reference/swoole/swoole.server.port.xml @@ -11,9 +11,9 @@
    &reftitle.intro; - + - +
    @@ -31,7 +31,7 @@ - + &Methods; diff --git a/reference/swoole/swoole.server.xml b/reference/swoole/swoole.server.xml index a46137f00..333972d86 100644 --- a/reference/swoole/swoole.server.xml +++ b/reference/swoole/swoole.server.xml @@ -11,9 +11,9 @@
    &reftitle.intro; - + - +
    @@ -31,7 +31,7 @@ - + &Methods; diff --git a/reference/swoole/swoole.table.xml b/reference/swoole/swoole.table.xml index 28d54f8bd..d37b7a4dd 100644 --- a/reference/swoole/swoole.table.xml +++ b/reference/swoole/swoole.table.xml @@ -11,9 +11,9 @@
    &reftitle.intro; - + - +
    @@ -74,21 +74,21 @@ Swoole\Table::TYPE_INT - + Swoole\Table::TYPE_STRING - + Swoole\Table::TYPE_FLOAT - + diff --git a/reference/swoole/swoole.timer.xml b/reference/swoole/swoole.timer.xml index d39a63a9b..b143c9e34 100644 --- a/reference/swoole/swoole.timer.xml +++ b/reference/swoole/swoole.timer.xml @@ -90,7 +90,7 @@ Swoole\Event::defer(function () { - + &Methods; diff --git a/reference/swoole/swoole.websocket.frame.xml b/reference/swoole/swoole.websocket.frame.xml index 6717a14ae..8195fc15a 100644 --- a/reference/swoole/swoole.websocket.frame.xml +++ b/reference/swoole/swoole.websocket.frame.xml @@ -11,9 +11,9 @@
    &reftitle.intro; - + - +
    @@ -31,9 +31,9 @@ - + &Methods; - + diff --git a/reference/swoole/swoole.websocket.server.xml b/reference/swoole/swoole.websocket.server.xml index 63c2a1732..b846027aa 100644 --- a/reference/swoole/swoole.websocket.server.xml +++ b/reference/swoole/swoole.websocket.server.xml @@ -11,9 +11,9 @@
    &reftitle.intro; - + - +
    @@ -29,17 +29,17 @@ Swoole\WebSocket\Server - + extends Swoole\Http\Server - + &Methods; - + &InheritedMethods; diff --git a/reference/swoole/swoole/async/dnslookup.xml b/reference/swoole/swoole/async/dnslookup.xml index 321231bc7..ed299bcfd 100644 --- a/reference/swoole/swoole/async/dnslookup.xml +++ b/reference/swoole/swoole/async/dnslookup.xml @@ -14,9 +14,9 @@ stringhostname callablecallback - + - + &warn.undocumented.func; @@ -28,9 +28,9 @@ hostname - + The host name. - + @@ -45,17 +45,17 @@ hostname - + The host name. - + IP - + The IP address. - + diff --git a/reference/swoole/swoole/async/read.xml b/reference/swoole/swoole/async/read.xml index 9082f7408..81e0fb8f0 100644 --- a/reference/swoole/swoole/async/read.xml +++ b/reference/swoole/swoole/async/read.xml @@ -16,9 +16,9 @@ intchunk_size intoffset - + - + @@ -28,9 +28,9 @@ filename - + The name of the file. - + @@ -45,9 +45,9 @@ filename - + The name of the file. - + @@ -64,17 +64,17 @@ chunk_size - + The chunk length. - + offset - + The offset. - + @@ -82,9 +82,9 @@ &reftitle.returnvalues; - + Whether the read is succeed. - + diff --git a/reference/swoole/swoole/async/readfile.xml b/reference/swoole/swoole/async/readfile.xml index 1533c8542..fbbeb38bc 100644 --- a/reference/swoole/swoole/async/readfile.xml +++ b/reference/swoole/swoole/async/readfile.xml @@ -14,9 +14,9 @@ stringfilename callablecallback - + - + @@ -26,9 +26,9 @@ filename - - The filename of the file being read. - + + The filename of the file being read. + @@ -43,9 +43,9 @@ filename - + The name of the file. - + diff --git a/reference/swoole/swoole/async/set.xml b/reference/swoole/swoole/async/set.xml index a957827c8..94db15957 100644 --- a/reference/swoole/swoole/async/set.xml +++ b/reference/swoole/swoole/async/set.xml @@ -13,9 +13,9 @@ public static voidSwoole\Async::set arraysettings - + - + @@ -25,9 +25,9 @@ settings - - - + + + diff --git a/reference/swoole/swoole/async/write.xml b/reference/swoole/swoole/async/write.xml index 55fe48044..f4d9be156 100644 --- a/reference/swoole/swoole/async/write.xml +++ b/reference/swoole/swoole/async/write.xml @@ -16,9 +16,9 @@ intoffset callablecallback - + - + @@ -28,33 +28,33 @@ filename - + The filename being written. - + content - + The content writing to the file. - + offset - + The offset. - + callback - - - + + + diff --git a/reference/swoole/swoole/async/writefile.xml b/reference/swoole/swoole/async/writefile.xml index a6ffa74a2..5ea4d772d 100644 --- a/reference/swoole/swoole/async/writefile.xml +++ b/reference/swoole/swoole/async/writefile.xml @@ -16,9 +16,9 @@ callablecallback stringflags - + - + &warn.undocumented.func; @@ -30,33 +30,33 @@ filename - - The filename being written. - + + The filename being written. + content - - The content writing to the file. - + + The content writing to the file. + callback - - - + + + flags - - - + + + diff --git a/reference/swoole/swoole/atomic/add.xml b/reference/swoole/swoole/atomic/add.xml index d43df187d..019d34029 100644 --- a/reference/swoole/swoole/atomic/add.xml +++ b/reference/swoole/swoole/atomic/add.xml @@ -13,9 +13,9 @@ public intSwoole\Atomic::add intadd_value - + Add a number to the value to the atomic object. - + @@ -25,9 +25,9 @@ add_value - + The value which will be added to the current value. - + @@ -35,9 +35,9 @@ &reftitle.returnvalues; - + The new value of the atomic object. - + diff --git a/reference/swoole/swoole/atomic/cmpset.xml b/reference/swoole/swoole/atomic/cmpset.xml index 6c049d5d6..c8ed289ff 100644 --- a/reference/swoole/swoole/atomic/cmpset.xml +++ b/reference/swoole/swoole/atomic/cmpset.xml @@ -14,9 +14,9 @@ intcmp_value intnew_value - + - + @@ -26,18 +26,18 @@ cmp_value - + The value to compare with the current value of the atomic object. - + new_value - + The value to set to the atomic object if the cmp_value is the same as the current value of the atomic object. - + @@ -45,9 +45,9 @@ &reftitle.returnvalues; - + The new value of the atomic object. - + diff --git a/reference/swoole/swoole/atomic/construct.xml b/reference/swoole/swoole/atomic/construct.xml index 17e912223..13d8335e4 100644 --- a/reference/swoole/swoole/atomic/construct.xml +++ b/reference/swoole/swoole/atomic/construct.xml @@ -13,17 +13,17 @@ public Swoole\Atomic::__construct intvalue - + Swoole atomic object is an integer variable allows any processor to atomically test and modify. - It is implemented based on CPU atomic instructions. The Swoole atomic variables have to + It is implemented based on CPU atomic instructions. The Swoole atomic variables have to defined before swoole_server->start. - + - - Compare-and-swap (CAS) is an atomic instruction used in multithreading to achieve synchronization. - It compares the content of a memory location with a given value and, only if they are the same, + + Compare-and-swap (CAS) is an atomic instruction used in multithreading to achieve synchronization. + It compares the content of a memory location with a given value and, only if they are the same, modifies the content of that memory location to a new given value. - + @@ -33,9 +33,9 @@ value - + The value of the atomic object. - + diff --git a/reference/swoole/swoole/atomic/get.xml b/reference/swoole/swoole/atomic/get.xml index 35296bb50..e55392523 100644 --- a/reference/swoole/swoole/atomic/get.xml +++ b/reference/swoole/swoole/atomic/get.xml @@ -13,9 +13,9 @@ public intSwoole\Atomic::get - + Get the current value of the atomic object. - + @@ -26,9 +26,9 @@ &reftitle.returnvalues; - + The current value of the atomic object. - + diff --git a/reference/swoole/swoole/atomic/set.xml b/reference/swoole/swoole/atomic/set.xml index fd382748f..f961c2d26 100644 --- a/reference/swoole/swoole/atomic/set.xml +++ b/reference/swoole/swoole/atomic/set.xml @@ -13,9 +13,9 @@ public intSwoole\Atomic::set intvalue - + Set a new value to the atomic object. - + &warn.undocumented.func; @@ -27,9 +27,9 @@ value - - The value to set to the atomic object. - + + The value to set to the atomic object. + @@ -37,9 +37,9 @@ &reftitle.returnvalues; - + The current value of the atomic object. - + diff --git a/reference/swoole/swoole/atomic/sub.xml b/reference/swoole/swoole/atomic/sub.xml index 9010dc66a..7229ceb2a 100644 --- a/reference/swoole/swoole/atomic/sub.xml +++ b/reference/swoole/swoole/atomic/sub.xml @@ -13,9 +13,9 @@ public intSwoole\Atomic::sub intsub_value - + Subtract a number to the value of the atomic object. - + @@ -25,9 +25,9 @@ sub_value - + The value which will be subtracted to the current value. - + @@ -35,9 +35,9 @@ &reftitle.returnvalues; - + The current value of the atomic object. - + diff --git a/reference/swoole/swoole/buffer/append.xml b/reference/swoole/swoole/buffer/append.xml index c988d2d3a..5cd45fca6 100644 --- a/reference/swoole/swoole/buffer/append.xml +++ b/reference/swoole/swoole/buffer/append.xml @@ -13,9 +13,9 @@ public intSwoole\Buffer::append stringdata - + - + @@ -25,9 +25,9 @@ data - + The string or binary data to append at the end of the memory buffer. - + @@ -35,9 +35,9 @@ &reftitle.returnvalues; - + The new size of the memory buffer. - + diff --git a/reference/swoole/swoole/buffer/clear.xml b/reference/swoole/swoole/buffer/clear.xml index 1916bbbd2..14a8e371b 100644 --- a/reference/swoole/swoole/buffer/clear.xml +++ b/reference/swoole/swoole/buffer/clear.xml @@ -13,9 +13,9 @@ public voidSwoole\Buffer::clear - + - + diff --git a/reference/swoole/swoole/buffer/construct.xml b/reference/swoole/swoole/buffer/construct.xml index 4be5c5acc..311c90cdd 100644 --- a/reference/swoole/swoole/buffer/construct.xml +++ b/reference/swoole/swoole/buffer/construct.xml @@ -13,9 +13,9 @@ public Swoole\Buffer::__construct intsize - + - + @@ -25,9 +25,9 @@ size - + The size of the memory to allocate. - + @@ -39,7 +39,7 @@ &reftitle.returnvalues; - + --> diff --git a/reference/swoole/swoole/buffer/destruct.xml b/reference/swoole/swoole/buffer/destruct.xml index 20ff82485..f7adbfea8 100644 --- a/reference/swoole/swoole/buffer/destruct.xml +++ b/reference/swoole/swoole/buffer/destruct.xml @@ -13,9 +13,9 @@ public voidSwoole\Buffer::__destruct - + - + &warn.undocumented.func; diff --git a/reference/swoole/swoole/buffer/expand.xml b/reference/swoole/swoole/buffer/expand.xml index eaf519321..ad0af409d 100644 --- a/reference/swoole/swoole/buffer/expand.xml +++ b/reference/swoole/swoole/buffer/expand.xml @@ -13,9 +13,9 @@ public intSwoole\Buffer::expand intsize - + - + @@ -25,9 +25,9 @@ size - + The new size of the memory buffer. - + @@ -35,9 +35,9 @@ &reftitle.returnvalues; - + The new size of the memory buffer. - + diff --git a/reference/swoole/swoole/buffer/read.xml b/reference/swoole/swoole/buffer/read.xml index e71a1c4a4..d063c7371 100644 --- a/reference/swoole/swoole/buffer/read.xml +++ b/reference/swoole/swoole/buffer/read.xml @@ -14,9 +14,9 @@ intoffset intlength - + - + @@ -26,17 +26,17 @@ offset - + The offset. - + length - + The length. - + diff --git a/reference/swoole/swoole/buffer/recycle.xml b/reference/swoole/swoole/buffer/recycle.xml index adea583fe..8cf19d301 100644 --- a/reference/swoole/swoole/buffer/recycle.xml +++ b/reference/swoole/swoole/buffer/recycle.xml @@ -13,9 +13,9 @@ public voidSwoole\Buffer::recycle - + - + diff --git a/reference/swoole/swoole/buffer/substr.xml b/reference/swoole/swoole/buffer/substr.xml index 9ee5d794e..f479a01cc 100644 --- a/reference/swoole/swoole/buffer/substr.xml +++ b/reference/swoole/swoole/buffer/substr.xml @@ -15,10 +15,10 @@ intlength boolremove - - If $remove is set to be true and $offset is set to be 0, the data will be removed from the buffer. + + If $remove is set to be true and $offset is set to be 0, the data will be removed from the buffer. The memory for storing the data will be released when the buffer object is deconstructed. - + @@ -28,25 +28,25 @@ offset - + The offset. - + length - + The length. - + remove - + Whether to remove the data from the memory buffer. - + diff --git a/reference/swoole/swoole/buffer/tostring.xml b/reference/swoole/swoole/buffer/tostring.xml index 5446fa179..86b209ce3 100644 --- a/reference/swoole/swoole/buffer/tostring.xml +++ b/reference/swoole/swoole/buffer/tostring.xml @@ -13,9 +13,9 @@ public stringSwoole\Buffer::__toString - + - + @@ -26,9 +26,9 @@ &reftitle.returnvalues; - + The string value of the memory buffer. - + diff --git a/reference/swoole/swoole/buffer/write.xml b/reference/swoole/swoole/buffer/write.xml index 079b956fb..81151015c 100644 --- a/reference/swoole/swoole/buffer/write.xml +++ b/reference/swoole/swoole/buffer/write.xml @@ -14,9 +14,9 @@ intoffset stringdata - + - + @@ -26,17 +26,17 @@ offset - + The offset. - + data - + The data to write to the memory buffer. - + @@ -44,9 +44,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/swoole/swoole/channel/construct.xml b/reference/swoole/swoole/channel/construct.xml index ba499f24c..2288ad577 100644 --- a/reference/swoole/swoole/channel/construct.xml +++ b/reference/swoole/swoole/channel/construct.xml @@ -13,12 +13,12 @@ public Swoole\Channel::__construct stringsize - - Swoole channel is memory data structure works like Chan in Golang, implemented based on + + Swoole channel is memory data structure works like Chan in Golang, implemented based on shared memory and mutex locks. It can be used as high performance message queue in memory. Construct a swoole channel with a fixed size. The minimum size of a swoole channel is 64KB. Exceptions will be thrown if there is not enough memory. - + @@ -28,9 +28,9 @@ size - + The size of the Swoole channel. - + diff --git a/reference/swoole/swoole/channel/destruct.xml b/reference/swoole/swoole/channel/destruct.xml index 21f4a160e..d5109bf3c 100644 --- a/reference/swoole/swoole/channel/destruct.xml +++ b/reference/swoole/swoole/channel/destruct.xml @@ -13,9 +13,9 @@ public voidSwoole\Channel::__destruct - + - + diff --git a/reference/swoole/swoole/channel/pop.xml b/reference/swoole/swoole/channel/pop.xml index c03fc5f75..b9fdac8cc 100644 --- a/reference/swoole/swoole/channel/pop.xml +++ b/reference/swoole/swoole/channel/pop.xml @@ -13,9 +13,9 @@ public mixedSwoole\Channel::pop - + - + @@ -26,9 +26,9 @@ &reftitle.returnvalues; - + If the channel is empty, the function will return false, or return the unserialized data. - + diff --git a/reference/swoole/swoole/channel/push.xml b/reference/swoole/swoole/channel/push.xml index 9c138f0d2..70cf2b1c5 100644 --- a/reference/swoole/swoole/channel/push.xml +++ b/reference/swoole/swoole/channel/push.xml @@ -13,15 +13,15 @@ public boolSwoole\Channel::push stringdata - + Data can be any non-empty PHP variable, the variable will be serialized if it is not string type. - - + + If size of the data is more than 8KB, swoole channel will use temp files storage. - - + + The function will return true if the write operation is succeeded, or return false if there is not enough space. - + @@ -31,9 +31,9 @@ data - + The data to push into the Swoole channel. - + diff --git a/reference/swoole/swoole/channel/stats.xml b/reference/swoole/swoole/channel/stats.xml index 54dd7f4a2..6eb3d9c9a 100644 --- a/reference/swoole/swoole/channel/stats.xml +++ b/reference/swoole/swoole/channel/stats.xml @@ -13,9 +13,9 @@ public arraySwoole\Channel::stats - + Get the numbers of queued elements and total size of the memory used by the queue. - + @@ -26,9 +26,9 @@ &reftitle.returnvalues; - + The stats of the Swoole channel. - + diff --git a/reference/swoole/swoole/client/close.xml b/reference/swoole/swoole/client/close.xml index 5f891d4fe..56e74a54b 100644 --- a/reference/swoole/swoole/client/close.xml +++ b/reference/swoole/swoole/client/close.xml @@ -13,9 +13,9 @@ public boolSwoole\Client::close boolforce - + - + @@ -25,9 +25,9 @@ force - + Whether force to close the connection. - + @@ -35,9 +35,9 @@ &reftitle.returnvalues; - + Whether the connection is closed. - + diff --git a/reference/swoole/swoole/client/connect.xml b/reference/swoole/swoole/client/connect.xml index 8314fb134..510454f6c 100644 --- a/reference/swoole/swoole/client/connect.xml +++ b/reference/swoole/swoole/client/connect.xml @@ -16,9 +16,9 @@ inttimeout intflag - + - + @@ -28,35 +28,35 @@ host - + The host name of the remote address. - + port - + The port number of the remote address. - + timeout - + The timeout(second) of connect/send/recv, the default value is 0.1s - + flag - - If the type of client is UDP, the $flag means if to enable the configuration udp_connect. + + If the type of client is UDP, the $flag means if to enable the configuration udp_connect. If the configuration udp_connect is enabled, the client will only receive the data from specified ip:port. If the type of client is TCP and the $flag is set to 1, it must use swoole_client_select to check the connection status before send/recv. - + @@ -64,9 +64,9 @@ &reftitle.returnvalues; - + Whether the connection is established. - + diff --git a/reference/swoole/swoole/client/construct.xml b/reference/swoole/swoole/client/construct.xml index b0e0e488a..31396afdf 100644 --- a/reference/swoole/swoole/client/construct.xml +++ b/reference/swoole/swoole/client/construct.xml @@ -14,9 +14,9 @@ intsock_type intis_async - + - + @@ -26,17 +26,17 @@ sock_type - + The type of socket: SWOOLE_TCP, SWOOLE_UDP, SWOOLE_ASYNC, SWOOLE_SSL, SWOOLE_KEEP. - + is_async - + Synchronous or asynchronous client. - + diff --git a/reference/swoole/swoole/client/destruct.xml b/reference/swoole/swoole/client/destruct.xml index 2600d6685..9ef258f95 100644 --- a/reference/swoole/swoole/client/destruct.xml +++ b/reference/swoole/swoole/client/destruct.xml @@ -13,9 +13,9 @@ public voidSwoole\Client::__destruct - + - + &warn.undocumented.func; diff --git a/reference/swoole/swoole/client/getpeername.xml b/reference/swoole/swoole/client/getpeername.xml index 6847cbbfd..dd0cacdd1 100644 --- a/reference/swoole/swoole/client/getpeername.xml +++ b/reference/swoole/swoole/client/getpeername.xml @@ -13,9 +13,9 @@ public arraySwoole\Client::getpeername - + - + @@ -26,9 +26,9 @@ &reftitle.returnvalues; - + The host and port of the remote socket. - + diff --git a/reference/swoole/swoole/client/getsockname.xml b/reference/swoole/swoole/client/getsockname.xml index f355b5c6f..47cb57ebb 100644 --- a/reference/swoole/swoole/client/getsockname.xml +++ b/reference/swoole/swoole/client/getsockname.xml @@ -13,9 +13,9 @@ public arraySwoole\Client::getsockname - + - + @@ -26,9 +26,9 @@ &reftitle.returnvalues; - + The host and port of the local socket. - + diff --git a/reference/swoole/swoole/client/isconnected.xml b/reference/swoole/swoole/client/isconnected.xml index 4b540f647..419be92d6 100644 --- a/reference/swoole/swoole/client/isconnected.xml +++ b/reference/swoole/swoole/client/isconnected.xml @@ -13,9 +13,9 @@ public boolSwoole\Client::isConnected - + This method returns the connection status of application layer. - + @@ -26,9 +26,9 @@ &reftitle.returnvalues; - + Whether the connection is established. - + diff --git a/reference/swoole/swoole/client/on.xml b/reference/swoole/swoole/client/on.xml index 3f4ab783f..868406405 100644 --- a/reference/swoole/swoole/client/on.xml +++ b/reference/swoole/swoole/client/on.xml @@ -14,9 +14,9 @@ stringevent callablecallback - + - + @@ -26,17 +26,17 @@ event - - - + + + callback - - - + + + diff --git a/reference/swoole/swoole/client/pause.xml b/reference/swoole/swoole/client/pause.xml index f8dc96cc4..9b49bbc7c 100644 --- a/reference/swoole/swoole/client/pause.xml +++ b/reference/swoole/swoole/client/pause.xml @@ -13,9 +13,9 @@ public voidSwoole\Client::pause - + - + diff --git a/reference/swoole/swoole/client/pipe.xml b/reference/swoole/swoole/client/pipe.xml index fbac59e5d..57dea7fb2 100644 --- a/reference/swoole/swoole/client/pipe.xml +++ b/reference/swoole/swoole/client/pipe.xml @@ -13,9 +13,9 @@ public voidSwoole\Client::pipe stringsocket - + - + @@ -25,9 +25,9 @@ socket - - - + + + diff --git a/reference/swoole/swoole/client/recv.xml b/reference/swoole/swoole/client/recv.xml index eb50f9fe4..a59c60b88 100644 --- a/reference/swoole/swoole/client/recv.xml +++ b/reference/swoole/swoole/client/recv.xml @@ -14,9 +14,9 @@ stringsize stringflag - + - + &warn.undocumented.func; @@ -28,17 +28,17 @@ size - - - + + + flag - - - + + + @@ -46,9 +46,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/swoole/swoole/client/resume.xml b/reference/swoole/swoole/client/resume.xml index 754603ced..46726f262 100644 --- a/reference/swoole/swoole/client/resume.xml +++ b/reference/swoole/swoole/client/resume.xml @@ -13,9 +13,9 @@ public voidSwoole\Client::resume - + - + diff --git a/reference/swoole/swoole/client/send.xml b/reference/swoole/swoole/client/send.xml index 23f8ff965..010673a3e 100644 --- a/reference/swoole/swoole/client/send.xml +++ b/reference/swoole/swoole/client/send.xml @@ -14,9 +14,9 @@ stringdata stringflag - + - + @@ -26,17 +26,17 @@ data - + The data to send which can be string or binary - + flag - - - + + + @@ -44,12 +44,12 @@ &reftitle.returnvalues; - - If the client sends data successfully, it returns the length of data sent. - Or it returns false and sets $swoole_client->errCode. For sync client, - there is no limit for the data to send. For async client, The limit - for the data to send is socket_buffer_size. - + + If the client sends data successfully, it returns the length of data sent. + Or it returns false and sets $swoole_client->errCode. For sync client, + there is no limit for the data to send. For async client, The limit + for the data to send is socket_buffer_size. + diff --git a/reference/swoole/swoole/client/sendfile.xml b/reference/swoole/swoole/client/sendfile.xml index 443e92a1d..3e55e47c6 100644 --- a/reference/swoole/swoole/client/sendfile.xml +++ b/reference/swoole/swoole/client/sendfile.xml @@ -14,9 +14,9 @@ stringfilename intoffset - + This is a wrapper of the Linux sendfile system call. - + @@ -26,17 +26,17 @@ filename - + File path of the file to send. - + offset - + Offset of the file to send - + @@ -44,9 +44,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/swoole/swoole/client/sendto.xml b/reference/swoole/swoole/client/sendto.xml index bdae8d809..d72cfd437 100644 --- a/reference/swoole/swoole/client/sendto.xml +++ b/reference/swoole/swoole/client/sendto.xml @@ -15,9 +15,9 @@ intport stringdata - + The swoole client should be type of SWOOLE_SOCK_UDP or SWOOLE_SOCK_UDP6. - + @@ -27,25 +27,25 @@ ip - + The IP address of remote host, IPv4 or IPv6. - + port - + The port number of remote host. - + data - + The data to send which should be less-than 64K. - + @@ -53,9 +53,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/swoole/swoole/client/set.xml b/reference/swoole/swoole/client/set.xml index a29f79589..547b95f7c 100644 --- a/reference/swoole/swoole/client/set.xml +++ b/reference/swoole/swoole/client/set.xml @@ -13,9 +13,9 @@ public voidSwoole\Client::set arraysettings - + - + @@ -25,9 +25,9 @@ settings - - - + + + @@ -35,9 +35,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/swoole/swoole/client/sleep.xml b/reference/swoole/swoole/client/sleep.xml index 7293c3662..1d6028585 100644 --- a/reference/swoole/swoole/client/sleep.xml +++ b/reference/swoole/swoole/client/sleep.xml @@ -13,9 +13,9 @@ public voidSwoole\Client::sleep - + Remove the TCP client from system event loop. - + @@ -26,9 +26,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/swoole/swoole/client/wakeup.xml b/reference/swoole/swoole/client/wakeup.xml index 0f91227b5..0a085a00e 100644 --- a/reference/swoole/swoole/client/wakeup.xml +++ b/reference/swoole/swoole/client/wakeup.xml @@ -13,9 +13,9 @@ public voidSwoole\Client::wakeup - + - + @@ -26,9 +26,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/swoole/swoole/connection/iterator/count.xml b/reference/swoole/swoole/connection/iterator/count.xml index ffe6f1d44..1ffb3ba45 100644 --- a/reference/swoole/swoole/connection/iterator/count.xml +++ b/reference/swoole/swoole/connection/iterator/count.xml @@ -13,9 +13,9 @@ public intSwoole\Connection\Iterator::count - + Gets the number of connections. - + @@ -26,9 +26,9 @@ &reftitle.returnvalues; - + The number of connections. - + diff --git a/reference/swoole/swoole/connection/iterator/current.xml b/reference/swoole/swoole/connection/iterator/current.xml index 52666a6c7..9b38aeaf1 100644 --- a/reference/swoole/swoole/connection/iterator/current.xml +++ b/reference/swoole/swoole/connection/iterator/current.xml @@ -13,9 +13,9 @@ public ConnectionSwoole\Connection\Iterator::current - + Get current connection entry. - + @@ -26,9 +26,9 @@ &reftitle.returnvalues; - + The current connection entry. - + diff --git a/reference/swoole/swoole/connection/iterator/key.xml b/reference/swoole/swoole/connection/iterator/key.xml index bbda357d4..b256bfbb8 100644 --- a/reference/swoole/swoole/connection/iterator/key.xml +++ b/reference/swoole/swoole/connection/iterator/key.xml @@ -13,9 +13,9 @@ public intSwoole\Connection\Iterator::key - + This function returns key of the current connection. - + @@ -26,9 +26,9 @@ &reftitle.returnvalues; - + Key of the current connection. - + diff --git a/reference/swoole/swoole/connection/iterator/next.xml b/reference/swoole/swoole/connection/iterator/next.xml index 3a03ed746..2f6cab888 100644 --- a/reference/swoole/swoole/connection/iterator/next.xml +++ b/reference/swoole/swoole/connection/iterator/next.xml @@ -13,9 +13,9 @@ public ConnectionSwoole\Connection\Iterator::next - + The iterator to the next connection. - + @@ -26,9 +26,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/swoole/swoole/connection/iterator/offsetexists.xml b/reference/swoole/swoole/connection/iterator/offsetexists.xml index 8694305dc..ee9357380 100644 --- a/reference/swoole/swoole/connection/iterator/offsetexists.xml +++ b/reference/swoole/swoole/connection/iterator/offsetexists.xml @@ -13,9 +13,9 @@ public boolSwoole\Connection\Iterator::offsetExists intindex - + Check if offset exists. - + @@ -25,9 +25,9 @@ index - + The offset being checked. - + @@ -35,9 +35,9 @@ &reftitle.returnvalues; - + Returns TRUE if the offset exists, otherwise FALSE. - + diff --git a/reference/swoole/swoole/connection/iterator/offsetget.xml b/reference/swoole/swoole/connection/iterator/offsetget.xml index c9e0e775a..44ed46a75 100644 --- a/reference/swoole/swoole/connection/iterator/offsetget.xml +++ b/reference/swoole/swoole/connection/iterator/offsetget.xml @@ -13,9 +13,9 @@ public ConnectionSwoole\Connection\Iterator::offsetGet stringindex - + Return the connection at specified offset. - + @@ -25,9 +25,9 @@ index - + The offset to retrieve. - + @@ -35,9 +35,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/swoole/swoole/connection/iterator/offsetset.xml b/reference/swoole/swoole/connection/iterator/offsetset.xml index 2360a0210..68ca89955 100644 --- a/reference/swoole/swoole/connection/iterator/offsetset.xml +++ b/reference/swoole/swoole/connection/iterator/offsetset.xml @@ -14,9 +14,9 @@ intoffset mixedconnection - + Assign a Connection to the specified offset. - + @@ -26,17 +26,17 @@ offset - + The offset to assign the Connection to. - + connection - + The connection to set. - + @@ -44,9 +44,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/swoole/swoole/connection/iterator/offsetunset.xml b/reference/swoole/swoole/connection/iterator/offsetunset.xml index 5044c639f..18ffec0a3 100644 --- a/reference/swoole/swoole/connection/iterator/offsetunset.xml +++ b/reference/swoole/swoole/connection/iterator/offsetunset.xml @@ -13,9 +13,9 @@ public voidSwoole\Connection\Iterator::offsetUnset intoffset - + Unsets an offset. - + @@ -25,9 +25,9 @@ offset - + The offset to unset. - + @@ -35,9 +35,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/swoole/swoole/connection/iterator/rewind.xml b/reference/swoole/swoole/connection/iterator/rewind.xml index da56660d4..287095505 100644 --- a/reference/swoole/swoole/connection/iterator/rewind.xml +++ b/reference/swoole/swoole/connection/iterator/rewind.xml @@ -13,9 +13,9 @@ public voidSwoole\Connection\Iterator::rewind - + - + @@ -26,9 +26,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/swoole/swoole/connection/iterator/valid.xml b/reference/swoole/swoole/connection/iterator/valid.xml index f4214f05f..bd1444b54 100644 --- a/reference/swoole/swoole/connection/iterator/valid.xml +++ b/reference/swoole/swoole/connection/iterator/valid.xml @@ -13,9 +13,9 @@ public boolSwoole\Connection\Iterator::valid - + Checks if the current position is valid. - + @@ -26,9 +26,9 @@ &reftitle.returnvalues; - + Returns TRUE if the current iterator position is valid, otherwise FALSE. - + diff --git a/reference/swoole/swoole/coroutine/call-user-func-array.xml b/reference/swoole/swoole/coroutine/call-user-func-array.xml index 1dc446bd7..174ac52fa 100644 --- a/reference/swoole/swoole/coroutine/call-user-func-array.xml +++ b/reference/swoole/swoole/coroutine/call-user-func-array.xml @@ -14,9 +14,9 @@ callablecallback arrayparam_array - + Calls the callback given by the first parameter with the parameters in param_array. - + @@ -27,17 +27,17 @@ callback - + The callable to be called. - + param_array - + Zero or more parameters in the array to be passed to the callback. - + @@ -46,9 +46,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/swoole/swoole/coroutine/call-user-func.xml b/reference/swoole/swoole/coroutine/call-user-func.xml index 5f08c1e16..6536f2f39 100644 --- a/reference/swoole/swoole/coroutine/call-user-func.xml +++ b/reference/swoole/swoole/coroutine/call-user-func.xml @@ -14,9 +14,9 @@ callablecallback mixedargs - + Calls the callback given by the first parameter and passes the remaining parameters as arguments. - + @@ -27,17 +27,17 @@ callback - + The callable to be called. - + args - + Zero or more parameters to be passed to the callback. - + @@ -46,9 +46,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/swoole/swoole/coroutine/cli-wait.xml b/reference/swoole/swoole/coroutine/cli-wait.xml index 8cb6bcfbe..59193536c 100644 --- a/reference/swoole/swoole/coroutine/cli-wait.xml +++ b/reference/swoole/swoole/coroutine/cli-wait.xml @@ -13,9 +13,9 @@ public static ReturnTypeSwoole\Coroutine::cli_wait - + - + @@ -26,9 +26,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/swoole/swoole/coroutine/client/close.xml b/reference/swoole/swoole/coroutine/client/close.xml index 5a1ada948..2c8c0ef60 100644 --- a/reference/swoole/swoole/coroutine/client/close.xml +++ b/reference/swoole/swoole/coroutine/client/close.xml @@ -13,9 +13,9 @@ public ReturnTypeSwoole\Coroutine\Client::close - + - + &warn.undocumented.func; @@ -28,9 +28,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/swoole/swoole/coroutine/client/connect.xml b/reference/swoole/swoole/coroutine/client/connect.xml index deafe772f..9545c8a26 100644 --- a/reference/swoole/swoole/coroutine/client/connect.xml +++ b/reference/swoole/swoole/coroutine/client/connect.xml @@ -13,9 +13,9 @@ public ReturnTypeSwoole\Coroutine\Client::connect - + - + &warn.undocumented.func; @@ -28,9 +28,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/swoole/swoole/coroutine/client/construct.xml b/reference/swoole/swoole/coroutine/client/construct.xml index 59ed5922d..146d54053 100644 --- a/reference/swoole/swoole/coroutine/client/construct.xml +++ b/reference/swoole/swoole/coroutine/client/construct.xml @@ -13,9 +13,9 @@ public Swoole\Coroutine\Client::__construct - + - + @@ -30,7 +30,7 @@ &reftitle.returnvalues; - + --> diff --git a/reference/swoole/swoole/coroutine/client/destruct.xml b/reference/swoole/swoole/coroutine/client/destruct.xml index 4aacebd98..5cbf075c0 100644 --- a/reference/swoole/swoole/coroutine/client/destruct.xml +++ b/reference/swoole/swoole/coroutine/client/destruct.xml @@ -13,9 +13,9 @@ public ReturnTypeSwoole\Coroutine\Client::__destruct - + - + &warn.undocumented.func; @@ -28,9 +28,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/swoole/swoole/coroutine/client/getpeername.xml b/reference/swoole/swoole/coroutine/client/getpeername.xml index 7323a0727..835f5df25 100644 --- a/reference/swoole/swoole/coroutine/client/getpeername.xml +++ b/reference/swoole/swoole/coroutine/client/getpeername.xml @@ -13,9 +13,9 @@ public ReturnTypeSwoole\Coroutine\Client::getpeername - + - + &warn.undocumented.func; @@ -28,9 +28,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/swoole/swoole/coroutine/client/getsockname.xml b/reference/swoole/swoole/coroutine/client/getsockname.xml index f43a0f862..d7d9aaaf4 100644 --- a/reference/swoole/swoole/coroutine/client/getsockname.xml +++ b/reference/swoole/swoole/coroutine/client/getsockname.xml @@ -13,9 +13,9 @@ public ReturnTypeSwoole\Coroutine\Client::getsockname - + - + &warn.undocumented.func; @@ -28,9 +28,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/swoole/swoole/coroutine/client/isconnected.xml b/reference/swoole/swoole/coroutine/client/isconnected.xml index 87ec1bbeb..62dd49f3a 100644 --- a/reference/swoole/swoole/coroutine/client/isconnected.xml +++ b/reference/swoole/swoole/coroutine/client/isconnected.xml @@ -13,9 +13,9 @@ public ReturnTypeSwoole\Coroutine\Client::isConnected - + - + &warn.undocumented.func; @@ -28,9 +28,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/swoole/swoole/coroutine/client/recv.xml b/reference/swoole/swoole/coroutine/client/recv.xml index f16510b16..f6f6c9df8 100644 --- a/reference/swoole/swoole/coroutine/client/recv.xml +++ b/reference/swoole/swoole/coroutine/client/recv.xml @@ -13,9 +13,9 @@ public ReturnTypeSwoole\Coroutine\Client::recv - + - + &warn.undocumented.func; @@ -28,9 +28,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/swoole/swoole/coroutine/client/send.xml b/reference/swoole/swoole/coroutine/client/send.xml index 96399466d..257f41bcf 100644 --- a/reference/swoole/swoole/coroutine/client/send.xml +++ b/reference/swoole/swoole/coroutine/client/send.xml @@ -13,9 +13,9 @@ public ReturnTypeSwoole\Coroutine\Client::send - + - + &warn.undocumented.func; @@ -28,9 +28,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/swoole/swoole/coroutine/client/sendfile.xml b/reference/swoole/swoole/coroutine/client/sendfile.xml index c710f6b7b..e5360764e 100644 --- a/reference/swoole/swoole/coroutine/client/sendfile.xml +++ b/reference/swoole/swoole/coroutine/client/sendfile.xml @@ -13,9 +13,9 @@ public ReturnTypeSwoole\Coroutine\Client::sendfile - + - + &warn.undocumented.func; @@ -28,9 +28,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/swoole/swoole/coroutine/client/sendto.xml b/reference/swoole/swoole/coroutine/client/sendto.xml index 64e054053..526849e0a 100644 --- a/reference/swoole/swoole/coroutine/client/sendto.xml +++ b/reference/swoole/swoole/coroutine/client/sendto.xml @@ -13,9 +13,9 @@ public ReturnTypeSwoole\Coroutine\Client::sendto - + - + &warn.undocumented.func; @@ -28,9 +28,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/swoole/swoole/coroutine/client/set.xml b/reference/swoole/swoole/coroutine/client/set.xml index 004612698..edafabaa7 100644 --- a/reference/swoole/swoole/coroutine/client/set.xml +++ b/reference/swoole/swoole/coroutine/client/set.xml @@ -13,9 +13,9 @@ public ReturnTypeSwoole\Coroutine\Client::set - + - + &warn.undocumented.func; @@ -28,9 +28,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/swoole/swoole/coroutine/create.xml b/reference/swoole/swoole/coroutine/create.xml index 6f75d390b..c538d100a 100644 --- a/reference/swoole/swoole/coroutine/create.xml +++ b/reference/swoole/swoole/coroutine/create.xml @@ -13,9 +13,9 @@ public static ReturnTypeSwoole\Coroutine::create - + - + &warn.undocumented.func; @@ -28,9 +28,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/swoole/swoole/coroutine/getuid.xml b/reference/swoole/swoole/coroutine/getuid.xml index 8a9df0c53..e27cf7c0d 100644 --- a/reference/swoole/swoole/coroutine/getuid.xml +++ b/reference/swoole/swoole/coroutine/getuid.xml @@ -13,9 +13,9 @@ public static ReturnTypeSwoole\Coroutine::getuid - + - + &warn.undocumented.func; @@ -28,9 +28,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/swoole/swoole/coroutine/http/client/addfile.xml b/reference/swoole/swoole/coroutine/http/client/addfile.xml index f34131bc4..5759931f0 100644 --- a/reference/swoole/swoole/coroutine/http/client/addfile.xml +++ b/reference/swoole/swoole/coroutine/http/client/addfile.xml @@ -13,9 +13,9 @@ public ReturnTypeSwoole\Coroutine\Http\Client::addFile - + - + &warn.undocumented.func; @@ -28,9 +28,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/swoole/swoole/coroutine/http/client/close.xml b/reference/swoole/swoole/coroutine/http/client/close.xml index 479b7a96b..af92c527c 100644 --- a/reference/swoole/swoole/coroutine/http/client/close.xml +++ b/reference/swoole/swoole/coroutine/http/client/close.xml @@ -13,9 +13,9 @@ public ReturnTypeSwoole\Coroutine\Http\Client::close - + - + &warn.undocumented.func; @@ -28,9 +28,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/swoole/swoole/coroutine/http/client/construct.xml b/reference/swoole/swoole/coroutine/http/client/construct.xml index aa2562144..c7baab0b9 100644 --- a/reference/swoole/swoole/coroutine/http/client/construct.xml +++ b/reference/swoole/swoole/coroutine/http/client/construct.xml @@ -13,9 +13,9 @@ public Swoole\Coroutine\Http\Client::__construct - + - + &warn.undocumented.func; @@ -32,7 +32,7 @@ &reftitle.returnvalues; - + --> diff --git a/reference/swoole/swoole/coroutine/http/client/destruct.xml b/reference/swoole/swoole/coroutine/http/client/destruct.xml index 12642ae66..1fccd6351 100644 --- a/reference/swoole/swoole/coroutine/http/client/destruct.xml +++ b/reference/swoole/swoole/coroutine/http/client/destruct.xml @@ -13,9 +13,9 @@ public ReturnTypeSwoole\Coroutine\Http\Client::__destruct - + - + &warn.undocumented.func; @@ -28,9 +28,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/swoole/swoole/coroutine/http/client/execute.xml b/reference/swoole/swoole/coroutine/http/client/execute.xml index 8d087ff76..820c41c12 100644 --- a/reference/swoole/swoole/coroutine/http/client/execute.xml +++ b/reference/swoole/swoole/coroutine/http/client/execute.xml @@ -13,9 +13,9 @@ public ReturnTypeSwoole\Coroutine\Http\Client::execute - + - + &warn.undocumented.func; @@ -28,9 +28,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/swoole/swoole/coroutine/http/client/get.xml b/reference/swoole/swoole/coroutine/http/client/get.xml index 9ad386027..6be863f9e 100644 --- a/reference/swoole/swoole/coroutine/http/client/get.xml +++ b/reference/swoole/swoole/coroutine/http/client/get.xml @@ -13,9 +13,9 @@ public ReturnTypeSwoole\Coroutine\Http\Client::get - + - + &warn.undocumented.func; @@ -28,9 +28,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/swoole/swoole/coroutine/http/client/getdefer.xml b/reference/swoole/swoole/coroutine/http/client/getdefer.xml index 3747a68cd..d8ba06fda 100644 --- a/reference/swoole/swoole/coroutine/http/client/getdefer.xml +++ b/reference/swoole/swoole/coroutine/http/client/getdefer.xml @@ -13,9 +13,9 @@ public ReturnTypeSwoole\Coroutine\Http\Client::getDefer - + - + &warn.undocumented.func; @@ -28,9 +28,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/swoole/swoole/coroutine/http/client/isconnected.xml b/reference/swoole/swoole/coroutine/http/client/isconnected.xml index aa1ae0ea4..198a71ba4 100644 --- a/reference/swoole/swoole/coroutine/http/client/isconnected.xml +++ b/reference/swoole/swoole/coroutine/http/client/isconnected.xml @@ -13,9 +13,9 @@ public ReturnTypeSwoole\Coroutine\Http\Client::isConnected - + - + &warn.undocumented.func; @@ -28,9 +28,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/swoole/swoole/coroutine/http/client/post.xml b/reference/swoole/swoole/coroutine/http/client/post.xml index 299361c84..0814086d4 100644 --- a/reference/swoole/swoole/coroutine/http/client/post.xml +++ b/reference/swoole/swoole/coroutine/http/client/post.xml @@ -13,9 +13,9 @@ public ReturnTypeSwoole\Coroutine\Http\Client::post - + - + &warn.undocumented.func; @@ -28,9 +28,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/swoole/swoole/coroutine/http/client/recv.xml b/reference/swoole/swoole/coroutine/http/client/recv.xml index 2f12fda19..5e60c1fbb 100644 --- a/reference/swoole/swoole/coroutine/http/client/recv.xml +++ b/reference/swoole/swoole/coroutine/http/client/recv.xml @@ -13,9 +13,9 @@ public ReturnTypeSwoole\Coroutine\Http\Client::recv - + - + &warn.undocumented.func; @@ -28,9 +28,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/swoole/swoole/coroutine/http/client/set.xml b/reference/swoole/swoole/coroutine/http/client/set.xml index 5c9008b1e..e3cab0357 100644 --- a/reference/swoole/swoole/coroutine/http/client/set.xml +++ b/reference/swoole/swoole/coroutine/http/client/set.xml @@ -13,9 +13,9 @@ public ReturnTypeSwoole\Coroutine\Http\Client::set - + - + &warn.undocumented.func; @@ -28,9 +28,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/swoole/swoole/coroutine/http/client/setcookies.xml b/reference/swoole/swoole/coroutine/http/client/setcookies.xml index e9bb618d3..88619c39f 100644 --- a/reference/swoole/swoole/coroutine/http/client/setcookies.xml +++ b/reference/swoole/swoole/coroutine/http/client/setcookies.xml @@ -13,9 +13,9 @@ public ReturnTypeSwoole\Coroutine\Http\Client::setCookies - + - + &warn.undocumented.func; @@ -28,9 +28,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/swoole/swoole/coroutine/http/client/setdata.xml b/reference/swoole/swoole/coroutine/http/client/setdata.xml index 8abf1e581..cd642a4fa 100644 --- a/reference/swoole/swoole/coroutine/http/client/setdata.xml +++ b/reference/swoole/swoole/coroutine/http/client/setdata.xml @@ -13,9 +13,9 @@ public ReturnTypeSwoole\Coroutine\Http\Client::setData - + - + &warn.undocumented.func; @@ -28,9 +28,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/swoole/swoole/coroutine/http/client/setdefer.xml b/reference/swoole/swoole/coroutine/http/client/setdefer.xml index 2bdf5e4fe..7e2bad908 100644 --- a/reference/swoole/swoole/coroutine/http/client/setdefer.xml +++ b/reference/swoole/swoole/coroutine/http/client/setdefer.xml @@ -13,9 +13,9 @@ public ReturnTypeSwoole\Coroutine\Http\Client::setDefer - + - + &warn.undocumented.func; @@ -28,9 +28,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/swoole/swoole/coroutine/http/client/setheaders.xml b/reference/swoole/swoole/coroutine/http/client/setheaders.xml index cf9a464ab..f4eb96d34 100644 --- a/reference/swoole/swoole/coroutine/http/client/setheaders.xml +++ b/reference/swoole/swoole/coroutine/http/client/setheaders.xml @@ -13,9 +13,9 @@ public ReturnTypeSwoole\Coroutine\Http\Client::setHeaders - + - + &warn.undocumented.func; @@ -28,9 +28,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/swoole/swoole/coroutine/http/client/setmethod.xml b/reference/swoole/swoole/coroutine/http/client/setmethod.xml index fa63f7497..e94cfb716 100644 --- a/reference/swoole/swoole/coroutine/http/client/setmethod.xml +++ b/reference/swoole/swoole/coroutine/http/client/setmethod.xml @@ -13,9 +13,9 @@ public ReturnTypeSwoole\Coroutine\Http\Client::setMethod - + - + &warn.undocumented.func; @@ -28,9 +28,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/swoole/swoole/coroutine/lock/construct.xml b/reference/swoole/swoole/coroutine/lock/construct.xml index 384163b7a..eb20f44f7 100644 --- a/reference/swoole/swoole/coroutine/lock/construct.xml +++ b/reference/swoole/swoole/coroutine/lock/construct.xml @@ -13,9 +13,9 @@ public voidSwoole\Coroutine\Lock::__construct - + Create a new coroutine lock instance. - + @@ -25,9 +25,9 @@ &reftitle.returnvalues; - + &return.void; - + diff --git a/reference/swoole/swoole/coroutine/lock/lock.xml b/reference/swoole/swoole/coroutine/lock/lock.xml index 8983fb79c..df9678b40 100644 --- a/reference/swoole/swoole/coroutine/lock/lock.xml +++ b/reference/swoole/swoole/coroutine/lock/lock.xml @@ -13,12 +13,12 @@ public boolSwoole\Coroutine\Lock::lock - + When executing the lock operation, if the lock is already held by another coroutine, the current coroutine will actively yield CPU control and enter a suspended state. When the coroutine holding the lock calls unlock(), the waiting coroutine will be awakened and try to acquire the lock again. - + diff --git a/reference/swoole/swoole/coroutine/lock/trylock.xml b/reference/swoole/swoole/coroutine/lock/trylock.xml index f9faa0deb..931aef847 100644 --- a/reference/swoole/swoole/coroutine/lock/trylock.xml +++ b/reference/swoole/swoole/coroutine/lock/trylock.xml @@ -13,12 +13,12 @@ public boolSwoole\Coroutine\Lock::trylock - + When calling the lock operation, if the lock is already held by another coroutine, the function will immediately return false without suspending the current coroutine or yielding CPU control. This non-blocking design allows the caller to flexibly handle contention situations, such as retrying, giving up, or executing other logic. - + diff --git a/reference/swoole/swoole/coroutine/lock/unlock.xml b/reference/swoole/swoole/coroutine/lock/unlock.xml index ce1d7530a..e7ee65468 100644 --- a/reference/swoole/swoole/coroutine/lock/unlock.xml +++ b/reference/swoole/swoole/coroutine/lock/unlock.xml @@ -19,15 +19,15 @@ Unlock Behavior - + With io_uring futex: the system will precisely wake up one coroutine in the waiting queue. - + - + Without io_uring futex: waiting coroutines need to wait for their backoff time to end and compete to reacquire the lock. - + diff --git a/reference/swoole/swoole/coroutine/mysql/close.xml b/reference/swoole/swoole/coroutine/mysql/close.xml index 9b8438a1c..42f51659e 100644 --- a/reference/swoole/swoole/coroutine/mysql/close.xml +++ b/reference/swoole/swoole/coroutine/mysql/close.xml @@ -13,9 +13,9 @@ public ReturnTypeSwoole\Coroutine\MySQL::close - + - + &warn.undocumented.func; @@ -28,9 +28,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/swoole/swoole/coroutine/mysql/connect.xml b/reference/swoole/swoole/coroutine/mysql/connect.xml index 58af4b813..8d41f5040 100644 --- a/reference/swoole/swoole/coroutine/mysql/connect.xml +++ b/reference/swoole/swoole/coroutine/mysql/connect.xml @@ -13,9 +13,9 @@ public ReturnTypeSwoole\Coroutine\MySQL::connect - + - + &warn.undocumented.func; @@ -28,9 +28,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/swoole/swoole/coroutine/mysql/construct.xml b/reference/swoole/swoole/coroutine/mysql/construct.xml index 3a71cc450..675635eba 100644 --- a/reference/swoole/swoole/coroutine/mysql/construct.xml +++ b/reference/swoole/swoole/coroutine/mysql/construct.xml @@ -13,9 +13,9 @@ public Swoole\Coroutine\MySQL::__construct - + - + &warn.undocumented.func; @@ -32,7 +32,7 @@ &reftitle.returnvalues; - + --> diff --git a/reference/swoole/swoole/coroutine/mysql/destruct.xml b/reference/swoole/swoole/coroutine/mysql/destruct.xml index c4163014f..a1b026ca1 100644 --- a/reference/swoole/swoole/coroutine/mysql/destruct.xml +++ b/reference/swoole/swoole/coroutine/mysql/destruct.xml @@ -13,9 +13,9 @@ public ReturnTypeSwoole\Coroutine\MySQL::__destruct - + - + &warn.undocumented.func; @@ -28,9 +28,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/swoole/swoole/coroutine/mysql/getdefer.xml b/reference/swoole/swoole/coroutine/mysql/getdefer.xml index 718bdee21..c359d62d9 100644 --- a/reference/swoole/swoole/coroutine/mysql/getdefer.xml +++ b/reference/swoole/swoole/coroutine/mysql/getdefer.xml @@ -13,9 +13,9 @@ public ReturnTypeSwoole\Coroutine\MySQL::getDefer - + - + &warn.undocumented.func; @@ -28,9 +28,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/swoole/swoole/coroutine/mysql/query.xml b/reference/swoole/swoole/coroutine/mysql/query.xml index f834252b7..00f3c5e5e 100644 --- a/reference/swoole/swoole/coroutine/mysql/query.xml +++ b/reference/swoole/swoole/coroutine/mysql/query.xml @@ -13,9 +13,9 @@ public ReturnTypeSwoole\Coroutine\MySQL::query - + - + &warn.undocumented.func; @@ -28,9 +28,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/swoole/swoole/coroutine/mysql/recv.xml b/reference/swoole/swoole/coroutine/mysql/recv.xml index 5e866f42c..339748073 100644 --- a/reference/swoole/swoole/coroutine/mysql/recv.xml +++ b/reference/swoole/swoole/coroutine/mysql/recv.xml @@ -13,9 +13,9 @@ public ReturnTypeSwoole\Coroutine\MySQL::recv - + - + &warn.undocumented.func; @@ -28,9 +28,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/swoole/swoole/coroutine/mysql/setdefer.xml b/reference/swoole/swoole/coroutine/mysql/setdefer.xml index 0b78b8342..a4f5f5f74 100644 --- a/reference/swoole/swoole/coroutine/mysql/setdefer.xml +++ b/reference/swoole/swoole/coroutine/mysql/setdefer.xml @@ -13,9 +13,9 @@ public ReturnTypeSwoole\Coroutine\MySQL::setDefer - + - + &warn.undocumented.func; @@ -28,9 +28,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/swoole/swoole/coroutine/resume.xml b/reference/swoole/swoole/coroutine/resume.xml index f2ef935c6..7b63f8dcb 100644 --- a/reference/swoole/swoole/coroutine/resume.xml +++ b/reference/swoole/swoole/coroutine/resume.xml @@ -13,9 +13,9 @@ public static ReturnTypeSwoole\Coroutine::resume - + - + &warn.undocumented.func; @@ -28,9 +28,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/swoole/swoole/coroutine/suspend.xml b/reference/swoole/swoole/coroutine/suspend.xml index 2bb1b3d1d..aebecfe1a 100644 --- a/reference/swoole/swoole/coroutine/suspend.xml +++ b/reference/swoole/swoole/coroutine/suspend.xml @@ -13,9 +13,9 @@ public static ReturnTypeSwoole\Coroutine::suspend - + - + &warn.undocumented.func; @@ -28,9 +28,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/swoole/swoole/http/client/addfile.xml b/reference/swoole/swoole/http/client/addfile.xml index 91646f38b..5a6944ab7 100644 --- a/reference/swoole/swoole/http/client/addfile.xml +++ b/reference/swoole/swoole/http/client/addfile.xml @@ -17,9 +17,9 @@ stringfilename stringoffset - + - + @@ -29,41 +29,41 @@ path - - - + + + name - - - + + + type - - - + + + filename - - - + + + offset - - - + + + @@ -71,9 +71,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/swoole/swoole/http/client/close.xml b/reference/swoole/swoole/http/client/close.xml index 65ef14a7a..d98240d50 100644 --- a/reference/swoole/swoole/http/client/close.xml +++ b/reference/swoole/swoole/http/client/close.xml @@ -13,9 +13,9 @@ public voidSwoole\Http\Client::close - + - + @@ -26,9 +26,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/swoole/swoole/http/client/construct.xml b/reference/swoole/swoole/http/client/construct.xml index 0678852f2..ef59f76cc 100644 --- a/reference/swoole/swoole/http/client/construct.xml +++ b/reference/swoole/swoole/http/client/construct.xml @@ -15,9 +15,9 @@ stringport boolssl - + - + @@ -27,25 +27,25 @@ host - + The hostname of the remote host. - + port - + The port number of the remote host. - + ssl - + Whether to enable SSL. - + @@ -57,7 +57,7 @@ &reftitle.returnvalues; - + --> diff --git a/reference/swoole/swoole/http/client/destruct.xml b/reference/swoole/swoole/http/client/destruct.xml index a4a8646e1..7b94723dd 100644 --- a/reference/swoole/swoole/http/client/destruct.xml +++ b/reference/swoole/swoole/http/client/destruct.xml @@ -13,9 +13,9 @@ public voidSwoole\Http\Client::__destruct - + - + @@ -26,9 +26,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/swoole/swoole/http/client/download.xml b/reference/swoole/swoole/http/client/download.xml index 6bc213c3c..fe8edd7b4 100644 --- a/reference/swoole/swoole/http/client/download.xml +++ b/reference/swoole/swoole/http/client/download.xml @@ -16,9 +16,9 @@ callablecallback intoffset - + - + @@ -28,33 +28,33 @@ path - - - + + + file - - - + + + callback - - - + + + offset - - - + + + @@ -62,9 +62,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/swoole/swoole/http/client/execute.xml b/reference/swoole/swoole/http/client/execute.xml index 5ea201cb5..66ab0da0f 100644 --- a/reference/swoole/swoole/http/client/execute.xml +++ b/reference/swoole/swoole/http/client/execute.xml @@ -14,9 +14,9 @@ stringpath stringcallback - + - + @@ -26,17 +26,17 @@ path - - - + + + callback - - - + + + @@ -44,9 +44,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/swoole/swoole/http/client/get.xml b/reference/swoole/swoole/http/client/get.xml index af6fb7c7e..b694ab2c9 100644 --- a/reference/swoole/swoole/http/client/get.xml +++ b/reference/swoole/swoole/http/client/get.xml @@ -14,9 +14,9 @@ stringpath callablecallback - + - + @@ -26,17 +26,17 @@ path - - - + + + callback - - - + + + @@ -44,9 +44,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/swoole/swoole/http/client/isconnected.xml b/reference/swoole/swoole/http/client/isconnected.xml index d66fe7ca1..613036d2c 100644 --- a/reference/swoole/swoole/http/client/isconnected.xml +++ b/reference/swoole/swoole/http/client/isconnected.xml @@ -13,9 +13,9 @@ public boolSwoole\Http\Client::isConnected - + - + @@ -26,9 +26,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/swoole/swoole/http/client/on.xml b/reference/swoole/swoole/http/client/on.xml index fa4ce8363..afc49dcff 100644 --- a/reference/swoole/swoole/http/client/on.xml +++ b/reference/swoole/swoole/http/client/on.xml @@ -14,9 +14,9 @@ stringevent_name callablecallback - + - + @@ -26,17 +26,17 @@ event_name - - - + + + callback - - - + + + @@ -44,9 +44,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/swoole/swoole/http/client/post.xml b/reference/swoole/swoole/http/client/post.xml index c2941fc0d..ab4e8e2d9 100644 --- a/reference/swoole/swoole/http/client/post.xml +++ b/reference/swoole/swoole/http/client/post.xml @@ -15,9 +15,9 @@ stringdata callablecallback - + - + @@ -27,25 +27,25 @@ path - - - + + + data - - - + + + callback - - - + + + @@ -53,9 +53,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/swoole/swoole/http/client/push.xml b/reference/swoole/swoole/http/client/push.xml index 4b937c16a..bc3bc7772 100644 --- a/reference/swoole/swoole/http/client/push.xml +++ b/reference/swoole/swoole/http/client/push.xml @@ -15,9 +15,9 @@ stringopcode stringfinish - + - + @@ -27,25 +27,25 @@ data - - - + + + opcode - - - + + + finish - - - + + + @@ -53,9 +53,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/swoole/swoole/http/client/set.xml b/reference/swoole/swoole/http/client/set.xml index 54802c9e1..420f107b7 100644 --- a/reference/swoole/swoole/http/client/set.xml +++ b/reference/swoole/swoole/http/client/set.xml @@ -13,9 +13,9 @@ public voidSwoole\Http\Client::set arraysettings - + - + @@ -25,9 +25,9 @@ settings - - - + + + @@ -35,9 +35,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/swoole/swoole/http/client/setcookies.xml b/reference/swoole/swoole/http/client/setcookies.xml index 15f344c01..b87c40395 100644 --- a/reference/swoole/swoole/http/client/setcookies.xml +++ b/reference/swoole/swoole/http/client/setcookies.xml @@ -13,9 +13,9 @@ public voidSwoole\Http\Client::setCookies arraycookies - + - + @@ -25,9 +25,9 @@ cookies - - - + + + @@ -35,9 +35,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/swoole/swoole/http/client/setdata.xml b/reference/swoole/swoole/http/client/setdata.xml index f9b4d0789..210fa5088 100644 --- a/reference/swoole/swoole/http/client/setdata.xml +++ b/reference/swoole/swoole/http/client/setdata.xml @@ -13,9 +13,9 @@ public ReturnTypeSwoole\Http\Client::setData stringdata - + The HTTP method will be changed to be POST. - + @@ -25,9 +25,9 @@ data - - - + + + @@ -35,9 +35,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/swoole/swoole/http/client/setheaders.xml b/reference/swoole/swoole/http/client/setheaders.xml index 8fa5b8754..ecdca5117 100644 --- a/reference/swoole/swoole/http/client/setheaders.xml +++ b/reference/swoole/swoole/http/client/setheaders.xml @@ -13,9 +13,9 @@ public voidSwoole\Http\Client::setHeaders arrayheaders - + - + @@ -25,9 +25,9 @@ headers - - - + + + @@ -35,9 +35,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/swoole/swoole/http/client/setmethod.xml b/reference/swoole/swoole/http/client/setmethod.xml index 5beb49927..3e05707ae 100644 --- a/reference/swoole/swoole/http/client/setmethod.xml +++ b/reference/swoole/swoole/http/client/setmethod.xml @@ -13,9 +13,9 @@ public voidSwoole\Http\Client::setMethod stringmethod - + - + @@ -25,9 +25,9 @@ method - - - + + + @@ -35,9 +35,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/swoole/swoole/http/client/upgrade.xml b/reference/swoole/swoole/http/client/upgrade.xml index e398a9110..4ad76e891 100644 --- a/reference/swoole/swoole/http/client/upgrade.xml +++ b/reference/swoole/swoole/http/client/upgrade.xml @@ -14,9 +14,9 @@ stringpath stringcallback - + - + @@ -26,17 +26,17 @@ path - - - + + + callback - - - + + + @@ -44,9 +44,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/swoole/swoole/http/request/destruct.xml b/reference/swoole/swoole/http/request/destruct.xml index a8aa516d8..d6d0538bb 100644 --- a/reference/swoole/swoole/http/request/destruct.xml +++ b/reference/swoole/swoole/http/request/destruct.xml @@ -13,9 +13,9 @@ public voidSwoole\Http\Request::__destruct - + - + @@ -26,9 +26,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/swoole/swoole/http/request/rawcontent.xml b/reference/swoole/swoole/http/request/rawcontent.xml index c1ff6bea7..71ab84736 100644 --- a/reference/swoole/swoole/http/request/rawcontent.xml +++ b/reference/swoole/swoole/http/request/rawcontent.xml @@ -13,9 +13,9 @@ public stringSwoole\Http\Request::rawcontent - + This method is used for the POST data which isn't in the form of `application/x-www-form-urlencoded`. - + &warn.undocumented.func; @@ -28,9 +28,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/swoole/swoole/http/response/cookie.xml b/reference/swoole/swoole/http/response/cookie.xml index b52185e53..9a76b7da0 100644 --- a/reference/swoole/swoole/http/response/cookie.xml +++ b/reference/swoole/swoole/http/response/cookie.xml @@ -19,9 +19,9 @@ stringsecure stringhttponly - + - + @@ -31,57 +31,57 @@ name - - - + + + value - - - + + + expires - - - + + + path - - - + + + domain - - - + + + secure - - - + + + httponly - - - + + + @@ -89,9 +89,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/swoole/swoole/http/response/destruct.xml b/reference/swoole/swoole/http/response/destruct.xml index 6f37f0874..cea8174b5 100644 --- a/reference/swoole/swoole/http/response/destruct.xml +++ b/reference/swoole/swoole/http/response/destruct.xml @@ -13,9 +13,9 @@ public voidSwoole\Http\Response::__destruct - + - + @@ -26,9 +26,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/swoole/swoole/http/response/end.xml b/reference/swoole/swoole/http/response/end.xml index 7b15e190a..58b74e7dd 100644 --- a/reference/swoole/swoole/http/response/end.xml +++ b/reference/swoole/swoole/http/response/end.xml @@ -13,9 +13,9 @@ public voidSwoole\Http\Response::end stringcontent - + - + @@ -25,9 +25,9 @@ content - - - + + + @@ -35,9 +35,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/swoole/swoole/http/response/gzip.xml b/reference/swoole/swoole/http/response/gzip.xml index 7fc61bbee..140939596 100644 --- a/reference/swoole/swoole/http/response/gzip.xml +++ b/reference/swoole/swoole/http/response/gzip.xml @@ -14,9 +14,9 @@ public ReturnTypeSwoole\Http\Response::gzip stringcompress_level - + The header about Content-Encoding will be added automatically. - + @@ -26,9 +26,9 @@ compress_level - - - + + + @@ -36,9 +36,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/swoole/swoole/http/response/header.xml b/reference/swoole/swoole/http/response/header.xml index d270f738e..70aae6ed9 100644 --- a/reference/swoole/swoole/http/response/header.xml +++ b/reference/swoole/swoole/http/response/header.xml @@ -15,9 +15,9 @@ stringvalue stringucwords - + - + @@ -27,25 +27,25 @@ key - - - + + + value - - - + + + ucwords - - - + + + @@ -53,9 +53,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/swoole/swoole/http/response/initheader.xml b/reference/swoole/swoole/http/response/initheader.xml index 7ed0efb55..2d352fc0e 100644 --- a/reference/swoole/swoole/http/response/initheader.xml +++ b/reference/swoole/swoole/http/response/initheader.xml @@ -13,9 +13,9 @@ public ReturnTypeSwoole\Http\Response::initHeader - + Init the HTTP response header. - + @@ -26,9 +26,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/swoole/swoole/http/response/rawcookie.xml b/reference/swoole/swoole/http/response/rawcookie.xml index a1ee163ac..b431e6c32 100644 --- a/reference/swoole/swoole/http/response/rawcookie.xml +++ b/reference/swoole/swoole/http/response/rawcookie.xml @@ -19,9 +19,9 @@ stringsecure stringhttponly - + - + @@ -31,57 +31,57 @@ name - - - + + + value - - - + + + expires - - - + + + path - - - + + + domain - - - + + + secure - - - + + + httponly - - - + + + @@ -89,9 +89,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/swoole/swoole/http/response/sendfile.xml b/reference/swoole/swoole/http/response/sendfile.xml index d867a3cfe..6973cb95f 100644 --- a/reference/swoole/swoole/http/response/sendfile.xml +++ b/reference/swoole/swoole/http/response/sendfile.xml @@ -14,9 +14,9 @@ stringfilename intoffset - + Send file through the HTTP response. - + @@ -26,17 +26,17 @@ filename - - - + + + offset - - - + + + @@ -44,9 +44,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/swoole/swoole/http/response/status.xml b/reference/swoole/swoole/http/response/status.xml index e14e4f5ec..f867bd32e 100644 --- a/reference/swoole/swoole/http/response/status.xml +++ b/reference/swoole/swoole/http/response/status.xml @@ -13,9 +13,9 @@ public ReturnTypeSwoole\Http\Response::status stringhttp_code - + Set the status code of the HTTP response. - + @@ -25,9 +25,9 @@ http_code - - - + + + @@ -35,9 +35,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/swoole/swoole/http/response/write.xml b/reference/swoole/swoole/http/response/write.xml index 839b63b80..bae856de3 100644 --- a/reference/swoole/swoole/http/response/write.xml +++ b/reference/swoole/swoole/http/response/write.xml @@ -13,9 +13,9 @@ public voidSwoole\Http\Response::write stringcontent - + Append HTTP body content to the HTTP response. - + @@ -25,9 +25,9 @@ content - - - + + + @@ -35,9 +35,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/swoole/swoole/http/server/on.xml b/reference/swoole/swoole/http/server/on.xml index 10b47e203..424b66d2d 100644 --- a/reference/swoole/swoole/http/server/on.xml +++ b/reference/swoole/swoole/http/server/on.xml @@ -14,9 +14,9 @@ stringevent_name callablecallback - + Bind callback function to HTTP server by event name. - + @@ -26,17 +26,17 @@ event_name - - - + + + callback - - - + + + @@ -44,9 +44,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/swoole/swoole/http/server/start.xml b/reference/swoole/swoole/http/server/start.xml index 29f2dce65..c3a1d1d49 100644 --- a/reference/swoole/swoole/http/server/start.xml +++ b/reference/swoole/swoole/http/server/start.xml @@ -13,9 +13,9 @@ public voidSwoole\Http\Server::start - + Start the swoole http server. - + @@ -26,9 +26,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/swoole/swoole/lock/construct.xml b/reference/swoole/swoole/lock/construct.xml index 5d638c1c2..2c301df15 100644 --- a/reference/swoole/swoole/lock/construct.xml +++ b/reference/swoole/swoole/lock/construct.xml @@ -26,17 +26,17 @@ type - - - + + + file_lock_location - - - + + + @@ -48,7 +48,7 @@ &reftitle.returnvalues; - + --> diff --git a/reference/swoole/swoole/lock/destruct.xml b/reference/swoole/swoole/lock/destruct.xml index 12c7e7ca3..d1d80b721 100644 --- a/reference/swoole/swoole/lock/destruct.xml +++ b/reference/swoole/swoole/lock/destruct.xml @@ -13,9 +13,9 @@ public voidSwoole\Lock::__destruct - + - + @@ -26,9 +26,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/swoole/swoole/lock/lock-read.xml b/reference/swoole/swoole/lock/lock-read.xml index 88e82a8c3..209d69014 100644 --- a/reference/swoole/swoole/lock/lock-read.xml +++ b/reference/swoole/swoole/lock/lock-read.xml @@ -13,9 +13,9 @@ public voidSwoole\Lock::lock_read - + Lock a read-write lock for reading. - + @@ -26,9 +26,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/swoole/swoole/lock/lock.xml b/reference/swoole/swoole/lock/lock.xml index 2ed2659d6..2ed854bcc 100644 --- a/reference/swoole/swoole/lock/lock.xml +++ b/reference/swoole/swoole/lock/lock.xml @@ -13,9 +13,9 @@ public voidSwoole\Lock::lock - + - + @@ -26,9 +26,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/swoole/swoole/lock/trylock-read.xml b/reference/swoole/swoole/lock/trylock-read.xml index 0537d717f..601505257 100644 --- a/reference/swoole/swoole/lock/trylock-read.xml +++ b/reference/swoole/swoole/lock/trylock-read.xml @@ -13,9 +13,9 @@ public voidSwoole\Lock::trylock_read - + - + @@ -26,9 +26,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/swoole/swoole/lock/trylock.xml b/reference/swoole/swoole/lock/trylock.xml index 413a5c203..a5b7522e6 100644 --- a/reference/swoole/swoole/lock/trylock.xml +++ b/reference/swoole/swoole/lock/trylock.xml @@ -13,9 +13,9 @@ public voidSwoole\Lock::trylock - + - + @@ -26,9 +26,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/swoole/swoole/lock/unlock.xml b/reference/swoole/swoole/lock/unlock.xml index 12e8f1159..86e6c57b5 100644 --- a/reference/swoole/swoole/lock/unlock.xml +++ b/reference/swoole/swoole/lock/unlock.xml @@ -13,9 +13,9 @@ public voidSwoole\Lock::unlock - + - + @@ -26,9 +26,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/swoole/swoole/mmap/open.xml b/reference/swoole/swoole/mmap/open.xml index f588c008a..62d0b9226 100644 --- a/reference/swoole/swoole/mmap/open.xml +++ b/reference/swoole/swoole/mmap/open.xml @@ -15,9 +15,9 @@ stringsize stringoffset - + - + @@ -27,25 +27,25 @@ filename - - - + + + size - - - + + + offset - - - + + + @@ -53,9 +53,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/swoole/swoole/mysql/close.xml b/reference/swoole/swoole/mysql/close.xml index bdc7acd9c..c9e6ef268 100644 --- a/reference/swoole/swoole/mysql/close.xml +++ b/reference/swoole/swoole/mysql/close.xml @@ -13,9 +13,9 @@ public voidSwoole\MySQL::close - + - + @@ -26,9 +26,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/swoole/swoole/mysql/connect.xml b/reference/swoole/swoole/mysql/connect.xml index 750b95ba2..91d25e3c6 100644 --- a/reference/swoole/swoole/mysql/connect.xml +++ b/reference/swoole/swoole/mysql/connect.xml @@ -14,9 +14,9 @@ arrayserver_config callablecallback - + Connect to the remote MySQL server. - + @@ -26,17 +26,17 @@ server_config - - - + + + callback - - - + + + @@ -44,9 +44,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/swoole/swoole/mysql/construct.xml b/reference/swoole/swoole/mysql/construct.xml index f31453d7e..2b72b2440 100644 --- a/reference/swoole/swoole/mysql/construct.xml +++ b/reference/swoole/swoole/mysql/construct.xml @@ -13,9 +13,9 @@ public Swoole\MySQL::__construct - + Construct an async MySQL client. - + @@ -30,7 +30,7 @@ &reftitle.returnvalues; - + --> diff --git a/reference/swoole/swoole/mysql/destruct.xml b/reference/swoole/swoole/mysql/destruct.xml index 8b942a668..431f5dcd6 100644 --- a/reference/swoole/swoole/mysql/destruct.xml +++ b/reference/swoole/swoole/mysql/destruct.xml @@ -13,9 +13,9 @@ public voidSwoole\MySQL::__destruct - + - + @@ -26,9 +26,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/swoole/swoole/mysql/getbuffer.xml b/reference/swoole/swoole/mysql/getbuffer.xml index 615d3d1ce..3a188f3c1 100644 --- a/reference/swoole/swoole/mysql/getbuffer.xml +++ b/reference/swoole/swoole/mysql/getbuffer.xml @@ -13,9 +13,9 @@ public ReturnTypeSwoole\MySQL::getBuffer - + - + &warn.undocumented.func; @@ -28,9 +28,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/swoole/swoole/mysql/on.xml b/reference/swoole/swoole/mysql/on.xml index da7dd1987..b0056f93e 100644 --- a/reference/swoole/swoole/mysql/on.xml +++ b/reference/swoole/swoole/mysql/on.xml @@ -14,9 +14,9 @@ stringevent_name callablecallback - + Register callback function based on event name, current only 'close' event is supported. - + @@ -26,17 +26,17 @@ event_name - - - + + + callback - - - + + + @@ -44,9 +44,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/swoole/swoole/mysql/query.xml b/reference/swoole/swoole/mysql/query.xml index 21013dfd2..6b02d40b6 100644 --- a/reference/swoole/swoole/mysql/query.xml +++ b/reference/swoole/swoole/mysql/query.xml @@ -14,9 +14,9 @@ stringsql callablecallback - + - + @@ -26,17 +26,17 @@ sql - - - + + + callback - - - + + + @@ -44,9 +44,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/swoole/swoole/process/alarm.xml b/reference/swoole/swoole/process/alarm.xml index e38eeda36..299b08563 100644 --- a/reference/swoole/swoole/process/alarm.xml +++ b/reference/swoole/swoole/process/alarm.xml @@ -13,9 +13,9 @@ public static voidSwoole\Process::alarm intinterval_usec - + - + @@ -25,9 +25,9 @@ interval_usec - - - + + + @@ -35,9 +35,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/swoole/swoole/process/close.xml b/reference/swoole/swoole/process/close.xml index fc4d27d25..9d774f39a 100644 --- a/reference/swoole/swoole/process/close.xml +++ b/reference/swoole/swoole/process/close.xml @@ -13,9 +13,9 @@ public voidSwoole\Process::close - + Close the pipe to the child process. - + @@ -26,9 +26,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/swoole/swoole/process/construct.xml b/reference/swoole/swoole/process/construct.xml index 0f490a3ec..b706c0168 100644 --- a/reference/swoole/swoole/process/construct.xml +++ b/reference/swoole/swoole/process/construct.xml @@ -15,9 +15,9 @@ boolredirect_stdin_and_stdout intpipe_type - + - + @@ -27,25 +27,25 @@ callback - - - + + + redirect_stdin_and_stdout - - - + + + pipe_type - - - + + + @@ -57,7 +57,7 @@ &reftitle.returnvalues; - + --> diff --git a/reference/swoole/swoole/process/daemon.xml b/reference/swoole/swoole/process/daemon.xml index 8256fb396..a8f8d5c59 100644 --- a/reference/swoole/swoole/process/daemon.xml +++ b/reference/swoole/swoole/process/daemon.xml @@ -14,9 +14,9 @@ boolnochdir boolnoclose - + - + &warn.undocumented.func; @@ -28,17 +28,17 @@ nochdir - - - + + + noclose - - - + + + @@ -46,9 +46,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/swoole/swoole/process/destruct.xml b/reference/swoole/swoole/process/destruct.xml index 3d0c35c25..a59e5124b 100644 --- a/reference/swoole/swoole/process/destruct.xml +++ b/reference/swoole/swoole/process/destruct.xml @@ -13,9 +13,9 @@ public voidSwoole\Process::__destruct - + - + @@ -26,9 +26,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/swoole/swoole/process/exec.xml b/reference/swoole/swoole/process/exec.xml index 11fc8e60b..431f7cdf8 100644 --- a/reference/swoole/swoole/process/exec.xml +++ b/reference/swoole/swoole/process/exec.xml @@ -14,9 +14,9 @@ stringexec_file stringargs - + The process will be replaced to be the system command process, but the pipe to the parent process will be kept. - + @@ -26,17 +26,17 @@ exec_file - - - + + + args - - - + + + @@ -44,9 +44,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/swoole/swoole/process/exit.xml b/reference/swoole/swoole/process/exit.xml index 23bab12a9..0bb43986e 100644 --- a/reference/swoole/swoole/process/exit.xml +++ b/reference/swoole/swoole/process/exit.xml @@ -13,9 +13,9 @@ public voidSwoole\Process::exit stringexit_code - + - + @@ -25,9 +25,9 @@ exit_code - - - + + + @@ -35,9 +35,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/swoole/swoole/process/freequeue.xml b/reference/swoole/swoole/process/freequeue.xml index e73a99195..0cfcb65ca 100644 --- a/reference/swoole/swoole/process/freequeue.xml +++ b/reference/swoole/swoole/process/freequeue.xml @@ -13,9 +13,9 @@ public voidSwoole\Process::freeQueue - + - + @@ -26,9 +26,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/swoole/swoole/process/kill.xml b/reference/swoole/swoole/process/kill.xml index dd080a592..535df5847 100644 --- a/reference/swoole/swoole/process/kill.xml +++ b/reference/swoole/swoole/process/kill.xml @@ -14,9 +14,9 @@ intpid intsignal_no - + Send signal to the child process. - + @@ -26,17 +26,17 @@ pid - + Process pid - + signal_no - + Signal to be sent - + @@ -44,9 +44,9 @@ &reftitle.returnvalues; - + &return.success; - + diff --git a/reference/swoole/swoole/process/name.xml b/reference/swoole/swoole/process/name.xml index bdd61064d..18125dbb2 100644 --- a/reference/swoole/swoole/process/name.xml +++ b/reference/swoole/swoole/process/name.xml @@ -13,9 +13,9 @@ public boolSwoole\Process::name stringprocess_name - + - + @@ -25,9 +25,9 @@ process_name - + Set name of the process. - + @@ -35,9 +35,9 @@ &reftitle.returnvalues; - + &return.success; - + diff --git a/reference/swoole/swoole/process/pop.xml b/reference/swoole/swoole/process/pop.xml index abbde4076..9f866a1c2 100644 --- a/reference/swoole/swoole/process/pop.xml +++ b/reference/swoole/swoole/process/pop.xml @@ -13,9 +13,9 @@ public mixedSwoole\Process::pop intmaxsize - + - + @@ -25,9 +25,9 @@ maxsize - - - + + + @@ -35,9 +35,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/swoole/swoole/process/push.xml b/reference/swoole/swoole/process/push.xml index 197d01e8d..3161087f4 100644 --- a/reference/swoole/swoole/process/push.xml +++ b/reference/swoole/swoole/process/push.xml @@ -13,9 +13,9 @@ public boolSwoole\Process::push stringdata - + - + @@ -25,9 +25,9 @@ data - - - + + + @@ -35,9 +35,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/swoole/swoole/process/read.xml b/reference/swoole/swoole/process/read.xml index 356408753..9cc01f0eb 100644 --- a/reference/swoole/swoole/process/read.xml +++ b/reference/swoole/swoole/process/read.xml @@ -13,9 +13,9 @@ public stringSwoole\Process::read intmaxsize - + - + @@ -25,9 +25,9 @@ maxsize - - - + + + @@ -35,9 +35,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/swoole/swoole/process/signal.xml b/reference/swoole/swoole/process/signal.xml index b82b967c2..9ad01fd87 100644 --- a/reference/swoole/swoole/process/signal.xml +++ b/reference/swoole/swoole/process/signal.xml @@ -14,9 +14,9 @@ stringsignal_no callablecallback - + - + @@ -26,17 +26,17 @@ signal_no - - - + + + callback - - - + + + @@ -44,9 +44,9 @@ &reftitle.returnvalues; - + If signal sent successfully, it returns TRUE, otherwise it returns FALSE. - + diff --git a/reference/swoole/swoole/process/start.xml b/reference/swoole/swoole/process/start.xml index 837226db7..d0104f055 100644 --- a/reference/swoole/swoole/process/start.xml +++ b/reference/swoole/swoole/process/start.xml @@ -13,9 +13,9 @@ public voidSwoole\Process::start - + - + @@ -26,9 +26,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/swoole/swoole/process/statqueue.xml b/reference/swoole/swoole/process/statqueue.xml index 60629707e..d69cc0980 100644 --- a/reference/swoole/swoole/process/statqueue.xml +++ b/reference/swoole/swoole/process/statqueue.xml @@ -13,9 +13,9 @@ public arraySwoole\Process::statQueue - + - + @@ -26,10 +26,10 @@ &reftitle.returnvalues; - + The array of status of the message queue. - + diff --git a/reference/swoole/swoole/process/usequeue.xml b/reference/swoole/swoole/process/usequeue.xml index 589fc4218..8a21a686d 100644 --- a/reference/swoole/swoole/process/usequeue.xml +++ b/reference/swoole/swoole/process/usequeue.xml @@ -14,9 +14,9 @@ intkey intmode - + - + @@ -26,17 +26,17 @@ key - - - + + + mode - - - + + + @@ -44,9 +44,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/swoole/swoole/process/wait.xml b/reference/swoole/swoole/process/wait.xml index bc5ba88b2..f48fadca0 100644 --- a/reference/swoole/swoole/process/wait.xml +++ b/reference/swoole/swoole/process/wait.xml @@ -13,9 +13,9 @@ public static arraySwoole\Process::wait boolblocking - + - + @@ -25,9 +25,9 @@ blocking - - - + + + @@ -35,9 +35,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/swoole/swoole/process/write.xml b/reference/swoole/swoole/process/write.xml index 7097e05fd..a7991133a 100644 --- a/reference/swoole/swoole/process/write.xml +++ b/reference/swoole/swoole/process/write.xml @@ -13,9 +13,9 @@ public intSwoole\Process::write stringdata - + - + @@ -25,9 +25,9 @@ data - - - + + + @@ -35,9 +35,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/swoole/swoole/redis/server/format.xml b/reference/swoole/swoole/redis/server/format.xml index 427cb85f3..51ea77e31 100644 --- a/reference/swoole/swoole/redis/server/format.xml +++ b/reference/swoole/swoole/redis/server/format.xml @@ -14,9 +14,9 @@ stringtype stringvalue - + - + &warn.undocumented.func; @@ -28,17 +28,17 @@ type - - - + + + value - - - + + + @@ -46,9 +46,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/swoole/swoole/redis/server/sethandler.xml b/reference/swoole/swoole/redis/server/sethandler.xml index 61dc8e195..b2d9f6d52 100644 --- a/reference/swoole/swoole/redis/server/sethandler.xml +++ b/reference/swoole/swoole/redis/server/sethandler.xml @@ -16,9 +16,9 @@ stringnumber_of_string_param stringtype_of_array_param - + - + &warn.undocumented.func; @@ -30,33 +30,33 @@ command - - - + + + callback - - - + + + number_of_string_param - - - + + + type_of_array_param - - - + + + @@ -64,9 +64,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/swoole/swoole/redis/server/start.xml b/reference/swoole/swoole/redis/server/start.xml index 788cf9de9..2186388f7 100644 --- a/reference/swoole/swoole/redis/server/start.xml +++ b/reference/swoole/swoole/redis/server/start.xml @@ -13,9 +13,9 @@ public ReturnTypeSwoole\Redis\Server::start - + - + &warn.undocumented.func; @@ -28,9 +28,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/swoole/swoole/runtime/enableCoroutine.xml b/reference/swoole/swoole/runtime/enableCoroutine.xml index 79e6dc613..4216269cb 100644 --- a/reference/swoole/swoole/runtime/enableCoroutine.xml +++ b/reference/swoole/swoole/runtime/enableCoroutine.xml @@ -13,10 +13,10 @@ public static voidSwoole\Runtime::enableCoroutine intflagsSWOOLE_HOOK_ALL - + This method enables coroutine support for specified PHP functions based on the given flags. It should be called once at the beginning of the application. - + @@ -25,7 +25,7 @@ flags - + Bitmask of flags specifying which functions to hook. Can be combined using | operator. Available flags: SWOOLE_HOOK_TCP, @@ -48,7 +48,7 @@ SWOOLE_HOOK_PDO_ORACLE, SWOOLE_HOOK_PDO_SQLITE, or SWOOLE_HOOK_ALL for all flags. - + @@ -56,9 +56,9 @@ &reftitle.returnvalues; - + &return.void; - + diff --git a/reference/swoole/swoole/runtime/getHookFlags.xml b/reference/swoole/swoole/runtime/getHookFlags.xml index 93b37eb27..0e015c187 100644 --- a/reference/swoole/swoole/runtime/getHookFlags.xml +++ b/reference/swoole/swoole/runtime/getHookFlags.xml @@ -13,24 +13,24 @@ public static intSwoole\Runtime::getHookFlags - + Gets the current hook flags. Note that the returned flags might differ from what was set if some hooks failed. - + &reftitle.parameters; - + This function has no parameters. - + &reftitle.returnvalues; - + Returns the current hook flags as a bitmask. - + diff --git a/reference/swoole/swoole/runtime/setHookFlags.xml b/reference/swoole/swoole/runtime/setHookFlags.xml index 6f9052c3d..b8b72cb03 100644 --- a/reference/swoole/swoole/runtime/setHookFlags.xml +++ b/reference/swoole/swoole/runtime/setHookFlags.xml @@ -13,10 +13,10 @@ public static boolSwoole\Runtime::setHookFlags intflags - + Sets the hook flags for coroutine support. This dynamically changes the hook flags at runtime. - + @@ -25,9 +25,9 @@ flags - + Bitmask of flags specifying which functions to hook. Same flags as enableCoroutine. - + @@ -35,9 +35,9 @@ &reftitle.returnvalues; - + &return.success; - + diff --git a/reference/swoole/swoole/serialize/pack.xml b/reference/swoole/swoole/serialize/pack.xml index 0bfa9f632..2b2968ec0 100644 --- a/reference/swoole/swoole/serialize/pack.xml +++ b/reference/swoole/swoole/serialize/pack.xml @@ -14,9 +14,9 @@ stringdata intis_fast - + Swoole provides a fast and high performance serialization module. - + @@ -26,17 +26,17 @@ data - - - + + + is_fast - - - + + + @@ -44,9 +44,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/swoole/swoole/serialize/unpack.xml b/reference/swoole/swoole/serialize/unpack.xml index ee40981d5..f9ea06316 100644 --- a/reference/swoole/swoole/serialize/unpack.xml +++ b/reference/swoole/swoole/serialize/unpack.xml @@ -14,9 +14,9 @@ stringdata stringargs - + Unserialize the data. - + @@ -26,17 +26,17 @@ string - - - + + + args - - - + + + @@ -44,9 +44,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/swoole/swoole/server/addlistener.xml b/reference/swoole/swoole/server/addlistener.xml index 895c7521a..bee54a14d 100644 --- a/reference/swoole/swoole/server/addlistener.xml +++ b/reference/swoole/swoole/server/addlistener.xml @@ -15,9 +15,9 @@ intport stringsocket_type - + - + @@ -27,25 +27,25 @@ host - - - + + + port - - - + + + socket_type - - - + + + @@ -53,9 +53,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/swoole/swoole/server/addprocess.xml b/reference/swoole/swoole/server/addprocess.xml index 87d745343..b808ac774 100644 --- a/reference/swoole/swoole/server/addprocess.xml +++ b/reference/swoole/swoole/server/addprocess.xml @@ -13,9 +13,9 @@ public boolSwoole\Server::addProcess swoole_processprocess - + - + @@ -25,9 +25,9 @@ process - - - + + + @@ -35,9 +35,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/swoole/swoole/server/after.xml b/reference/swoole/swoole/server/after.xml index e01cc09d3..dcf53afd1 100644 --- a/reference/swoole/swoole/server/after.xml +++ b/reference/swoole/swoole/server/after.xml @@ -15,9 +15,9 @@ callablecallback stringparam - + - + @@ -27,25 +27,25 @@ after_time_ms - - - + + + callback - - - + + + param - - - + + + @@ -53,9 +53,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/swoole/swoole/server/bind.xml b/reference/swoole/swoole/server/bind.xml index 94ab2db5f..d0dfd2dc0 100644 --- a/reference/swoole/swoole/server/bind.xml +++ b/reference/swoole/swoole/server/bind.xml @@ -14,9 +14,9 @@ intfd intuid - + - + @@ -26,17 +26,17 @@ fd - - - + + + uid - - - + + + @@ -44,9 +44,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/swoole/swoole/server/cleartimer.xml b/reference/swoole/swoole/server/cleartimer.xml index 662c38a4c..eaa382361 100644 --- a/reference/swoole/swoole/server/cleartimer.xml +++ b/reference/swoole/swoole/server/cleartimer.xml @@ -10,20 +10,20 @@ &reftitle.description; - &style.oop; (method): + &style.oop; (method): public voidSwoole\Server::clearTimer inttimer_id - &style.procedural;: + &style.procedural;: voidswoole_timer_clear inttimer_id - + Stop and destroy a timer - - + + @@ -33,9 +33,9 @@ timer_id - - - + + + @@ -44,9 +44,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/swoole/swoole/server/close.xml b/reference/swoole/swoole/server/close.xml index 6fe86d77f..7b5cc085b 100644 --- a/reference/swoole/swoole/server/close.xml +++ b/reference/swoole/swoole/server/close.xml @@ -14,9 +14,9 @@ intfd boolreset - + - + @@ -26,17 +26,17 @@ fd - - - + + + reset - - - + + + @@ -44,9 +44,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/swoole/swoole/server/confirm.xml b/reference/swoole/swoole/server/confirm.xml index b0a078a33..2482da817 100644 --- a/reference/swoole/swoole/server/confirm.xml +++ b/reference/swoole/swoole/server/confirm.xml @@ -13,9 +13,9 @@ public boolSwoole\Server::confirm intfd - + - + @@ -25,9 +25,9 @@ fd - - - + + + @@ -35,9 +35,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/swoole/swoole/server/connection-info.xml b/reference/swoole/swoole/server/connection-info.xml index b3debe462..fd2790c44 100644 --- a/reference/swoole/swoole/server/connection-info.xml +++ b/reference/swoole/swoole/server/connection-info.xml @@ -14,9 +14,9 @@ intfd intreactor_id - + - + @@ -26,17 +26,17 @@ fd - - - + + + reactor_id - - - + + + @@ -44,9 +44,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/swoole/swoole/server/connection-list.xml b/reference/swoole/swoole/server/connection-list.xml index 0d39969ae..3aea164de 100644 --- a/reference/swoole/swoole/server/connection-list.xml +++ b/reference/swoole/swoole/server/connection-list.xml @@ -14,9 +14,9 @@ intstart_fd intpagesize - + - + @@ -26,17 +26,17 @@ start_fd - - - + + + pagesize - - - + + + @@ -44,9 +44,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/swoole/swoole/server/construct.xml b/reference/swoole/swoole/server/construct.xml index 0d670ed3d..f3ed41aac 100644 --- a/reference/swoole/swoole/server/construct.xml +++ b/reference/swoole/swoole/server/construct.xml @@ -16,9 +16,9 @@ intmode intsock_type - + - + @@ -28,33 +28,33 @@ host - - - + + + port - - - + + + mode - - - + + + sock_type - - - + + + @@ -66,7 +66,7 @@ &reftitle.returnvalues; - + --> diff --git a/reference/swoole/swoole/server/defer.xml b/reference/swoole/swoole/server/defer.xml index c0988ce5d..9c16921a2 100644 --- a/reference/swoole/swoole/server/defer.xml +++ b/reference/swoole/swoole/server/defer.xml @@ -13,9 +13,9 @@ public voidSwoole\Server::defer callablecallback - + - + @@ -25,9 +25,9 @@ callback - - - + + + @@ -35,9 +35,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/swoole/swoole/server/exist.xml b/reference/swoole/swoole/server/exist.xml index f51cae450..026edd804 100644 --- a/reference/swoole/swoole/server/exist.xml +++ b/reference/swoole/swoole/server/exist.xml @@ -13,9 +13,9 @@ public boolSwoole\Server::exist intfd - + - + @@ -25,9 +25,9 @@ fd - - - + + + @@ -35,9 +35,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/swoole/swoole/server/finish.xml b/reference/swoole/swoole/server/finish.xml index 06dc3a1b1..77f9b2265 100644 --- a/reference/swoole/swoole/server/finish.xml +++ b/reference/swoole/swoole/server/finish.xml @@ -13,9 +13,9 @@ public voidSwoole\Server::finish stringdata - + - + @@ -25,9 +25,9 @@ data - - - + + + @@ -35,9 +35,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/swoole/swoole/server/getclientinfo.xml b/reference/swoole/swoole/server/getclientinfo.xml index 39a3729e2..99f555330 100644 --- a/reference/swoole/swoole/server/getclientinfo.xml +++ b/reference/swoole/swoole/server/getclientinfo.xml @@ -15,9 +15,9 @@ intreactor_id boolignore_error - + - + @@ -27,26 +27,26 @@ fd - + File descriptors. - + reactor_id - + The Reactor thread ID where the connection is made. - + ignore_error - + Whether to ignore errors, if set to true, connection information will be returned even if the connection is closed. - + @@ -54,9 +54,9 @@ &reftitle.returnvalues; - + Returns information about the client connection. - + diff --git a/reference/swoole/swoole/server/getclientlist.xml b/reference/swoole/swoole/server/getclientlist.xml index b532ea60f..4e5ee42bb 100644 --- a/reference/swoole/swoole/server/getclientlist.xml +++ b/reference/swoole/swoole/server/getclientlist.xml @@ -14,9 +14,9 @@ intstart_fd intpagesize - + - + &warn.undocumented.func; @@ -28,17 +28,17 @@ start_fd - - - + + + pagesize - - - + + + @@ -46,9 +46,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/swoole/swoole/server/getlasterror.xml b/reference/swoole/swoole/server/getlasterror.xml index fe19e3099..32918f4fd 100644 --- a/reference/swoole/swoole/server/getlasterror.xml +++ b/reference/swoole/swoole/server/getlasterror.xml @@ -13,9 +13,9 @@ public intSwoole\Server::getLastError - + - + @@ -26,9 +26,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/swoole/swoole/server/heartbeat.xml b/reference/swoole/swoole/server/heartbeat.xml index 0d55aa367..37293b4f5 100644 --- a/reference/swoole/swoole/server/heartbeat.xml +++ b/reference/swoole/swoole/server/heartbeat.xml @@ -13,9 +13,9 @@ public mixedSwoole\Server::heartbeat boolif_close_connection - + - + @@ -25,9 +25,9 @@ if_close_connection - - - + + + @@ -35,9 +35,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/swoole/swoole/server/listen.xml b/reference/swoole/swoole/server/listen.xml index cb3dfaf33..cf7e1c516 100644 --- a/reference/swoole/swoole/server/listen.xml +++ b/reference/swoole/swoole/server/listen.xml @@ -15,9 +15,9 @@ intport stringsocket_type - + - + @@ -27,25 +27,25 @@ host - - - + + + port - - - + + + socket_type - - - + + + @@ -53,9 +53,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/swoole/swoole/server/on.xml b/reference/swoole/swoole/server/on.xml index 0100e4088..16fef0265 100644 --- a/reference/swoole/swoole/server/on.xml +++ b/reference/swoole/swoole/server/on.xml @@ -14,9 +14,9 @@ stringevent_name callablecallback - + - + @@ -26,17 +26,17 @@ event_name - - - + + + callback - - - + + + @@ -44,9 +44,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/swoole/swoole/server/pause.xml b/reference/swoole/swoole/server/pause.xml index da7e3b2cb..ec7de2494 100644 --- a/reference/swoole/swoole/server/pause.xml +++ b/reference/swoole/swoole/server/pause.xml @@ -13,9 +13,9 @@ public voidSwoole\Server::pause intfd - + - + @@ -25,9 +25,9 @@ fd - - - + + + @@ -35,9 +35,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/swoole/swoole/server/port/construct.xml b/reference/swoole/swoole/server/port/construct.xml index 1d2afc2a3..894604f9b 100644 --- a/reference/swoole/swoole/server/port/construct.xml +++ b/reference/swoole/swoole/server/port/construct.xml @@ -13,9 +13,9 @@ private Swoole\Server\Port::__construct - + - + @@ -30,7 +30,7 @@ &reftitle.returnvalues; - + --> diff --git a/reference/swoole/swoole/server/port/destruct.xml b/reference/swoole/swoole/server/port/destruct.xml index a2d572f39..a64136026 100644 --- a/reference/swoole/swoole/server/port/destruct.xml +++ b/reference/swoole/swoole/server/port/destruct.xml @@ -13,9 +13,9 @@ public voidSwoole\Server\Port::__destruct - + - + @@ -26,9 +26,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/swoole/swoole/server/port/on.xml b/reference/swoole/swoole/server/port/on.xml index 9db4e2da7..42f334eb4 100644 --- a/reference/swoole/swoole/server/port/on.xml +++ b/reference/swoole/swoole/server/port/on.xml @@ -14,9 +14,9 @@ stringevent_name callablecallback - + - + @@ -26,17 +26,17 @@ event_name - - - + + + callback - - - + + + @@ -44,9 +44,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/swoole/swoole/server/port/set.xml b/reference/swoole/swoole/server/port/set.xml index b374466bc..3c8906cae 100644 --- a/reference/swoole/swoole/server/port/set.xml +++ b/reference/swoole/swoole/server/port/set.xml @@ -13,9 +13,9 @@ public voidSwoole\Server\Port::set arraysettings - + - + @@ -25,9 +25,9 @@ settings - - - + + + @@ -35,9 +35,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/swoole/swoole/server/protect.xml b/reference/swoole/swoole/server/protect.xml index 176619955..5bf1d143f 100644 --- a/reference/swoole/swoole/server/protect.xml +++ b/reference/swoole/swoole/server/protect.xml @@ -14,9 +14,9 @@ intfd boolis_protected - + - + @@ -26,17 +26,17 @@ fd - - - + + + is_protected - - - + + + @@ -44,9 +44,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/swoole/swoole/server/reload.xml b/reference/swoole/swoole/server/reload.xml index 797a5b7b3..016e3c80e 100644 --- a/reference/swoole/swoole/server/reload.xml +++ b/reference/swoole/swoole/server/reload.xml @@ -13,9 +13,9 @@ public boolSwoole\Server::reload - + - + @@ -26,9 +26,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/swoole/swoole/server/resume.xml b/reference/swoole/swoole/server/resume.xml index cb6d7f695..095ae6a91 100644 --- a/reference/swoole/swoole/server/resume.xml +++ b/reference/swoole/swoole/server/resume.xml @@ -13,9 +13,9 @@ public voidSwoole\Server::resume intfd - + - + @@ -25,9 +25,9 @@ fd - - - + + + @@ -35,9 +35,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/swoole/swoole/server/send.xml b/reference/swoole/swoole/server/send.xml index fc61c9405..f8b678d61 100644 --- a/reference/swoole/swoole/server/send.xml +++ b/reference/swoole/swoole/server/send.xml @@ -15,9 +15,9 @@ stringdata intreactor_id - + - + &warn.undocumented.func; @@ -29,25 +29,25 @@ fd - - - + + + data - - - + + + reactor_id - - - + + + @@ -55,9 +55,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/swoole/swoole/server/sendfile.xml b/reference/swoole/swoole/server/sendfile.xml index e783fd546..74a3b5b05 100644 --- a/reference/swoole/swoole/server/sendfile.xml +++ b/reference/swoole/swoole/server/sendfile.xml @@ -15,9 +15,9 @@ stringfilename intoffset - + - + &warn.undocumented.func; @@ -29,25 +29,25 @@ fd - - - + + + filename - - - + + + offset - - - + + + @@ -55,9 +55,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/swoole/swoole/server/sendmessage.xml b/reference/swoole/swoole/server/sendmessage.xml index 0e9f602ab..1894f1b16 100644 --- a/reference/swoole/swoole/server/sendmessage.xml +++ b/reference/swoole/swoole/server/sendmessage.xml @@ -14,9 +14,9 @@ intworker_id stringdata - + - + @@ -26,17 +26,17 @@ dst_worker_id - - - + + + data - - - + + + @@ -44,9 +44,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/swoole/swoole/server/sendto.xml b/reference/swoole/swoole/server/sendto.xml index 9f9a0126d..9d7553a6e 100644 --- a/reference/swoole/swoole/server/sendto.xml +++ b/reference/swoole/swoole/server/sendto.xml @@ -16,9 +16,9 @@ stringdata stringserver_socket - + - + @@ -28,33 +28,33 @@ ip - - - + + + port - - - + + + data - - - + + + server_socket - - - + + + @@ -62,9 +62,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/swoole/swoole/server/sendwait.xml b/reference/swoole/swoole/server/sendwait.xml index f51e5ec80..918f364f1 100644 --- a/reference/swoole/swoole/server/sendwait.xml +++ b/reference/swoole/swoole/server/sendwait.xml @@ -14,9 +14,9 @@ intfd stringdata - + - + &warn.undocumented.func; @@ -28,17 +28,17 @@ fd - - - + + + data - - - + + + @@ -46,9 +46,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/swoole/swoole/server/set.xml b/reference/swoole/swoole/server/set.xml index b115c883e..6f0605dba 100644 --- a/reference/swoole/swoole/server/set.xml +++ b/reference/swoole/swoole/server/set.xml @@ -13,9 +13,9 @@ public ReturnTypeSwoole\Server::set arraysettings - + Set the runtime settings of the swoole server. The settings can be accessed by $server->setting when the swoole server has started. - + @@ -25,9 +25,9 @@ settings - - - + + + @@ -35,9 +35,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/swoole/swoole/server/shutdown.xml b/reference/swoole/swoole/server/shutdown.xml index 47bcbc410..c834a6edf 100644 --- a/reference/swoole/swoole/server/shutdown.xml +++ b/reference/swoole/swoole/server/shutdown.xml @@ -13,9 +13,9 @@ public voidSwoole\Server::shutdown - + - + @@ -26,9 +26,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/swoole/swoole/server/start.xml b/reference/swoole/swoole/server/start.xml index 835113cf7..2cc194503 100644 --- a/reference/swoole/swoole/server/start.xml +++ b/reference/swoole/swoole/server/start.xml @@ -13,9 +13,9 @@ public voidSwoole\Server::start - + - + @@ -26,9 +26,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/swoole/swoole/server/stats.xml b/reference/swoole/swoole/server/stats.xml index e936618a3..c919088c1 100644 --- a/reference/swoole/swoole/server/stats.xml +++ b/reference/swoole/swoole/server/stats.xml @@ -13,9 +13,9 @@ public arraySwoole\Server::stats - + - + @@ -26,9 +26,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/swoole/swoole/server/stop.xml b/reference/swoole/swoole/server/stop.xml index c32095252..efaa58a6f 100644 --- a/reference/swoole/swoole/server/stop.xml +++ b/reference/swoole/swoole/server/stop.xml @@ -13,9 +13,9 @@ public boolSwoole\Server::stop intworker_id - + - + @@ -25,9 +25,9 @@ worker_id - - - + + + @@ -35,9 +35,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/swoole/swoole/server/task.xml b/reference/swoole/swoole/server/task.xml index 74e0005a7..d8f469c21 100644 --- a/reference/swoole/swoole/server/task.xml +++ b/reference/swoole/swoole/server/task.xml @@ -15,9 +15,9 @@ intdst_worker_id callablecallback - + - + &warn.undocumented.func; @@ -29,25 +29,25 @@ data - - - + + + dst_worker_id - - - + + + callback - - - + + + @@ -55,9 +55,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/swoole/swoole/server/taskwait.xml b/reference/swoole/swoole/server/taskwait.xml index 80f4361a6..3a565e36b 100644 --- a/reference/swoole/swoole/server/taskwait.xml +++ b/reference/swoole/swoole/server/taskwait.xml @@ -15,9 +15,9 @@ floattimeout intworker_id - + - + &warn.undocumented.func; @@ -29,25 +29,25 @@ data - - - + + + timeout - - - + + + worker_id - - - + + + @@ -55,9 +55,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/swoole/swoole/server/taskwaitmulti.xml b/reference/swoole/swoole/server/taskwaitmulti.xml index a3d05de56..7baf05dab 100644 --- a/reference/swoole/swoole/server/taskwaitmulti.xml +++ b/reference/swoole/swoole/server/taskwaitmulti.xml @@ -14,9 +14,9 @@ arraytasks floattimeout_ms - + - + @@ -26,17 +26,17 @@ tasks - - - + + + timeout_ms - - - + + + @@ -44,9 +44,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/swoole/swoole/server/tick.xml b/reference/swoole/swoole/server/tick.xml index 8baac591a..c15e84ede 100644 --- a/reference/swoole/swoole/server/tick.xml +++ b/reference/swoole/swoole/server/tick.xml @@ -14,9 +14,9 @@ intinterval_ms callablecallback - + - + @@ -26,17 +26,17 @@ interval_ms - - - + + + callback - - - + + + @@ -44,9 +44,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/swoole/swoole/table/column.xml b/reference/swoole/swoole/table/column.xml index ab138d57c..e3719753b 100644 --- a/reference/swoole/swoole/table/column.xml +++ b/reference/swoole/swoole/table/column.xml @@ -15,9 +15,9 @@ stringtype intsize - + - + @@ -27,25 +27,25 @@ name - + Specify the name of the field. - + type - + Specify the field type. - + size - + Specify the maximum length of the string field. - + @@ -53,9 +53,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/swoole/swoole/table/construct.xml b/reference/swoole/swoole/table/construct.xml index 67a515d55..36957db0a 100644 --- a/reference/swoole/swoole/table/construct.xml +++ b/reference/swoole/swoole/table/construct.xml @@ -13,9 +13,9 @@ public Swoole\Table::__construct inttable_size - + - + @@ -25,9 +25,9 @@ table_size - - - + + + @@ -39,7 +39,7 @@ &reftitle.returnvalues; - + --> diff --git a/reference/swoole/swoole/table/count.xml b/reference/swoole/swoole/table/count.xml index 3fc6fe35a..5ca6bd781 100644 --- a/reference/swoole/swoole/table/count.xml +++ b/reference/swoole/swoole/table/count.xml @@ -13,9 +13,9 @@ public intSwoole\Table::count - + - + @@ -26,9 +26,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/swoole/swoole/table/create.xml b/reference/swoole/swoole/table/create.xml index ceed55901..3204011e5 100644 --- a/reference/swoole/swoole/table/create.xml +++ b/reference/swoole/swoole/table/create.xml @@ -13,9 +13,9 @@ public boolSwoole\Table::create - + - + @@ -26,9 +26,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/swoole/swoole/table/current.xml b/reference/swoole/swoole/table/current.xml index 40728de83..974576b54 100644 --- a/reference/swoole/swoole/table/current.xml +++ b/reference/swoole/swoole/table/current.xml @@ -13,9 +13,9 @@ public arraySwoole\Table::current - + - + @@ -26,9 +26,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/swoole/swoole/table/decr.xml b/reference/swoole/swoole/table/decr.xml index fa1f343f6..9f1c26f5a 100644 --- a/reference/swoole/swoole/table/decr.xml +++ b/reference/swoole/swoole/table/decr.xml @@ -15,9 +15,9 @@ stringcolumn intdecrby - + - + @@ -27,25 +27,25 @@ key - + Key of the data. - + column - + Specify the column name. - + decrby - + Decrement value. - + @@ -53,9 +53,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/swoole/swoole/table/del.xml b/reference/swoole/swoole/table/del.xml index e51b9eb37..ae7ccf65c 100644 --- a/reference/swoole/swoole/table/del.xml +++ b/reference/swoole/swoole/table/del.xml @@ -13,9 +13,9 @@ public boolSwoole\Table::del stringkey - + - + @@ -25,9 +25,9 @@ key - - - + + + @@ -35,9 +35,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/swoole/swoole/table/destroy.xml b/reference/swoole/swoole/table/destroy.xml index 305919efe..e24bd7dad 100644 --- a/reference/swoole/swoole/table/destroy.xml +++ b/reference/swoole/swoole/table/destroy.xml @@ -13,9 +13,9 @@ public boolSwoole\Table::destroy - + - + @@ -26,9 +26,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/swoole/swoole/table/exist.xml b/reference/swoole/swoole/table/exist.xml index e23a42804..913d96fe5 100644 --- a/reference/swoole/swoole/table/exist.xml +++ b/reference/swoole/swoole/table/exist.xml @@ -13,9 +13,9 @@ public boolSwoole\Table::exist stringkey - + - + @@ -25,9 +25,9 @@ key - - - + + + @@ -35,9 +35,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/swoole/swoole/table/get.xml b/reference/swoole/swoole/table/get.xml index 6fc25128a..097286bd1 100644 --- a/reference/swoole/swoole/table/get.xml +++ b/reference/swoole/swoole/table/get.xml @@ -14,9 +14,9 @@ stringkey stringfield - + - + @@ -26,17 +26,17 @@ key - - - + + + field - - - + + + @@ -44,9 +44,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/swoole/swoole/table/incr.xml b/reference/swoole/swoole/table/incr.xml index e22376d5b..97ca3c370 100644 --- a/reference/swoole/swoole/table/incr.xml +++ b/reference/swoole/swoole/table/incr.xml @@ -15,9 +15,9 @@ stringcolumn intincrby - + - + @@ -27,25 +27,25 @@ key - + Key for the data. - + column - + Specify the column name. - + incrby - + Increment value. - + @@ -53,9 +53,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/swoole/swoole/table/key.xml b/reference/swoole/swoole/table/key.xml index 73548faec..b59861fe0 100644 --- a/reference/swoole/swoole/table/key.xml +++ b/reference/swoole/swoole/table/key.xml @@ -13,9 +13,9 @@ public mixedSwoole\Table::key - + - + @@ -26,9 +26,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/swoole/swoole/table/next.xml b/reference/swoole/swoole/table/next.xml index 1979c2235..2bdb6ab25 100644 --- a/reference/swoole/swoole/table/next.xml +++ b/reference/swoole/swoole/table/next.xml @@ -13,9 +13,9 @@ public voidSwoole\Table::next - + - + @@ -26,9 +26,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/swoole/swoole/table/rewind.xml b/reference/swoole/swoole/table/rewind.xml index ab988f648..42e92d045 100644 --- a/reference/swoole/swoole/table/rewind.xml +++ b/reference/swoole/swoole/table/rewind.xml @@ -13,9 +13,9 @@ public voidSwoole\Table::rewind - + - + @@ -26,9 +26,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/swoole/swoole/table/set.xml b/reference/swoole/swoole/table/set.xml index 6c4c2656c..df639aaec 100644 --- a/reference/swoole/swoole/table/set.xml +++ b/reference/swoole/swoole/table/set.xml @@ -14,9 +14,9 @@ stringkey arrayvalue - + - + @@ -26,17 +26,17 @@ key - + Key of the data. - + value - + Value of the data. - + @@ -44,9 +44,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/swoole/swoole/table/valid.xml b/reference/swoole/swoole/table/valid.xml index afbb03044..ae7096185 100644 --- a/reference/swoole/swoole/table/valid.xml +++ b/reference/swoole/swoole/table/valid.xml @@ -13,9 +13,9 @@ public boolSwoole\Table::valid - + - + @@ -26,9 +26,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/swoole/swoole/websocket/server/exist.xml b/reference/swoole/swoole/websocket/server/exist.xml index 5f1ed84e3..31210781a 100644 --- a/reference/swoole/swoole/websocket/server/exist.xml +++ b/reference/swoole/swoole/websocket/server/exist.xml @@ -13,9 +13,9 @@ public boolSwoole\WebSocket\Server::exist intfd - + - + @@ -25,9 +25,9 @@ fd - - - + + + @@ -35,9 +35,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/swoole/swoole/websocket/server/on.xml b/reference/swoole/swoole/websocket/server/on.xml index 4aa7063d0..4dd22e95f 100644 --- a/reference/swoole/swoole/websocket/server/on.xml +++ b/reference/swoole/swoole/websocket/server/on.xml @@ -14,9 +14,9 @@ stringevent_name callablecallback - + Register event callback function - + @@ -26,17 +26,17 @@ event_name - - - + + + callback - - - + + + @@ -44,9 +44,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/swoole/swoole/websocket/server/pack.xml b/reference/swoole/swoole/websocket/server/pack.xml index fd3ab7481..1901970b5 100644 --- a/reference/swoole/swoole/websocket/server/pack.xml +++ b/reference/swoole/swoole/websocket/server/pack.xml @@ -16,9 +16,9 @@ stringfinish stringmask - + - + @@ -28,33 +28,33 @@ data - - - + + + opcode - - - + + + finish - - - + + + mask - - - + + + @@ -62,9 +62,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/swoole/swoole/websocket/server/push.xml b/reference/swoole/swoole/websocket/server/push.xml index a174649c8..6ba7b272a 100644 --- a/reference/swoole/swoole/websocket/server/push.xml +++ b/reference/swoole/swoole/websocket/server/push.xml @@ -16,9 +16,9 @@ stringopcode stringfinish - + - + @@ -28,33 +28,33 @@ fd - - - + + + data - - - + + + opcode - - - + + + finish - - - + + + @@ -62,9 +62,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/swoole/swoole/websocket/server/unpack.xml b/reference/swoole/swoole/websocket/server/unpack.xml index 4f36a7872..f0047b5f8 100644 --- a/reference/swoole/swoole/websocket/server/unpack.xml +++ b/reference/swoole/swoole/websocket/server/unpack.xml @@ -13,9 +13,9 @@ public static stringSwoole\WebSocket\Server::unpack binarydata - + - + @@ -25,9 +25,9 @@ data - - - + + + @@ -35,9 +35,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/sync/book.xml b/reference/sync/book.xml index 8b8f71096..36c3bac4b 100644 --- a/reference/sync/book.xml +++ b/reference/sync/book.xml @@ -1,6 +1,6 @@ - + Sync Sync diff --git a/reference/sync/configure.xml b/reference/sync/configure.xml index d41e6a028..55d4c154c 100644 --- a/reference/sync/configure.xml +++ b/reference/sync/configure.xml @@ -1,6 +1,6 @@ -
    +
    &reftitle.install; diff --git a/reference/sync/setup.xml b/reference/sync/setup.xml index 095fcbba7..68b5a0ea5 100644 --- a/reference/sync/setup.xml +++ b/reference/sync/setup.xml @@ -1,6 +1,6 @@ - + &reftitle.setup;
    diff --git a/reference/sync/syncevent.xml b/reference/sync/syncevent.xml index 919efec42..34842e2e0 100644 --- a/reference/sync/syncevent.xml +++ b/reference/sync/syncevent.xml @@ -1,6 +1,6 @@ - + The SyncEvent class SyncEvent diff --git a/reference/sync/syncevent/construct.xml b/reference/sync/syncevent/construct.xml index 666e91319..4e62cb5c0 100644 --- a/reference/sync/syncevent/construct.xml +++ b/reference/sync/syncevent/construct.xml @@ -1,6 +1,6 @@ - + SyncEvent::__construct Constructs a new SyncEvent object diff --git a/reference/sync/syncevent/fire.xml b/reference/sync/syncevent/fire.xml index 21b487be1..06e5e0c59 100644 --- a/reference/sync/syncevent/fire.xml +++ b/reference/sync/syncevent/fire.xml @@ -1,6 +1,6 @@ - + SyncEvent::fire Fires/sets the event diff --git a/reference/sync/syncevent/reset.xml b/reference/sync/syncevent/reset.xml index 83cf874bc..627751c79 100644 --- a/reference/sync/syncevent/reset.xml +++ b/reference/sync/syncevent/reset.xml @@ -1,6 +1,6 @@ - + SyncEvent::reset Resets a manual event diff --git a/reference/sync/syncevent/wait.xml b/reference/sync/syncevent/wait.xml index e3171251b..f38994153 100644 --- a/reference/sync/syncevent/wait.xml +++ b/reference/sync/syncevent/wait.xml @@ -1,6 +1,6 @@ - + SyncEvent::wait Waits for the event to be fired/set diff --git a/reference/sync/syncmutex.xml b/reference/sync/syncmutex.xml index ac21d2ae4..ed3196d17 100644 --- a/reference/sync/syncmutex.xml +++ b/reference/sync/syncmutex.xml @@ -1,6 +1,6 @@ - + The SyncMutex class SyncMutex diff --git a/reference/sync/syncmutex/construct.xml b/reference/sync/syncmutex/construct.xml index 5ff75c557..7c5809b38 100644 --- a/reference/sync/syncmutex/construct.xml +++ b/reference/sync/syncmutex/construct.xml @@ -1,6 +1,6 @@ - + SyncMutex::__construct Constructs a new SyncMutex object diff --git a/reference/sync/syncmutex/lock.xml b/reference/sync/syncmutex/lock.xml index 5a7791d2e..f98cee881 100644 --- a/reference/sync/syncmutex/lock.xml +++ b/reference/sync/syncmutex/lock.xml @@ -1,6 +1,6 @@ - + SyncMutex::lock Waits for an exclusive lock diff --git a/reference/sync/syncmutex/unlock.xml b/reference/sync/syncmutex/unlock.xml index 75a5cd0f6..2b5e0e9e8 100644 --- a/reference/sync/syncmutex/unlock.xml +++ b/reference/sync/syncmutex/unlock.xml @@ -1,6 +1,6 @@ - + SyncMutex::unlock Unlocks the mutex diff --git a/reference/sync/syncreaderwriter.xml b/reference/sync/syncreaderwriter.xml index 551ebf5a7..4dd1ea91a 100644 --- a/reference/sync/syncreaderwriter.xml +++ b/reference/sync/syncreaderwriter.xml @@ -1,6 +1,6 @@ - + The SyncReaderWriter class SyncReaderWriter diff --git a/reference/sync/syncreaderwriter/construct.xml b/reference/sync/syncreaderwriter/construct.xml index 8bc769e70..2341150ee 100644 --- a/reference/sync/syncreaderwriter/construct.xml +++ b/reference/sync/syncreaderwriter/construct.xml @@ -1,6 +1,6 @@ - + SyncReaderWriter::__construct Constructs a new SyncReaderWriter object diff --git a/reference/sync/syncreaderwriter/readlock.xml b/reference/sync/syncreaderwriter/readlock.xml index 8234bb6c2..cbaf2f292 100644 --- a/reference/sync/syncreaderwriter/readlock.xml +++ b/reference/sync/syncreaderwriter/readlock.xml @@ -1,6 +1,6 @@ - + SyncReaderWriter::readlock Waits for a read lock diff --git a/reference/sync/syncreaderwriter/readunlock.xml b/reference/sync/syncreaderwriter/readunlock.xml index 1095994da..9be3190e4 100644 --- a/reference/sync/syncreaderwriter/readunlock.xml +++ b/reference/sync/syncreaderwriter/readunlock.xml @@ -1,6 +1,6 @@ - + SyncReaderWriter::readunlock Releases a read lock diff --git a/reference/sync/syncreaderwriter/writelock.xml b/reference/sync/syncreaderwriter/writelock.xml index 212a54b9e..6ef26bbd2 100644 --- a/reference/sync/syncreaderwriter/writelock.xml +++ b/reference/sync/syncreaderwriter/writelock.xml @@ -1,6 +1,6 @@ - + SyncReaderWriter::writelock Waits for an exclusive write lock diff --git a/reference/sync/syncreaderwriter/writeunlock.xml b/reference/sync/syncreaderwriter/writeunlock.xml index b9fba06ec..3e25a9853 100644 --- a/reference/sync/syncreaderwriter/writeunlock.xml +++ b/reference/sync/syncreaderwriter/writeunlock.xml @@ -1,6 +1,6 @@ - + SyncReaderWriter::writeunlock Releases a write lock diff --git a/reference/sync/syncsemaphore.xml b/reference/sync/syncsemaphore.xml index 34a52c292..41f7ef2dd 100644 --- a/reference/sync/syncsemaphore.xml +++ b/reference/sync/syncsemaphore.xml @@ -1,6 +1,6 @@ - + The SyncSemaphore class SyncSemaphore diff --git a/reference/sync/syncsemaphore/construct.xml b/reference/sync/syncsemaphore/construct.xml index baa6e5c46..377104dd4 100644 --- a/reference/sync/syncsemaphore/construct.xml +++ b/reference/sync/syncsemaphore/construct.xml @@ -1,6 +1,6 @@ - + SyncSemaphore::__construct Constructs a new SyncSemaphore object diff --git a/reference/sync/syncsemaphore/lock.xml b/reference/sync/syncsemaphore/lock.xml index fe4b9323b..b5ea96d4a 100644 --- a/reference/sync/syncsemaphore/lock.xml +++ b/reference/sync/syncsemaphore/lock.xml @@ -1,6 +1,6 @@ - + SyncSemaphore::lock Decreases the count of the semaphore or waits diff --git a/reference/sync/syncsemaphore/unlock.xml b/reference/sync/syncsemaphore/unlock.xml index 57d4c178e..adc9f7eef 100644 --- a/reference/sync/syncsemaphore/unlock.xml +++ b/reference/sync/syncsemaphore/unlock.xml @@ -1,6 +1,6 @@ - + SyncSemaphore::unlock Increases the count of the semaphore diff --git a/reference/sync/syncsharedmemory.xml b/reference/sync/syncsharedmemory.xml index 9c1442795..5a9ac2322 100644 --- a/reference/sync/syncsharedmemory.xml +++ b/reference/sync/syncsharedmemory.xml @@ -1,6 +1,6 @@ - + The SyncSharedMemory class SyncSharedMemory diff --git a/reference/sync/syncsharedmemory/construct.xml b/reference/sync/syncsharedmemory/construct.xml index 37db997c9..d6fa0f3b3 100644 --- a/reference/sync/syncsharedmemory/construct.xml +++ b/reference/sync/syncsharedmemory/construct.xml @@ -1,6 +1,6 @@ - + SyncSharedMemory::__construct Constructs a new SyncSharedMemory object diff --git a/reference/sync/syncsharedmemory/first.xml b/reference/sync/syncsharedmemory/first.xml index 3ecfa36db..14593d64c 100644 --- a/reference/sync/syncsharedmemory/first.xml +++ b/reference/sync/syncsharedmemory/first.xml @@ -1,6 +1,6 @@ - + SyncSharedMemory::first Check to see if the object is the first instance system-wide of named shared memory diff --git a/reference/sync/syncsharedmemory/read.xml b/reference/sync/syncsharedmemory/read.xml index d745d76f9..7cb42a563 100644 --- a/reference/sync/syncsharedmemory/read.xml +++ b/reference/sync/syncsharedmemory/read.xml @@ -1,6 +1,6 @@ - + SyncSharedMemory::read Copy data from named shared memory diff --git a/reference/sync/syncsharedmemory/size.xml b/reference/sync/syncsharedmemory/size.xml index bdd7b70b7..576a631f9 100644 --- a/reference/sync/syncsharedmemory/size.xml +++ b/reference/sync/syncsharedmemory/size.xml @@ -1,6 +1,6 @@ - + SyncSharedMemory::size Returns the size of the named shared memory diff --git a/reference/sync/syncsharedmemory/write.xml b/reference/sync/syncsharedmemory/write.xml index 058a190f1..edf6cc145 100644 --- a/reference/sync/syncsharedmemory/write.xml +++ b/reference/sync/syncsharedmemory/write.xml @@ -1,6 +1,6 @@ - + SyncSharedMemory::write Copy data to named shared memory diff --git a/reference/tcpwrap/book.xml b/reference/tcpwrap/book.xml index 1b31f4c36..bbb862f79 100644 --- a/reference/tcpwrap/book.xml +++ b/reference/tcpwrap/book.xml @@ -9,11 +9,11 @@ &reftitle.intro; - + The TCP wrappers provides a classical Unix mechanism which has been designed to check if the remote client is able to connect from the given IP address. - + diff --git a/reference/tcpwrap/configure.xml b/reference/tcpwrap/configure.xml index d2ef476ec..85c1130dc 100644 --- a/reference/tcpwrap/configure.xml +++ b/reference/tcpwrap/configure.xml @@ -2,13 +2,13 @@
    &reftitle.install; - + &pecl.info; &url.pecl.package;tcpwrap. - - + + &pecl.windows.download; - +
    &reference.trader.ini; diff --git a/reference/ui/configure.xml b/reference/ui/configure.xml index fdf622081..c00d868e8 100644 --- a/reference/ui/configure.xml +++ b/reference/ui/configure.xml @@ -4,13 +4,13 @@
    &reftitle.install; - + Use when compiling PHP. - + - + Windows users should include php_ui.dll into &php.ini; - +
    diff --git a/reference/ui/functions/ui.draw.text.font.fontfamilies.xml b/reference/ui/functions/ui.draw.text.font.fontfamilies.xml index db95341fc..27d86f2e4 100644 --- a/reference/ui/functions/ui.draw.text.font.fontfamilies.xml +++ b/reference/ui/functions/ui.draw.text.font.fontfamilies.xml @@ -13,9 +13,9 @@ arrayUI\Draw\Text\Font\fontFamilies - + Returns an array of valid font families for the current system - + @@ -26,9 +26,9 @@ &reftitle.returnvalues; - + Returns an &array; of valid font families for the current system. - +     diff --git a/reference/ui/functions/ui.quit.xml b/reference/ui/functions/ui.quit.xml index 0238e27fc..f32668cdd 100644 --- a/reference/ui/functions/ui.quit.xml +++ b/reference/ui/functions/ui.quit.xml @@ -13,9 +13,9 @@ voidUI\quit - + Shall cause the main loop to be exited - + @@ -26,9 +26,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/ui/functions/ui.run.xml b/reference/ui/functions/ui.run.xml index 502001cad..e8c5c7f0f 100644 --- a/reference/ui/functions/ui.run.xml +++ b/reference/ui/functions/ui.run.xml @@ -13,9 +13,9 @@ voidUI\run intflags - + Shall cause PHP to enter into the main loop, by default control will not be returned to the caller - + @@ -25,9 +25,9 @@ flags - + Set UI\Loop to return control, and UI\Wait to return control after waiting - + @@ -35,9 +35,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/ui/setup.xml b/reference/ui/setup.xml index 8d6cc37b4..1a75d75d7 100644 --- a/reference/ui/setup.xml +++ b/reference/ui/setup.xml @@ -6,28 +6,28 @@
    &reftitle.required; - - Installation requires the libui library, and PHP 7 or newer. - - - This extension requires the libui library - version 0.1.0 or higher to be installed. See the libui documentation + + Installation requires the libui library, and PHP 7 or newer. + + + This extension requires the libui library + version 0.1.0 or higher to be installed. See the libui documentation for a list of prerequisites. - +
    &reftitle.install; - + &pecl.moved; - - + + &pecl.info; - &url.pecl.package;ui. - - + &url.pecl.package;ui. + + &pecl.windows.download.avail; - +
    diff --git a/reference/ui/ui.area.xml b/reference/ui/ui.area.xml index 5ba1fc9f9..9cc59c335 100644 --- a/reference/ui/ui.area.xml +++ b/reference/ui/ui.area.xml @@ -11,9 +11,9 @@
    &reftitle.intro; - + An Area represents a canvas which can be used to draw, and respond to mouse and key events. - +
    @@ -117,21 +117,21 @@ UI\Area::Super - + UI\Area::Down - Shall be set in the modifiers passed to key and mouse events + Shall be set in the modifiers passed to key and mouse events UI\Area::Up - Shall be set in the modifiers passed to key and mouse events + Shall be set in the modifiers passed to key and mouse events diff --git a/reference/ui/ui.control.xml b/reference/ui/ui.control.xml index 7a48c9465..5043fd1a9 100644 --- a/reference/ui/ui.control.xml +++ b/reference/ui/ui.control.xml @@ -11,9 +11,9 @@
    &reftitle.intro; - + This is the closed base class for all UI Controls. - +
    @@ -32,7 +32,7 @@ - + &Methods; diff --git a/reference/ui/ui.controls.box.xml b/reference/ui/ui.controls.box.xml index 07448f1f3..7fb151bca 100644 --- a/reference/ui/ui.controls.box.xml +++ b/reference/ui/ui.controls.box.xml @@ -11,9 +11,9 @@
    &reftitle.intro; - + A Box allows the arrangement of other controls - +
    @@ -76,9 +76,9 @@ controls - + Contains controls, should not be manipulated directly - + @@ -93,14 +93,14 @@ UI\Controls\Box::Vertical - + UI\Controls\Box::Horizontal - + diff --git a/reference/ui/ui.controls.button.xml b/reference/ui/ui.controls.button.xml index a98ffcec0..f366f2cd4 100644 --- a/reference/ui/ui.controls.button.xml +++ b/reference/ui/ui.controls.button.xml @@ -11,9 +11,9 @@
    &reftitle.intro; - + Represents a labelled clickable button - +
    @@ -29,7 +29,7 @@ UI\Controls\Button - + extends UI\Control @@ -38,11 +38,11 @@ Constructor - + &Methods; - + &InheritedMethods; diff --git a/reference/ui/ui.controls.check.xml b/reference/ui/ui.controls.check.xml index b8d573bcb..fbd898c80 100644 --- a/reference/ui/ui.controls.check.xml +++ b/reference/ui/ui.controls.check.xml @@ -11,9 +11,9 @@
    &reftitle.intro; - + A Check is a labelled checkable box - +
    @@ -29,7 +29,7 @@ UI\Controls\Check - + extends UI\Control @@ -39,10 +39,10 @@ Constructor - + &Methods; - + &InheritedMethods; diff --git a/reference/ui/ui.controls.colorbutton.xml b/reference/ui/ui.controls.colorbutton.xml index 1c080bb97..d9ed69e61 100644 --- a/reference/ui/ui.controls.colorbutton.xml +++ b/reference/ui/ui.controls.colorbutton.xml @@ -11,9 +11,9 @@
    &reftitle.intro; - + A Color Button is a button which displays a color picker when clicked - +
    @@ -29,17 +29,17 @@ UI\Controls\ColorButton - + extends UI\Control - + &Methods; - + &InheritedMethods; diff --git a/reference/ui/ui.controls.combo.xml b/reference/ui/ui.controls.combo.xml index 4ef69d097..930e4d778 100644 --- a/reference/ui/ui.controls.combo.xml +++ b/reference/ui/ui.controls.combo.xml @@ -11,9 +11,9 @@
    &reftitle.intro; - + A Combo control represents a list of options, like the familiar select HTML element. - +
    @@ -29,17 +29,17 @@ UI\Controls\Combo - + extends UI\Control - + &Methods; - + &InheritedMethods; diff --git a/reference/ui/ui.controls.editablecombo.xml b/reference/ui/ui.controls.editablecombo.xml index 3046942c8..c4bb0a14c 100644 --- a/reference/ui/ui.controls.editablecombo.xml +++ b/reference/ui/ui.controls.editablecombo.xml @@ -11,9 +11,9 @@
    &reftitle.intro; - + An Editable Combo is a Combo which allows the user to enter custom options - +
    @@ -29,17 +29,17 @@ UI\Controls\EditableCombo - + extends UI\Control - + &Methods; - + &InheritedMethods; diff --git a/reference/ui/ui.controls.entry.xml b/reference/ui/ui.controls.entry.xml index e774e9fb4..a12998641 100644 --- a/reference/ui/ui.controls.entry.xml +++ b/reference/ui/ui.controls.entry.xml @@ -11,9 +11,9 @@
    &reftitle.intro; - + An Entry is a text entry control, suitable for entering plain text, passwords, or search terms. - +
    @@ -75,21 +75,21 @@ UI\Controls\Entry::Normal - A normal single line entry + A normal single line entry UI\Controls\Entry::Password - A password entry + A password entry UI\Controls\Entry::Search - A search entry + A search entry diff --git a/reference/ui/ui.controls.form.xml b/reference/ui/ui.controls.form.xml index 4c90ba3f5..1a92551da 100644 --- a/reference/ui/ui.controls.form.xml +++ b/reference/ui/ui.controls.form.xml @@ -11,9 +11,9 @@
    &reftitle.intro; - + A Form is a control which allows the arrangement of other controls into a familiar layout (the form). - +
    @@ -29,7 +29,7 @@ UI\Controls\Form - + extends UI\Control @@ -42,10 +42,10 @@ protected controls - + &Methods; - + &InheritedMethods; @@ -59,9 +59,9 @@ controls - + Contains controls, should not be manipulated directly - + diff --git a/reference/ui/ui.controls.grid.xml b/reference/ui/ui.controls.grid.xml index 1c7953e57..e1c825922 100644 --- a/reference/ui/ui.controls.grid.xml +++ b/reference/ui/ui.controls.grid.xml @@ -11,9 +11,9 @@
    &reftitle.intro; - + A Grid is a control which is allows the arrangement of children into a grid - +
    @@ -103,56 +103,56 @@ UI\Controls\Grid::Fill - + UI\Controls\Grid::Start - + UI\Controls\Grid::Center - + UI\Controls\Grid::End - + UI\Controls\Grid::Leading - + UI\Controls\Grid::Top - + UI\Controls\Grid::Trailing - + UI\Controls\Grid::Bottom - + @@ -167,9 +167,9 @@ controls - + Contains controls, should not be manipulated directly - + diff --git a/reference/ui/ui.controls.group.xml b/reference/ui/ui.controls.group.xml index db8114e0a..eac49f392 100644 --- a/reference/ui/ui.controls.group.xml +++ b/reference/ui/ui.controls.group.xml @@ -11,9 +11,9 @@
    &reftitle.intro; - + A Group is a titled container for child controls - +
    @@ -29,7 +29,7 @@ UI\Controls\Group - + extends UI\Control @@ -42,13 +42,13 @@ protected controls - + Constructor &Methods; - + &InheritedMethods; @@ -64,9 +64,9 @@ controls - + Contains controls, should not be manipulated directly - + diff --git a/reference/ui/ui.controls.label.xml b/reference/ui/ui.controls.label.xml index 325260352..9309b53fd 100644 --- a/reference/ui/ui.controls.label.xml +++ b/reference/ui/ui.controls.label.xml @@ -11,9 +11,9 @@
    &reftitle.intro; - + A Label is a single line of text, meant to identify, for the user, some element of the interface. - +
    @@ -29,7 +29,7 @@ UI\Controls\Label - + extends UI\Control @@ -39,10 +39,10 @@ Constructor - + &Methods; - + &InheritedMethods; diff --git a/reference/ui/ui.controls.multilineentry.xml b/reference/ui/ui.controls.multilineentry.xml index 5cd0c1dc6..33cbeccb7 100644 --- a/reference/ui/ui.controls.multilineentry.xml +++ b/reference/ui/ui.controls.multilineentry.xml @@ -11,9 +11,9 @@
    &reftitle.intro; - + A Multiline Entry is a text entry control able to hold multiple lines of text, with or without wrapping. - +
    @@ -70,14 +70,14 @@ UI\Controls\MultilineEntry::Wrap - Allow lines to wrap + Allow lines to wrap UI\Controls\MultilineEntry::NoWrap - Do not allow lines to wrap + Do not allow lines to wrap diff --git a/reference/ui/ui.controls.picker.xml b/reference/ui/ui.controls.picker.xml index ec3fd1e54..492efcc32 100644 --- a/reference/ui/ui.controls.picker.xml +++ b/reference/ui/ui.controls.picker.xml @@ -11,9 +11,9 @@
    &reftitle.intro; - + A Picker represents a button which when clicked presents a native Date/Time/DateTime Picker interface to the user. - +
    @@ -72,21 +72,21 @@ UI\Controls\Picker::Date - A Date Picker + A Date Picker UI\Controls\Picker::Time - A Time Picker + A Time Picker UI\Controls\Picker::DateTime - A Date and Time Picker + A Date and Time Picker diff --git a/reference/ui/ui.controls.progress.xml b/reference/ui/ui.controls.progress.xml index 7954f7fed..bb53077ad 100644 --- a/reference/ui/ui.controls.progress.xml +++ b/reference/ui/ui.controls.progress.xml @@ -11,9 +11,9 @@
    &reftitle.intro; - + A Progress control is a familiar Progress bar: It represents progress as a percentage, with a possible range of 0 to 100 (inclusive). - +
    @@ -29,17 +29,17 @@ UI\Controls\Progress - + extends UI\Control - + &Methods; - + &InheritedMethods; diff --git a/reference/ui/ui.controls.radio.xml b/reference/ui/ui.controls.radio.xml index ead101137..9aecf3840 100644 --- a/reference/ui/ui.controls.radio.xml +++ b/reference/ui/ui.controls.radio.xml @@ -11,9 +11,9 @@
    &reftitle.intro; - + A Radio is similar to the radio input type familiar from HTML - +
    @@ -29,17 +29,17 @@ UI\Controls\Radio - + extends UI\Control - + &Methods; - + &InheritedMethods; diff --git a/reference/ui/ui.controls.separator.xml b/reference/ui/ui.controls.separator.xml index f4d425d7c..e94d52c60 100644 --- a/reference/ui/ui.controls.separator.xml +++ b/reference/ui/ui.controls.separator.xml @@ -11,9 +11,9 @@
    &reftitle.intro; - + A Separator represents a control separator, it has no other function. - +
    @@ -67,14 +67,14 @@ UI\Controls\Separator::Horizontal - A Horizontal Separator + A Horizontal Separator UI\Controls\Separator::Vertical - A Vertical Separator + A Vertical Separator diff --git a/reference/ui/ui.controls.slider.xml b/reference/ui/ui.controls.slider.xml index 7f9a69603..b43c239cc 100644 --- a/reference/ui/ui.controls.slider.xml +++ b/reference/ui/ui.controls.slider.xml @@ -11,9 +11,9 @@
    &reftitle.intro; - + A Slider is a control which represents a range, and a current value in the range. The sliding element of the control (sometimes called the "thumb") reflects the value, and can be adjusted within the range. - +
    @@ -29,7 +29,7 @@ UI\Controls\Slider - + extends UI\Control @@ -38,11 +38,11 @@ Constructor - + &Methods; - + &InheritedMethods; diff --git a/reference/ui/ui.controls.spin.xml b/reference/ui/ui.controls.spin.xml index aed7d1711..36d527e44 100644 --- a/reference/ui/ui.controls.spin.xml +++ b/reference/ui/ui.controls.spin.xml @@ -11,9 +11,9 @@
    &reftitle.intro; - + A Spin box is a text box with an up-down control which changes the integer value in the box, within a defined range - +
    @@ -29,7 +29,7 @@ UI\Controls\Spin - + extends UI\Control @@ -39,10 +39,10 @@ Constructor - + &Methods; - + &InheritedMethods; diff --git a/reference/ui/ui.controls.tab.xml b/reference/ui/ui.controls.tab.xml index 6bb2938e4..424e4997f 100644 --- a/reference/ui/ui.controls.tab.xml +++ b/reference/ui/ui.controls.tab.xml @@ -11,9 +11,9 @@
    &reftitle.intro; - + A Tab can contain many pages of Controls, each with a title, each selectable by the user. - +
    @@ -29,7 +29,7 @@ UI\Controls\Tab - + extends UI\Control @@ -42,10 +42,10 @@ protected controls - + &Methods; - + &InheritedMethods; @@ -61,9 +61,9 @@ controls - + Contains controls, should not be manipulated directly - + diff --git a/reference/ui/ui.draw.brush.gradient.xml b/reference/ui/ui.draw.brush.gradient.xml index 99c0f6122..4ddea6a67 100644 --- a/reference/ui/ui.draw.brush.gradient.xml +++ b/reference/ui/ui.draw.brush.gradient.xml @@ -11,9 +11,9 @@
    &reftitle.intro; - + Abstract for gradient brushes - +
    @@ -30,7 +30,7 @@ abstract UI\Draw\Brush\Gradient     - + extends UI\Draw\Brush @@ -40,7 +40,7 @@ &Methods; - + &InheritedMethods; diff --git a/reference/ui/ui.draw.brush.lineargradient.xml b/reference/ui/ui.draw.brush.lineargradient.xml index 12010456c..153add610 100644 --- a/reference/ui/ui.draw.brush.lineargradient.xml +++ b/reference/ui/ui.draw.brush.lineargradient.xml @@ -11,9 +11,9 @@
    &reftitle.intro; - + - +
    @@ -29,20 +29,20 @@ UI\Draw\Brush\LinearGradient - + extends UI\Draw\Brush\Gradient - + Constructor - + &InheritedMethods; diff --git a/reference/ui/ui.draw.brush.radialgradient.xml b/reference/ui/ui.draw.brush.radialgradient.xml index 7b63ab701..d65556533 100644 --- a/reference/ui/ui.draw.brush.radialgradient.xml +++ b/reference/ui/ui.draw.brush.radialgradient.xml @@ -11,9 +11,9 @@
    &reftitle.intro; - + - +
    @@ -29,7 +29,7 @@ UI\Draw\Brush\RadialGradient - + extends UI\Draw\Brush\Gradient @@ -39,10 +39,10 @@ Constructor - + - + &InheritedMethods; diff --git a/reference/ui/ui.draw.brush.xml b/reference/ui/ui.draw.brush.xml index 6a003796b..b180f3016 100644 --- a/reference/ui/ui.draw.brush.xml +++ b/reference/ui/ui.draw.brush.xml @@ -11,9 +11,9 @@
    &reftitle.intro; - + Represents a solid color brush - +
    @@ -31,13 +31,13 @@     - + Constructor - + &Methods; - +
    diff --git a/reference/ui/ui.draw.color.xml b/reference/ui/ui.draw.color.xml index 0ff735a79..305fc836a 100644 --- a/reference/ui/ui.draw.color.xml +++ b/reference/ui/ui.draw.color.xml @@ -11,9 +11,9 @@
    &reftitle.intro; - + Represents RGBA colours, individual channels are accessible via public properties. - +
    @@ -89,25 +89,25 @@ r - Provides access to the red channel + Provides access to the red channel g - Provides access to the green channel + Provides access to the green channel b - Provides access to the blue channel + Provides access to the blue channel a - Provides access to the alpha channel + Provides access to the alpha channel @@ -123,28 +123,28 @@ UI\Draw\Color::Red - Identifies the red channel + Identifies the red channel UI\Draw\Color::Green - Identifies the green channel + Identifies the green channel UI\Draw\Color::Blue - Identifies the blue channel + Identifies the blue channel UI\Draw\Color::Alpha - Identifies the alpha channel + Identifies the alpha channel diff --git a/reference/ui/ui.draw.line.cap.xml b/reference/ui/ui.draw.line.cap.xml index 2a9488989..6f4487eb3 100644 --- a/reference/ui/ui.draw.line.cap.xml +++ b/reference/ui/ui.draw.line.cap.xml @@ -11,9 +11,9 @@
    &reftitle.intro; - + - +
    diff --git a/reference/ui/ui.draw.line.join.xml b/reference/ui/ui.draw.line.join.xml index 91303b3ad..05efdd976 100644 --- a/reference/ui/ui.draw.line.join.xml +++ b/reference/ui/ui.draw.line.join.xml @@ -11,9 +11,9 @@
    &reftitle.intro; - + - +
    diff --git a/reference/ui/ui.draw.matrix.xml b/reference/ui/ui.draw.matrix.xml index 54ae7ea24..98439bc97 100644 --- a/reference/ui/ui.draw.matrix.xml +++ b/reference/ui/ui.draw.matrix.xml @@ -11,9 +11,9 @@
    &reftitle.intro; - + - +
    @@ -31,7 +31,7 @@ - + &Methods; diff --git a/reference/ui/ui.draw.path.xml b/reference/ui/ui.draw.path.xml index 273238d76..642a8dc91 100644 --- a/reference/ui/ui.draw.path.xml +++ b/reference/ui/ui.draw.path.xml @@ -11,9 +11,9 @@
    &reftitle.intro; - + A Draw Path guides a Draw Pen, telling the Pen where to draw on an Area. - +
    @@ -61,18 +61,18 @@ UI\Draw\Path::Winding - + This is the default draw path mode - +     UI\Draw\Path::Alternate - + This is the alternate draw path mode - + diff --git a/reference/ui/ui.draw.pen.xml b/reference/ui/ui.draw.pen.xml index dd83be9f7..8c6ba3d7a 100644 --- a/reference/ui/ui.draw.pen.xml +++ b/reference/ui/ui.draw.pen.xml @@ -11,9 +11,9 @@
    &reftitle.intro; - + The Pen is passed to the Area Draw event handler, it is used for clipping, filling, stroking, and writing to Draw Paths. - +
    @@ -32,7 +32,7 @@ - + &Methods; diff --git a/reference/ui/ui.draw.stroke.xml b/reference/ui/ui.draw.stroke.xml index c11b3d434..1a89c4130 100644 --- a/reference/ui/ui.draw.stroke.xml +++ b/reference/ui/ui.draw.stroke.xml @@ -11,9 +11,9 @@
    &reftitle.intro; - + Holds the configuration for the Pen to perform a stroke - +
    @@ -31,7 +31,7 @@ - + Constructor diff --git a/reference/ui/ui.draw.text.font.descriptor.xml b/reference/ui/ui.draw.text.font.descriptor.xml index 1acec0444..6388400b1 100644 --- a/reference/ui/ui.draw.text.font.descriptor.xml +++ b/reference/ui/ui.draw.text.font.descriptor.xml @@ -11,9 +11,9 @@
    &reftitle.intro; - + Describes a font - +
    @@ -31,7 +31,7 @@ - + Constructor diff --git a/reference/ui/ui.draw.text.font.italic.xml b/reference/ui/ui.draw.text.font.italic.xml index 34c1bbaa5..9d2b8cf25 100644 --- a/reference/ui/ui.draw.text.font.italic.xml +++ b/reference/ui/ui.draw.text.font.italic.xml @@ -11,9 +11,9 @@
    &reftitle.intro; - + - +
    diff --git a/reference/ui/ui.draw.text.font.stretch.xml b/reference/ui/ui.draw.text.font.stretch.xml index 4f3da6c69..f1e9071e7 100644 --- a/reference/ui/ui.draw.text.font.stretch.xml +++ b/reference/ui/ui.draw.text.font.stretch.xml @@ -11,9 +11,9 @@
    &reftitle.intro; - + - +
    diff --git a/reference/ui/ui.draw.text.font.weight.xml b/reference/ui/ui.draw.text.font.weight.xml index ab3952e8c..32d5706df 100644 --- a/reference/ui/ui.draw.text.font.weight.xml +++ b/reference/ui/ui.draw.text.font.weight.xml @@ -11,9 +11,9 @@
    &reftitle.intro; - + - +
    diff --git a/reference/ui/ui.draw.text.font.xml b/reference/ui/ui.draw.text.font.xml index f1084d49a..7269cafb8 100644 --- a/reference/ui/ui.draw.text.font.xml +++ b/reference/ui/ui.draw.text.font.xml @@ -11,9 +11,9 @@
    &reftitle.intro; - + Loads a described font - +
    @@ -31,7 +31,7 @@ - + Constructor diff --git a/reference/ui/ui.draw.text.layout.xml b/reference/ui/ui.draw.text.layout.xml index 5a86970d2..bfb723726 100644 --- a/reference/ui/ui.draw.text.layout.xml +++ b/reference/ui/ui.draw.text.layout.xml @@ -11,9 +11,9 @@
    &reftitle.intro; - + A Text Layout represents the layout of text which will be drawn by the Pen - +
    @@ -31,10 +31,10 @@ - + Constructor - + &Methods; diff --git a/reference/ui/ui.exception.invalidargumentexception.xml b/reference/ui/ui.exception.invalidargumentexception.xml index 434da197d..05e3b6d33 100644 --- a/reference/ui/ui.exception.invalidargumentexception.xml +++ b/reference/ui/ui.exception.invalidargumentexception.xml @@ -11,9 +11,9 @@
    &reftitle.intro; - + - +
    @@ -29,12 +29,12 @@ UI\Exception\InvalidArgumentException - + extends InvalidArgumentException - + Throwable @@ -42,7 +42,7 @@ &InheritedProperties; - + &InheritedMethods; diff --git a/reference/ui/ui.exception.runtimeexception.xml b/reference/ui/ui.exception.runtimeexception.xml index 89f379417..49a3e6aff 100644 --- a/reference/ui/ui.exception.runtimeexception.xml +++ b/reference/ui/ui.exception.runtimeexception.xml @@ -11,9 +11,9 @@
    &reftitle.intro; - + - +
    @@ -29,12 +29,12 @@ UI\Exception\RuntimeException - + extends RuntimeException - + Throwable @@ -42,7 +42,7 @@ &InheritedProperties; - + &InheritedMethods; diff --git a/reference/ui/ui.executor.xml b/reference/ui/ui.executor.xml index cf240f1bc..8a700083c 100644 --- a/reference/ui/ui.executor.xml +++ b/reference/ui/ui.executor.xml @@ -11,9 +11,9 @@
    &reftitle.intro; - + This facility schedules repetitive execution of a callback, useful for animations and other such activities. - +
    @@ -35,7 +35,7 @@ Constructor - + &Methods; diff --git a/reference/ui/ui.key.xml b/reference/ui/ui.key.xml index cf1e612c8..0f2685e91 100644 --- a/reference/ui/ui.key.xml +++ b/reference/ui/ui.key.xml @@ -11,9 +11,9 @@
    &reftitle.intro; - + - +
    diff --git a/reference/ui/ui.menu.xml b/reference/ui/ui.menu.xml index dce779bc8..89c099db3 100644 --- a/reference/ui/ui.menu.xml +++ b/reference/ui/ui.menu.xml @@ -11,9 +11,9 @@
    &reftitle.intro; - + Menus must be constructed before the first Window, and can be shown on any Window - +
    @@ -31,7 +31,7 @@ - + Constructor diff --git a/reference/ui/ui.menuitem.xml b/reference/ui/ui.menuitem.xml index 165720394..02e76b14a 100644 --- a/reference/ui/ui.menuitem.xml +++ b/reference/ui/ui.menuitem.xml @@ -11,9 +11,9 @@
    &reftitle.intro; - + Menu Items should only be created by the Menu - +
    @@ -31,7 +31,7 @@ - + &Methods; diff --git a/reference/ui/ui.point.xml b/reference/ui/ui.point.xml index 2e47a6987..e83a7afe7 100644 --- a/reference/ui/ui.point.xml +++ b/reference/ui/ui.point.xml @@ -11,9 +11,9 @@
    &reftitle.intro; - + Points are used throughout UI to represent co-ordinates on a screen, control, or area. - +
    @@ -44,7 +44,7 @@ Constructor - + &Methods; @@ -52,7 +52,7 @@
    - +
    &reftitle.properties; @@ -60,17 +60,17 @@ x - + Holds the X co-ordinate, can be read/written directly - + y - + Holds the Y co-ordinate, can be read/written directly - + diff --git a/reference/ui/ui.size.xml b/reference/ui/ui.size.xml index a285ac0ae..529fff5e7 100644 --- a/reference/ui/ui.size.xml +++ b/reference/ui/ui.size.xml @@ -11,9 +11,9 @@
    &reftitle.intro; - + Sizes are used throughout UI to represent the size of a screen, control, or area. - +
    @@ -44,7 +44,7 @@ Constructor - + &Methods; @@ -59,17 +59,17 @@ width - + Holds the width, can be read/written directly - + height - + Holds the height, can be read/written directly - + diff --git a/reference/ui/ui.window.xml b/reference/ui/ui.window.xml index 4a63a06d1..cc933b2da 100644 --- a/reference/ui/ui.window.xml +++ b/reference/ui/ui.window.xml @@ -11,9 +11,9 @@
    &reftitle.intro; - + Represents a UI Window - +
    @@ -29,7 +29,7 @@ UI\Window - + extends UI\Control @@ -44,10 +44,10 @@ Constructor - + &Methods; - + &InheritedMethods; @@ -63,9 +63,9 @@ controls - + Contains controls, should not be manipulated directly - + diff --git a/reference/ui/ui/area/ondraw.xml b/reference/ui/ui/area/ondraw.xml index f971e9ef3..4374b22e6 100644 --- a/reference/ui/ui/area/ondraw.xml +++ b/reference/ui/ui/area/ondraw.xml @@ -16,9 +16,9 @@ UI\PointclipPoint UI\SizeclipSize - + Shall be invoked when this Area requires redrawing - + @@ -28,33 +28,33 @@ pen - + A Pen suitable for drawing in this Area - + areaSize - + The size of the Area - + clipPoint - + The clip point of the Area - + clipSize - + The clip size of the Area - + diff --git a/reference/ui/ui/area/onkey.xml b/reference/ui/ui/area/onkey.xml index 9a2247040..d285b3207 100644 --- a/reference/ui/ui/area/onkey.xml +++ b/reference/ui/ui/area/onkey.xml @@ -15,9 +15,9 @@ intext intflags - + Shall be executed on key events - + @@ -27,25 +27,25 @@ key - + The key pressed - + ext - + The extended key pressed - + flags - + Event modifiers - + @@ -53,9 +53,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/ui/ui/area/onmouse.xml b/reference/ui/ui/area/onmouse.xml index da448b658..9f37f7aaa 100644 --- a/reference/ui/ui/area/onmouse.xml +++ b/reference/ui/ui/area/onmouse.xml @@ -15,9 +15,9 @@ UI\SizeareaSize intflags - + Shall be executed on mouse events - + @@ -27,25 +27,25 @@ areaPoint - + The co-ordinates of the event - + areaSize - + The size of the area of the event - + flags - + Event modifiers - + diff --git a/reference/ui/ui/area/redraw.xml b/reference/ui/ui/area/redraw.xml index 9fb70ec27..c03f70c78 100644 --- a/reference/ui/ui/area/redraw.xml +++ b/reference/ui/ui/area/redraw.xml @@ -13,9 +13,9 @@ public UI\Area::redraw - + Requests that this Area is redrawn - + @@ -26,9 +26,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/ui/ui/area/scrollto.xml b/reference/ui/ui/area/scrollto.xml index 43ef2d991..a0dbf3543 100644 --- a/reference/ui/ui/area/scrollto.xml +++ b/reference/ui/ui/area/scrollto.xml @@ -14,9 +14,9 @@ UI\Pointpoint UI\Sizesize - + Scroll this Area - + @@ -26,17 +26,17 @@ point - + The point to scroll to - + size - + The size of the scroll pane - + diff --git a/reference/ui/ui/area/setsize.xml b/reference/ui/ui/area/setsize.xml index 49d734b23..89aa1e6ac 100644 --- a/reference/ui/ui/area/setsize.xml +++ b/reference/ui/ui/area/setsize.xml @@ -13,9 +13,9 @@ public UI\Area::setSize UI\Sizesize - + Sets the size of this Area - + @@ -25,9 +25,9 @@ size - + The new size - + diff --git a/reference/ui/ui/control/destroy.xml b/reference/ui/ui/control/destroy.xml index 0dfe34696..25e164b15 100644 --- a/reference/ui/ui/control/destroy.xml +++ b/reference/ui/ui/control/destroy.xml @@ -13,9 +13,9 @@ public UI\Control::destroy - + Shall destroy this Control - + @@ -26,9 +26,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/ui/ui/control/disable.xml b/reference/ui/ui/control/disable.xml index b1df41f49..70a46ae2a 100644 --- a/reference/ui/ui/control/disable.xml +++ b/reference/ui/ui/control/disable.xml @@ -13,9 +13,9 @@ public UI\Control::disable - + Shall disable this Control - + @@ -26,9 +26,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/ui/ui/control/enable.xml b/reference/ui/ui/control/enable.xml index 907ebc1ce..0da4c104c 100644 --- a/reference/ui/ui/control/enable.xml +++ b/reference/ui/ui/control/enable.xml @@ -13,9 +13,9 @@ public UI\Control::enable - + Shall enable this Control - + @@ -26,9 +26,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/ui/ui/control/getparent.xml b/reference/ui/ui/control/getparent.xml index 3945071b0..2b7faf8ba 100644 --- a/reference/ui/ui/control/getparent.xml +++ b/reference/ui/ui/control/getparent.xml @@ -13,9 +13,9 @@ public UI\ControlUI\Control::getParent - + Shall return the parent Control - + @@ -26,9 +26,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/ui/ui/control/gettoplevel.xml b/reference/ui/ui/control/gettoplevel.xml index 0fa6de8a4..07da35875 100644 --- a/reference/ui/ui/control/gettoplevel.xml +++ b/reference/ui/ui/control/gettoplevel.xml @@ -13,9 +13,9 @@ public intUI\Control::getTopLevel - + - + &warn.undocumented.func; @@ -28,9 +28,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/ui/ui/control/hide.xml b/reference/ui/ui/control/hide.xml index b8dd6da8c..4302e9652 100644 --- a/reference/ui/ui/control/hide.xml +++ b/reference/ui/ui/control/hide.xml @@ -13,9 +13,9 @@ public UI\Control::hide - + Shall hide this Control - + @@ -26,9 +26,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/ui/ui/control/isenabled.xml b/reference/ui/ui/control/isenabled.xml index 07a33918b..b252f73ef 100644 --- a/reference/ui/ui/control/isenabled.xml +++ b/reference/ui/ui/control/isenabled.xml @@ -13,9 +13,9 @@ public boolUI\Control::isEnabled - + Shall detect if this Control is enabled - + @@ -26,9 +26,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/ui/ui/control/isvisible.xml b/reference/ui/ui/control/isvisible.xml index 0d7d70428..631bd261f 100644 --- a/reference/ui/ui/control/isvisible.xml +++ b/reference/ui/ui/control/isvisible.xml @@ -13,9 +13,9 @@ public boolUI\Control::isVisible - + Shall detect if this Control is visible - + @@ -26,9 +26,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/ui/ui/control/setparent.xml b/reference/ui/ui/control/setparent.xml index 851a728e2..c5f898c53 100644 --- a/reference/ui/ui/control/setparent.xml +++ b/reference/ui/ui/control/setparent.xml @@ -13,9 +13,9 @@ public UI\Control::setParent UI\Controlparent - + Shall set the parent Control of this Control - + @@ -25,9 +25,9 @@ parent - + The parent Control - + @@ -35,9 +35,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/ui/ui/control/show.xml b/reference/ui/ui/control/show.xml index 8fe37f6d1..b32efdfe5 100644 --- a/reference/ui/ui/control/show.xml +++ b/reference/ui/ui/control/show.xml @@ -13,9 +13,9 @@ public UI\Control::show - + Shall show this Control - + @@ -26,9 +26,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/ui/ui/controls/box/append.xml b/reference/ui/ui/controls/box/append.xml index 0d199a8bc..23c08f10f 100644 --- a/reference/ui/ui/controls/box/append.xml +++ b/reference/ui/ui/controls/box/append.xml @@ -14,9 +14,9 @@ Controlcontrol boolstretchy&false; - + Shall append the given control to this Box - + @@ -26,17 +26,17 @@ control - + The control to append - + stretchy - + Set true to stretch the control - + @@ -44,9 +44,9 @@ &reftitle.returnvalues; - + Shall return the index of the appended control, may be 0 - + diff --git a/reference/ui/ui/controls/box/construct.xml b/reference/ui/ui/controls/box/construct.xml index 6d3b2b201..b9ccf8a9c 100644 --- a/reference/ui/ui/controls/box/construct.xml +++ b/reference/ui/ui/controls/box/construct.xml @@ -13,9 +13,9 @@ public UI\Controls\Box::__construct intorientationUI\Controls\Box::Horizontal - + Shall construct a new box - + @@ -25,9 +25,9 @@ orientation - + Box::Horizontal or Box::Vertical - + diff --git a/reference/ui/ui/controls/box/delete.xml b/reference/ui/ui/controls/box/delete.xml index 36f5c12ef..0a3e74e02 100644 --- a/reference/ui/ui/controls/box/delete.xml +++ b/reference/ui/ui/controls/box/delete.xml @@ -13,9 +13,9 @@ public boolUI\Controls\Box::delete intindex - + Shall delete the control at the given index from this Box - + @@ -25,9 +25,9 @@ index - + The index of the control to delete - + @@ -35,9 +35,9 @@ &reftitle.returnvalues; - + Indication of success - + diff --git a/reference/ui/ui/controls/box/getorientation.xml b/reference/ui/ui/controls/box/getorientation.xml index c3de918e9..002e8c5e9 100644 --- a/reference/ui/ui/controls/box/getorientation.xml +++ b/reference/ui/ui/controls/box/getorientation.xml @@ -13,9 +13,9 @@ public intUI\Controls\Box::getOrientation - + Shall retrieve the orientation of this Box - + diff --git a/reference/ui/ui/controls/box/ispadded.xml b/reference/ui/ui/controls/box/ispadded.xml index beb15d6a4..3b50bd57e 100644 --- a/reference/ui/ui/controls/box/ispadded.xml +++ b/reference/ui/ui/controls/box/ispadded.xml @@ -13,9 +13,9 @@ public boolUI\Controls\Box::isPadded - + Shall detect if padding is enabled on this Box - + diff --git a/reference/ui/ui/controls/box/setpadded.xml b/reference/ui/ui/controls/box/setpadded.xml index f20137f83..02b0cca82 100644 --- a/reference/ui/ui/controls/box/setpadded.xml +++ b/reference/ui/ui/controls/box/setpadded.xml @@ -13,9 +13,9 @@ public UI\Controls\Box::setPadded boolpadded - + Shall enable or disable padding on this Box - + @@ -25,9 +25,9 @@ padded - - - + + + diff --git a/reference/ui/ui/controls/button/construct.xml b/reference/ui/ui/controls/button/construct.xml index 36dcb48dd..99bb5bf52 100644 --- a/reference/ui/ui/controls/button/construct.xml +++ b/reference/ui/ui/controls/button/construct.xml @@ -13,9 +13,9 @@ public UI\Controls\Button::__construct stringtext - + Shall construct a new Button - + @@ -25,9 +25,9 @@ text - + The text (label) for this Button - + diff --git a/reference/ui/ui/controls/button/gettext.xml b/reference/ui/ui/controls/button/gettext.xml index fda90a4e6..fc4e787e7 100644 --- a/reference/ui/ui/controls/button/gettext.xml +++ b/reference/ui/ui/controls/button/gettext.xml @@ -13,9 +13,9 @@ public stringUI\Controls\Button::getText - + Shall retrieve the text (label) for this Button - + @@ -26,9 +26,9 @@ &reftitle.returnvalues; - + The current text (label) - + diff --git a/reference/ui/ui/controls/button/onclick.xml b/reference/ui/ui/controls/button/onclick.xml index 6fdf9ce4d..56a97ec1f 100644 --- a/reference/ui/ui/controls/button/onclick.xml +++ b/reference/ui/ui/controls/button/onclick.xml @@ -13,9 +13,9 @@ protected UI\Controls\Button::onClick - + Shall be executed when this Button is clicked - + diff --git a/reference/ui/ui/controls/button/settext.xml b/reference/ui/ui/controls/button/settext.xml index 6604cddd9..e2fad882e 100644 --- a/reference/ui/ui/controls/button/settext.xml +++ b/reference/ui/ui/controls/button/settext.xml @@ -13,9 +13,9 @@ public UI\Controls\Button::setText stringtext - + Shall set the text (label) for this Button - + @@ -25,9 +25,9 @@ text - + The new text (label) - + diff --git a/reference/ui/ui/controls/check/construct.xml b/reference/ui/ui/controls/check/construct.xml index 600c1e9ae..2a92adc32 100644 --- a/reference/ui/ui/controls/check/construct.xml +++ b/reference/ui/ui/controls/check/construct.xml @@ -13,9 +13,9 @@ public UI\Controls\Check::__construct stringtext - + Shall construct a new Check - + @@ -25,9 +25,9 @@ text - + The text (label) for the Check box - + diff --git a/reference/ui/ui/controls/check/gettext.xml b/reference/ui/ui/controls/check/gettext.xml index 4856d3daf..daae6de72 100644 --- a/reference/ui/ui/controls/check/gettext.xml +++ b/reference/ui/ui/controls/check/gettext.xml @@ -13,9 +13,9 @@ public stringUI\Controls\Check::getText - + Shall return the text (label) for this Check - + @@ -26,9 +26,9 @@ &reftitle.returnvalues; - + The current text (label) - + diff --git a/reference/ui/ui/controls/check/ischecked.xml b/reference/ui/ui/controls/check/ischecked.xml index 1c3543204..83dc18c1e 100644 --- a/reference/ui/ui/controls/check/ischecked.xml +++ b/reference/ui/ui/controls/check/ischecked.xml @@ -13,9 +13,9 @@ public boolUI\Controls\Check::isChecked - + Shall detect the status of this Check - + diff --git a/reference/ui/ui/controls/check/ontoggle.xml b/reference/ui/ui/controls/check/ontoggle.xml index aa2e59eff..fae695996 100644 --- a/reference/ui/ui/controls/check/ontoggle.xml +++ b/reference/ui/ui/controls/check/ontoggle.xml @@ -13,9 +13,9 @@ protected UI\Controls\Check::onToggle - + Shall be executed when the status of this Check is changed - + diff --git a/reference/ui/ui/controls/check/setchecked.xml b/reference/ui/ui/controls/check/setchecked.xml index 46c2400ef..e6e0b6811 100644 --- a/reference/ui/ui/controls/check/setchecked.xml +++ b/reference/ui/ui/controls/check/setchecked.xml @@ -13,9 +13,9 @@ public UI\Controls\Check::setChecked boolchecked - + Shall change the status of this Check - + @@ -25,9 +25,9 @@ checked - + The new status - + diff --git a/reference/ui/ui/controls/check/settext.xml b/reference/ui/ui/controls/check/settext.xml index de2642afe..017702f25 100644 --- a/reference/ui/ui/controls/check/settext.xml +++ b/reference/ui/ui/controls/check/settext.xml @@ -13,9 +13,9 @@ public UI\Controls\Check::setText stringtext - + Shall set the text (label) for this Check - + @@ -25,9 +25,9 @@ text - + The new text (label) - + diff --git a/reference/ui/ui/controls/colorbutton/getcolor.xml b/reference/ui/ui/controls/colorbutton/getcolor.xml index f5205749c..2a40b93b0 100644 --- a/reference/ui/ui/controls/colorbutton/getcolor.xml +++ b/reference/ui/ui/controls/colorbutton/getcolor.xml @@ -13,9 +13,9 @@ public UI\ColorUI\Controls\ColorButton::getColor - + Shall retrieve the currently selected Color - + @@ -26,9 +26,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/ui/ui/controls/colorbutton/onchange.xml b/reference/ui/ui/controls/colorbutton/onchange.xml index a9256e50a..86571c4d6 100644 --- a/reference/ui/ui/controls/colorbutton/onchange.xml +++ b/reference/ui/ui/controls/colorbutton/onchange.xml @@ -13,9 +13,9 @@ protected UI\Controls\ColorButton::onChange - + Shall be executed when the selected Color is changed - + diff --git a/reference/ui/ui/controls/colorbutton/setcolor.xml b/reference/ui/ui/controls/colorbutton/setcolor.xml index 07b2dd1fa..113bfc181 100644 --- a/reference/ui/ui/controls/colorbutton/setcolor.xml +++ b/reference/ui/ui/controls/colorbutton/setcolor.xml @@ -17,9 +17,9 @@ public UI\Controls\ColorButton::setColor intcolor - + Shall set the currently selected Color - + @@ -29,9 +29,9 @@ color - + The new color - + diff --git a/reference/ui/ui/controls/combo/append.xml b/reference/ui/ui/controls/combo/append.xml index be6012ab7..e85f1983a 100644 --- a/reference/ui/ui/controls/combo/append.xml +++ b/reference/ui/ui/controls/combo/append.xml @@ -13,9 +13,9 @@ public UI\Controls\Combo::append stringtext - + Append an option to this Combo - + @@ -25,9 +25,9 @@ text - + The text for the new option - + diff --git a/reference/ui/ui/controls/combo/getselected.xml b/reference/ui/ui/controls/combo/getselected.xml index 0feb52925..5d00ead97 100644 --- a/reference/ui/ui/controls/combo/getselected.xml +++ b/reference/ui/ui/controls/combo/getselected.xml @@ -13,9 +13,9 @@ public intUI\Controls\Combo::getSelected - + Shall retrieve the index of the option selected in this Combo - + diff --git a/reference/ui/ui/controls/combo/onselected.xml b/reference/ui/ui/controls/combo/onselected.xml index 57f7ff8d6..0ea30e8c2 100644 --- a/reference/ui/ui/controls/combo/onselected.xml +++ b/reference/ui/ui/controls/combo/onselected.xml @@ -13,9 +13,9 @@ protected UI\Controls\Combo::onSelected - + Shall be executed when an option is selected in this Combo - + diff --git a/reference/ui/ui/controls/combo/setselected.xml b/reference/ui/ui/controls/combo/setselected.xml index 1755fcbb6..852e39797 100644 --- a/reference/ui/ui/controls/combo/setselected.xml +++ b/reference/ui/ui/controls/combo/setselected.xml @@ -13,9 +13,9 @@ public UI\Controls\Combo::setSelected intindex - + Shall set the currently selected option in this Combo - + @@ -25,9 +25,9 @@ index - + The index of the option to select - + diff --git a/reference/ui/ui/controls/editablecombo/append.xml b/reference/ui/ui/controls/editablecombo/append.xml index 333b35c7d..fa8bcdf5f 100644 --- a/reference/ui/ui/controls/editablecombo/append.xml +++ b/reference/ui/ui/controls/editablecombo/append.xml @@ -13,9 +13,9 @@ public UI\Controls\EditableCombo::append stringtext - + Shall append a new option to this Editable Combo - + @@ -25,9 +25,9 @@ text - + The text for the new option - + diff --git a/reference/ui/ui/controls/editablecombo/gettext.xml b/reference/ui/ui/controls/editablecombo/gettext.xml index f9b151094..eaaadfcb3 100644 --- a/reference/ui/ui/controls/editablecombo/gettext.xml +++ b/reference/ui/ui/controls/editablecombo/gettext.xml @@ -13,9 +13,9 @@ public stringUI\Controls\EditableCombo::getText - + Get the value of the currently selected option in this Editable Combo - + diff --git a/reference/ui/ui/controls/editablecombo/onchange.xml b/reference/ui/ui/controls/editablecombo/onchange.xml index 09b9a4735..2d240a169 100644 --- a/reference/ui/ui/controls/editablecombo/onchange.xml +++ b/reference/ui/ui/controls/editablecombo/onchange.xml @@ -13,9 +13,9 @@ protected UI\Controls\EditableCombo::onChange - + Shall be executed when the value of this Editable Combobox changes - + diff --git a/reference/ui/ui/controls/editablecombo/settext.xml b/reference/ui/ui/controls/editablecombo/settext.xml index 82982d41e..95d3f41e2 100644 --- a/reference/ui/ui/controls/editablecombo/settext.xml +++ b/reference/ui/ui/controls/editablecombo/settext.xml @@ -13,9 +13,9 @@ public UI\Controls\EditableCombo::setText stringtext - + Shall set the text of the currently selected option in this Editable Combo - + @@ -25,9 +25,9 @@ text - + The new text - + diff --git a/reference/ui/ui/controls/entry/construct.xml b/reference/ui/ui/controls/entry/construct.xml index a645a77e7..2ed232d63 100644 --- a/reference/ui/ui/controls/entry/construct.xml +++ b/reference/ui/ui/controls/entry/construct.xml @@ -13,9 +13,9 @@ public UI\Controls\Entry::__construct inttypeUI\Controls\Entry::Normal - + Construct a new entry of the given type - + @@ -25,9 +25,9 @@ type - + Entry::Normal, Entry::Password, or Entry::Search - + diff --git a/reference/ui/ui/controls/entry/gettext.xml b/reference/ui/ui/controls/entry/gettext.xml index 56d0d914e..f4273c604 100644 --- a/reference/ui/ui/controls/entry/gettext.xml +++ b/reference/ui/ui/controls/entry/gettext.xml @@ -13,9 +13,9 @@ public stringUI\Controls\Entry::getText - + Shall return the current text from this Entry - + @@ -26,9 +26,9 @@ &reftitle.returnvalues; - + The current text - + diff --git a/reference/ui/ui/controls/entry/isreadonly.xml b/reference/ui/ui/controls/entry/isreadonly.xml index e6231563e..bff3c7bd3 100644 --- a/reference/ui/ui/controls/entry/isreadonly.xml +++ b/reference/ui/ui/controls/entry/isreadonly.xml @@ -13,9 +13,9 @@ public boolUI\Controls\Entry::isReadOnly - + Shall detect if this Entry is read only - + @@ -26,9 +26,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/ui/ui/controls/entry/onchange.xml b/reference/ui/ui/controls/entry/onchange.xml index 570e1eec1..d86e45d05 100644 --- a/reference/ui/ui/controls/entry/onchange.xml +++ b/reference/ui/ui/controls/entry/onchange.xml @@ -13,9 +13,9 @@ protected UI\Controls\Entry::onChange - + Shall be executed when the text in this Entry changes - + diff --git a/reference/ui/ui/controls/entry/setreadonly.xml b/reference/ui/ui/controls/entry/setreadonly.xml index a7151962f..0d4b494db 100644 --- a/reference/ui/ui/controls/entry/setreadonly.xml +++ b/reference/ui/ui/controls/entry/setreadonly.xml @@ -13,9 +13,9 @@ public UI\Controls\Entry::setReadOnly boolreadOnly - + Shall enable or disable read only for this Entry - + @@ -25,9 +25,9 @@ readOnly - - - + + + diff --git a/reference/ui/ui/controls/entry/settext.xml b/reference/ui/ui/controls/entry/settext.xml index 2c7399359..c20d51990 100644 --- a/reference/ui/ui/controls/entry/settext.xml +++ b/reference/ui/ui/controls/entry/settext.xml @@ -13,9 +13,9 @@ public UI\Controls\Entry::setText stringtext - + Shall set the text for this Entry - + @@ -25,9 +25,9 @@ text - + The new text - + diff --git a/reference/ui/ui/controls/form/append.xml b/reference/ui/ui/controls/form/append.xml index 123b37f37..541098825 100644 --- a/reference/ui/ui/controls/form/append.xml +++ b/reference/ui/ui/controls/form/append.xml @@ -15,9 +15,9 @@ UI\Controlcontrol boolstretchy&false; - + Shall append the control to the form, and set the label - + @@ -27,25 +27,25 @@ label - + The text for the label - + control - + A control - + stretchy - + Should be set true to stretch the control - + @@ -53,9 +53,9 @@ &reftitle.returnvalues; - + Shall return the index of the appended control, may be 0 - + diff --git a/reference/ui/ui/controls/form/delete.xml b/reference/ui/ui/controls/form/delete.xml index cd7a95b71..a4b3ef2af 100644 --- a/reference/ui/ui/controls/form/delete.xml +++ b/reference/ui/ui/controls/form/delete.xml @@ -13,9 +13,9 @@ public boolUI\Controls\Form::delete intindex - + Shall delete the control at the given index in this Form - + @@ -24,9 +24,9 @@ index - + The index of the control to remove - + diff --git a/reference/ui/ui/controls/form/ispadded.xml b/reference/ui/ui/controls/form/ispadded.xml index e37a922b1..beac228ea 100644 --- a/reference/ui/ui/controls/form/ispadded.xml +++ b/reference/ui/ui/controls/form/ispadded.xml @@ -13,9 +13,9 @@ public boolUI\Controls\Form::isPadded - + Shall detect if padding is enabled on this Form - + diff --git a/reference/ui/ui/controls/form/setpadded.xml b/reference/ui/ui/controls/form/setpadded.xml index e7625f6d6..c1c919efb 100644 --- a/reference/ui/ui/controls/form/setpadded.xml +++ b/reference/ui/ui/controls/form/setpadded.xml @@ -13,9 +13,9 @@ public UI\Controls\Form::setPadded boolpadded - + Shall enable or disable padding on this Form - + @@ -25,9 +25,9 @@ padded - - - + + + diff --git a/reference/ui/ui/controls/grid/append.xml b/reference/ui/ui/controls/grid/append.xml index d99c64137..909224abe 100644 --- a/reference/ui/ui/controls/grid/append.xml +++ b/reference/ui/ui/controls/grid/append.xml @@ -21,9 +21,9 @@ boolvexpand intvalign - + - + &warn.undocumented.func; @@ -35,73 +35,73 @@ control - + The Control to append - + left - - - + + + top - - - + + + xspan - - - + + + yspan - - - + + + hexpand - - - + + + halign - - - + + + vexpand - - - + + + valign - - - + + + @@ -109,9 +109,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/ui/ui/controls/grid/ispadded.xml b/reference/ui/ui/controls/grid/ispadded.xml index 0b2a86486..3a261332a 100644 --- a/reference/ui/ui/controls/grid/ispadded.xml +++ b/reference/ui/ui/controls/grid/ispadded.xml @@ -13,9 +13,9 @@ public boolUI\Controls\Grid::isPadded - + Shall detect if padding is enabled on this Grid - + diff --git a/reference/ui/ui/controls/grid/setpadded.xml b/reference/ui/ui/controls/grid/setpadded.xml index 0cb609e54..f3d98c773 100644 --- a/reference/ui/ui/controls/grid/setpadded.xml +++ b/reference/ui/ui/controls/grid/setpadded.xml @@ -13,9 +13,9 @@ public UI\Controls\Grid::setPadded boolpadding - + Shall enable or disable padding for this Grid - + @@ -25,9 +25,9 @@ padding - - - + + + diff --git a/reference/ui/ui/controls/group/append.xml b/reference/ui/ui/controls/group/append.xml index 3ca0a77ec..cdd1e894a 100644 --- a/reference/ui/ui/controls/group/append.xml +++ b/reference/ui/ui/controls/group/append.xml @@ -13,9 +13,9 @@ public UI\Controls\Group::append UI\Controlcontrol - + Shall append a control to this Group - + @@ -25,9 +25,9 @@ control - + The control to append - + diff --git a/reference/ui/ui/controls/group/construct.xml b/reference/ui/ui/controls/group/construct.xml index 5137f3430..1e9c9bd2c 100644 --- a/reference/ui/ui/controls/group/construct.xml +++ b/reference/ui/ui/controls/group/construct.xml @@ -13,9 +13,9 @@ public UI\Controls\Group::__construct stringtitle - + Shall construct a new Group with the given title - + @@ -25,9 +25,9 @@ title - + The text for the title label - + diff --git a/reference/ui/ui/controls/group/gettitle.xml b/reference/ui/ui/controls/group/gettitle.xml index 10e8026b5..039c7cb78 100644 --- a/reference/ui/ui/controls/group/gettitle.xml +++ b/reference/ui/ui/controls/group/gettitle.xml @@ -13,9 +13,9 @@ public stringUI\Controls\Group::getTitle - + Shall return the current title for this Group - + @@ -26,9 +26,9 @@ &reftitle.returnvalues; - + The current title - + diff --git a/reference/ui/ui/controls/group/hasmargin.xml b/reference/ui/ui/controls/group/hasmargin.xml index 34d4f30c9..f167e4985 100644 --- a/reference/ui/ui/controls/group/hasmargin.xml +++ b/reference/ui/ui/controls/group/hasmargin.xml @@ -13,9 +13,9 @@ public boolUI\Controls\Group::hasMargin - + Shall detect if this Group has a margin - + diff --git a/reference/ui/ui/controls/group/setmargin.xml b/reference/ui/ui/controls/group/setmargin.xml index 021d40276..1065ea1ba 100644 --- a/reference/ui/ui/controls/group/setmargin.xml +++ b/reference/ui/ui/controls/group/setmargin.xml @@ -13,9 +13,9 @@ public UI\Controls\Group::setMargin boolmargin - + Shall enable or disable margins for this Group - + @@ -25,9 +25,9 @@ margin - - - + + + diff --git a/reference/ui/ui/controls/group/settitle.xml b/reference/ui/ui/controls/group/settitle.xml index a5b4f1c7f..228a25cc6 100644 --- a/reference/ui/ui/controls/group/settitle.xml +++ b/reference/ui/ui/controls/group/settitle.xml @@ -13,9 +13,9 @@ public UI\Controls\Group::setTitle stringtitle - + Shall set the title for this Group - + @@ -25,9 +25,9 @@ title - + The text for the new title - + diff --git a/reference/ui/ui/controls/label/construct.xml b/reference/ui/ui/controls/label/construct.xml index 05544f24a..69d294099 100644 --- a/reference/ui/ui/controls/label/construct.xml +++ b/reference/ui/ui/controls/label/construct.xml @@ -13,9 +13,9 @@ public UI\Controls\Label::__construct stringtext - + Shall construct a new Label - + @@ -25,9 +25,9 @@ text - + The text for this label - + diff --git a/reference/ui/ui/controls/label/gettext.xml b/reference/ui/ui/controls/label/gettext.xml index e7e2fd519..90149cf2f 100644 --- a/reference/ui/ui/controls/label/gettext.xml +++ b/reference/ui/ui/controls/label/gettext.xml @@ -13,9 +13,9 @@ public stringUI\Controls\Label::getText - + Shall return the current text for this Label - + &warn.undocumented.func; @@ -28,9 +28,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/ui/ui/controls/label/settext.xml b/reference/ui/ui/controls/label/settext.xml index bf9391cff..ef2d0af93 100644 --- a/reference/ui/ui/controls/label/settext.xml +++ b/reference/ui/ui/controls/label/settext.xml @@ -13,9 +13,9 @@ public UI\Controls\Label::setText stringtext - + Shall set the text for this Label - + @@ -25,9 +25,9 @@ text - + The new text - + diff --git a/reference/ui/ui/controls/multilineentry/append.xml b/reference/ui/ui/controls/multilineentry/append.xml index 3971e7039..7daaa24ed 100644 --- a/reference/ui/ui/controls/multilineentry/append.xml +++ b/reference/ui/ui/controls/multilineentry/append.xml @@ -13,9 +13,9 @@ public UI\Controls\MultilineEntry::append stringtext - + Shall append the given text to the text in this Multiline Entry - + @@ -25,9 +25,9 @@ text - + The text to append - + diff --git a/reference/ui/ui/controls/multilineentry/construct.xml b/reference/ui/ui/controls/multilineentry/construct.xml index 17ec057cd..1557baa69 100644 --- a/reference/ui/ui/controls/multilineentry/construct.xml +++ b/reference/ui/ui/controls/multilineentry/construct.xml @@ -13,9 +13,9 @@ public UI\Controls\MultilineEntry::__construct inttype - + Shall construct a new Multiline Entry of the given type - + @@ -25,9 +25,9 @@ type - + MultilineEntry::Wrap or MultilineEntry::NoWrap - + diff --git a/reference/ui/ui/controls/multilineentry/gettext.xml b/reference/ui/ui/controls/multilineentry/gettext.xml index 9e2d48fd3..cf429954f 100644 --- a/reference/ui/ui/controls/multilineentry/gettext.xml +++ b/reference/ui/ui/controls/multilineentry/gettext.xml @@ -13,9 +13,9 @@ public stringUI\Controls\MultilineEntry::getText - + Shall return the text in this Multiline Entry - + diff --git a/reference/ui/ui/controls/multilineentry/isreadonly.xml b/reference/ui/ui/controls/multilineentry/isreadonly.xml index 413e3efc1..f8a590b50 100644 --- a/reference/ui/ui/controls/multilineentry/isreadonly.xml +++ b/reference/ui/ui/controls/multilineentry/isreadonly.xml @@ -13,9 +13,9 @@ public boolUI\Controls\MultilineEntry::isReadOnly - + Shall detect if this Multiline Entry is read only - + diff --git a/reference/ui/ui/controls/multilineentry/onchange.xml b/reference/ui/ui/controls/multilineentry/onchange.xml index 2c9f18bbe..4e283abcb 100644 --- a/reference/ui/ui/controls/multilineentry/onchange.xml +++ b/reference/ui/ui/controls/multilineentry/onchange.xml @@ -13,9 +13,9 @@ protected UI\Controls\MultilineEntry::onChange - + Shall be executed when the text in this Multiline Entry is changed - + diff --git a/reference/ui/ui/controls/multilineentry/setreadonly.xml b/reference/ui/ui/controls/multilineentry/setreadonly.xml index 107be4010..6b3d73241 100644 --- a/reference/ui/ui/controls/multilineentry/setreadonly.xml +++ b/reference/ui/ui/controls/multilineentry/setreadonly.xml @@ -13,9 +13,9 @@ public UI\Controls\MultilineEntry::setReadOnly boolreadOnly - + Shall enable or disable read only on this Multiline Entry - + @@ -25,9 +25,9 @@ readOnly - - - + + + diff --git a/reference/ui/ui/controls/multilineentry/settext.xml b/reference/ui/ui/controls/multilineentry/settext.xml index 367b3a00c..9b67f98c7 100644 --- a/reference/ui/ui/controls/multilineentry/settext.xml +++ b/reference/ui/ui/controls/multilineentry/settext.xml @@ -13,9 +13,9 @@ public UI\Controls\MultilineEntry::setText stringtext - + Shall set the text in this Multiline Entry - + @@ -25,9 +25,9 @@ text - + The new text - + diff --git a/reference/ui/ui/controls/picker/construct.xml b/reference/ui/ui/controls/picker/construct.xml index 68ee370cd..15309d320 100644 --- a/reference/ui/ui/controls/picker/construct.xml +++ b/reference/ui/ui/controls/picker/construct.xml @@ -13,9 +13,9 @@ public UI\Controls\Picker::__construct inttypeUI\Controls\Picker::Date - + Construct a new Picker of the given type - + @@ -25,9 +25,9 @@ type - + Picker::Date, Picker::Time, or Picker::DateTime - + diff --git a/reference/ui/ui/controls/progress/getvalue.xml b/reference/ui/ui/controls/progress/getvalue.xml index 286f05001..f147cd35b 100644 --- a/reference/ui/ui/controls/progress/getvalue.xml +++ b/reference/ui/ui/controls/progress/getvalue.xml @@ -13,9 +13,9 @@ public intUI\Controls\Progress::getValue - + Shall retrieve the current value of this Progress bar - + diff --git a/reference/ui/ui/controls/progress/setvalue.xml b/reference/ui/ui/controls/progress/setvalue.xml index ce736ee82..fabd07109 100644 --- a/reference/ui/ui/controls/progress/setvalue.xml +++ b/reference/ui/ui/controls/progress/setvalue.xml @@ -13,9 +13,9 @@ public UI\Controls\Progress::setValue intvalue - + Shall set the value for this Progress bar - + @@ -25,9 +25,9 @@ value - + An integer between 0 and 100 (inclusive) - + diff --git a/reference/ui/ui/controls/radio/append.xml b/reference/ui/ui/controls/radio/append.xml index 1ebfd2e02..4c70966df 100644 --- a/reference/ui/ui/controls/radio/append.xml +++ b/reference/ui/ui/controls/radio/append.xml @@ -13,9 +13,9 @@ public UI\Controls\Radio::append stringtext - + Shall append a new option to this Radio - + @@ -25,9 +25,9 @@ text - + The text (label) for the option - + diff --git a/reference/ui/ui/controls/radio/getselected.xml b/reference/ui/ui/controls/radio/getselected.xml index 104fdca63..452b774bb 100644 --- a/reference/ui/ui/controls/radio/getselected.xml +++ b/reference/ui/ui/controls/radio/getselected.xml @@ -13,9 +13,9 @@ public intUI\Controls\Radio::getSelected - + Shall retrieve the index of the currently selected option in this Radio - + diff --git a/reference/ui/ui/controls/radio/onselected.xml b/reference/ui/ui/controls/radio/onselected.xml index 63494f126..db24f35f1 100644 --- a/reference/ui/ui/controls/radio/onselected.xml +++ b/reference/ui/ui/controls/radio/onselected.xml @@ -13,9 +13,9 @@ protected UI\Controls\Radio::onSelected - + Shall be executed when the option selected in this Radio changes - + diff --git a/reference/ui/ui/controls/radio/setselected.xml b/reference/ui/ui/controls/radio/setselected.xml index 01fd2379d..70ce179c9 100644 --- a/reference/ui/ui/controls/radio/setselected.xml +++ b/reference/ui/ui/controls/radio/setselected.xml @@ -13,9 +13,9 @@ public UI\Controls\Radio::setSelected intindex - + Shall set the currently selected option in this Radio - + @@ -25,9 +25,9 @@ index - + The index of the option to select - + diff --git a/reference/ui/ui/controls/separator/construct.xml b/reference/ui/ui/controls/separator/construct.xml index 7285028a2..ec5bee3e6 100644 --- a/reference/ui/ui/controls/separator/construct.xml +++ b/reference/ui/ui/controls/separator/construct.xml @@ -13,9 +13,9 @@ public UI\Controls\Separator::__construct inttypeUI\Controls\Separator::Horizontal - + Shall construct a new Separator of the given type - + diff --git a/reference/ui/ui/controls/slider/construct.xml b/reference/ui/ui/controls/slider/construct.xml index f23dccda9..144f47174 100644 --- a/reference/ui/ui/controls/slider/construct.xml +++ b/reference/ui/ui/controls/slider/construct.xml @@ -14,9 +14,9 @@ intmin intmax - + Construct a new Slider with the given range - + @@ -26,17 +26,17 @@ min - + The minimum allowed value - + max - + The maximum allowed value - + diff --git a/reference/ui/ui/controls/slider/getvalue.xml b/reference/ui/ui/controls/slider/getvalue.xml index 1c5acdab2..86dc9ca8e 100644 --- a/reference/ui/ui/controls/slider/getvalue.xml +++ b/reference/ui/ui/controls/slider/getvalue.xml @@ -13,9 +13,9 @@ public intUI\Controls\Slider::getValue - + Get the value from this Slider - + diff --git a/reference/ui/ui/controls/slider/onchange.xml b/reference/ui/ui/controls/slider/onchange.xml index 8de3d2771..72d8a54f9 100644 --- a/reference/ui/ui/controls/slider/onchange.xml +++ b/reference/ui/ui/controls/slider/onchange.xml @@ -13,9 +13,9 @@ protected UI\Controls\Slider::onChange - + Shall be executed when the value of this Slider changes - + diff --git a/reference/ui/ui/controls/slider/setvalue.xml b/reference/ui/ui/controls/slider/setvalue.xml index 9aeeec9b0..f064e98be 100644 --- a/reference/ui/ui/controls/slider/setvalue.xml +++ b/reference/ui/ui/controls/slider/setvalue.xml @@ -13,9 +13,9 @@ public UI\Controls\Slider::setValue intvalue - + Shall set the value for this Slider - + @@ -25,9 +25,9 @@ value - + The new value - + diff --git a/reference/ui/ui/controls/spin/construct.xml b/reference/ui/ui/controls/spin/construct.xml index 9c45077ec..35d32ac5f 100644 --- a/reference/ui/ui/controls/spin/construct.xml +++ b/reference/ui/ui/controls/spin/construct.xml @@ -14,9 +14,9 @@ intmin intmax - + Constructs a new Spin with the given range - + @@ -26,17 +26,17 @@ min - + The minimum value allowed - + max - + The maximum value allowed - + diff --git a/reference/ui/ui/controls/spin/getvalue.xml b/reference/ui/ui/controls/spin/getvalue.xml index 929954d22..e447d67c6 100644 --- a/reference/ui/ui/controls/spin/getvalue.xml +++ b/reference/ui/ui/controls/spin/getvalue.xml @@ -13,9 +13,9 @@ public intUI\Controls\Spin::getValue - + Get the value in this Spin - + diff --git a/reference/ui/ui/controls/spin/onchange.xml b/reference/ui/ui/controls/spin/onchange.xml index 7a788ec36..63a1224b1 100644 --- a/reference/ui/ui/controls/spin/onchange.xml +++ b/reference/ui/ui/controls/spin/onchange.xml @@ -13,9 +13,9 @@ protected UI\Controls\Spin::onChange - + Shall be executed when the value in this Spin changes - + diff --git a/reference/ui/ui/controls/spin/setvalue.xml b/reference/ui/ui/controls/spin/setvalue.xml index 324a6f236..f0c5c974d 100644 --- a/reference/ui/ui/controls/spin/setvalue.xml +++ b/reference/ui/ui/controls/spin/setvalue.xml @@ -13,9 +13,9 @@ public UI\Controls\Spin::setValue intvalue - + Set the value in this Spin - + @@ -25,9 +25,9 @@ value - + The new value - + diff --git a/reference/ui/ui/controls/tab/append.xml b/reference/ui/ui/controls/tab/append.xml index 28d2fc9c6..86e9a856a 100644 --- a/reference/ui/ui/controls/tab/append.xml +++ b/reference/ui/ui/controls/tab/append.xml @@ -14,9 +14,9 @@ stringname UI\Controlcontrol - + Append a new page to this Tab - + @@ -26,17 +26,17 @@ name - + The name for the new page - + control - + The control for the new page - + @@ -44,9 +44,9 @@ &reftitle.returnvalues; - + Shall return the index of the appended control, may be 0 - + diff --git a/reference/ui/ui/controls/tab/delete.xml b/reference/ui/ui/controls/tab/delete.xml index e9c4d2830..053bf91d3 100644 --- a/reference/ui/ui/controls/tab/delete.xml +++ b/reference/ui/ui/controls/tab/delete.xml @@ -13,9 +13,9 @@ public boolUI\Controls\Tab::delete intindex - + Shall remove the selected page from this Tab - + @@ -25,9 +25,9 @@ index - + The index of the page to remove - + @@ -35,9 +35,9 @@ &reftitle.returnvalues; - + Indication of success - + diff --git a/reference/ui/ui/controls/tab/hasmargin.xml b/reference/ui/ui/controls/tab/hasmargin.xml index 658ff37a7..0f80f4a83 100644 --- a/reference/ui/ui/controls/tab/hasmargin.xml +++ b/reference/ui/ui/controls/tab/hasmargin.xml @@ -13,9 +13,9 @@ public boolUI\Controls\Tab::hasMargin intpage - + Shall detect if the given page has a margin. - + @@ -24,9 +24,9 @@ page - + The index of the page - + @@ -34,9 +34,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/ui/ui/controls/tab/insertat.xml b/reference/ui/ui/controls/tab/insertat.xml index 387b8fe45..f917963d0 100644 --- a/reference/ui/ui/controls/tab/insertat.xml +++ b/reference/ui/ui/controls/tab/insertat.xml @@ -15,9 +15,9 @@ intpage UI\Controlcontrol - + Shall insert a new page into this Tab - + @@ -27,25 +27,25 @@ name - + The name for the new page - + page - + The index to perform the insertion before - + control - + The control for the new page - + diff --git a/reference/ui/ui/controls/tab/pages.xml b/reference/ui/ui/controls/tab/pages.xml index 20d8760f5..2d8a03fd8 100644 --- a/reference/ui/ui/controls/tab/pages.xml +++ b/reference/ui/ui/controls/tab/pages.xml @@ -13,9 +13,9 @@ public intUI\Controls\Tab::pages - + Shall return the number of pages in this Tab - + @@ -26,9 +26,9 @@ &reftitle.returnvalues; - + The number of pages in this Tab - + diff --git a/reference/ui/ui/controls/tab/setmargin.xml b/reference/ui/ui/controls/tab/setmargin.xml index 4143018a9..380baf70f 100644 --- a/reference/ui/ui/controls/tab/setmargin.xml +++ b/reference/ui/ui/controls/tab/setmargin.xml @@ -14,9 +14,9 @@ intpage boolmargin - + Shall enable or disable margins on the selected page - + @@ -26,17 +26,17 @@ page - + The page to select - + margin - + Margin switch - + diff --git a/reference/ui/ui/draw/brush.gradient/addstop.xml b/reference/ui/ui/draw/brush.gradient/addstop.xml index ac77d0387..255d43114 100644 --- a/reference/ui/ui/draw/brush.gradient/addstop.xml +++ b/reference/ui/ui/draw/brush.gradient/addstop.xml @@ -31,17 +31,17 @@ position - + The position for the new stop - + color - + The color for the new stop, may be UI\Draw\Color or RRGGBBAA - + @@ -49,9 +49,9 @@ &reftitle.returnvalues; - + Total number of stops - + diff --git a/reference/ui/ui/draw/brush.gradient/delstop.xml b/reference/ui/ui/draw/brush.gradient/delstop.xml index 7a40a0a32..7d8dddf14 100644 --- a/reference/ui/ui/draw/brush.gradient/delstop.xml +++ b/reference/ui/ui/draw/brush.gradient/delstop.xml @@ -13,9 +13,9 @@ public intUI\Draw\Brush\Gradient::delStop intindex - + - + &warn.undocumented.func; @@ -27,9 +27,9 @@ index - - - + + + @@ -37,9 +37,9 @@ &reftitle.returnvalues; - + Total number of stops - + diff --git a/reference/ui/ui/draw/brush.gradient/setstop.xml b/reference/ui/ui/draw/brush.gradient/setstop.xml index f0944eebd..41201fba9 100644 --- a/reference/ui/ui/draw/brush.gradient/setstop.xml +++ b/reference/ui/ui/draw/brush.gradient/setstop.xml @@ -21,9 +21,9 @@ floatposition intcolor - + - + @@ -33,25 +33,25 @@ index - + The index of the stop to set - + position - + The position for the stop - + color - + The color for the stop, may be UI\Draw\Color or RRGGBBAA - + @@ -59,9 +59,9 @@ &reftitle.returnvalues; - + Indication of success - + diff --git a/reference/ui/ui/draw/brush.lineargradient/construct.xml b/reference/ui/ui/draw/brush.lineargradient/construct.xml index 20ffabefc..4ff392c65 100644 --- a/reference/ui/ui/draw/brush.lineargradient/construct.xml +++ b/reference/ui/ui/draw/brush.lineargradient/construct.xml @@ -14,9 +14,9 @@ UI\Pointstart UI\Pointend - + Shall construct a new linear gradient - + @@ -26,17 +26,17 @@ start - - - + + + end - - - + + + @@ -48,7 +48,7 @@ &reftitle.returnvalues; - + --> diff --git a/reference/ui/ui/draw/brush.radialgradient/construct.xml b/reference/ui/ui/draw/brush.radialgradient/construct.xml index 6269dc128..30e99c3a8 100644 --- a/reference/ui/ui/draw/brush.radialgradient/construct.xml +++ b/reference/ui/ui/draw/brush.radialgradient/construct.xml @@ -15,9 +15,9 @@ UI\Pointouter floatradius - + Shall construct a new radial gradient - + @@ -27,25 +27,25 @@ start - - - + + + outer - - - + + + radius - - - + + + @@ -57,7 +57,7 @@ &reftitle.returnvalues; - + --> diff --git a/reference/ui/ui/draw/brush/construct.xml b/reference/ui/ui/draw/brush/construct.xml index e73d31713..73f202de4 100644 --- a/reference/ui/ui/draw/brush/construct.xml +++ b/reference/ui/ui/draw/brush/construct.xml @@ -17,9 +17,9 @@ public UI\Draw\Brush::__construct intcolor - + Shall construct a solid brush using the given color - + @@ -29,9 +29,9 @@ color - + Can be a UI\Draw\Color or RRGGBBAA - + diff --git a/reference/ui/ui/draw/brush/getcolor.xml b/reference/ui/ui/draw/brush/getcolor.xml index e9c47cee5..9795bca62 100644 --- a/reference/ui/ui/draw/brush/getcolor.xml +++ b/reference/ui/ui/draw/brush/getcolor.xml @@ -13,9 +13,9 @@ public UI\Draw\ColorUI\Draw\Brush::getColor - + Shall return a UI\Draw\Color for this brush - + @@ -26,9 +26,9 @@ &reftitle.returnvalues; - + The current color of the brush - + diff --git a/reference/ui/ui/draw/brush/setcolor.xml b/reference/ui/ui/draw/brush/setcolor.xml index 7bb1dc66c..b1f562d18 100644 --- a/reference/ui/ui/draw/brush/setcolor.xml +++ b/reference/ui/ui/draw/brush/setcolor.xml @@ -17,9 +17,9 @@ public voidUI\Draw\Brush::setColor intcolor - + Shall set the color of this brush to the color provided - + @@ -29,9 +29,9 @@ color - + Can be a UI\Draw\Color or RRGGBBAA - + @@ -39,9 +39,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/ui/ui/draw/color/construct.xml b/reference/ui/ui/draw/color/construct.xml index 5c24d4224..31b6365fd 100644 --- a/reference/ui/ui/draw/color/construct.xml +++ b/reference/ui/ui/draw/color/construct.xml @@ -17,9 +17,9 @@ public UI\Draw\Color::__construct intcolor - + Shall construct a new color - + @@ -29,9 +29,9 @@ color - + May be UI\Draw\Color or RRGGBBAA - + @@ -43,7 +43,7 @@ &reftitle.returnvalues; - + --> diff --git a/reference/ui/ui/draw/color/getchannel.xml b/reference/ui/ui/draw/color/getchannel.xml index 12d55ce9b..d11a844e8 100644 --- a/reference/ui/ui/draw/color/getchannel.xml +++ b/reference/ui/ui/draw/color/getchannel.xml @@ -13,9 +13,9 @@ public floatUI\Draw\Color::getChannel intchannel - + Shall retrieve the value for a channel - + @@ -25,9 +25,9 @@ channel - + Constant channel identity - + @@ -35,9 +35,9 @@ &reftitle.returnvalues; - + The current value of the requested channel - + diff --git a/reference/ui/ui/draw/color/setchannel.xml b/reference/ui/ui/draw/color/setchannel.xml index 2e11e9ef5..1bce503c4 100644 --- a/reference/ui/ui/draw/color/setchannel.xml +++ b/reference/ui/ui/draw/color/setchannel.xml @@ -14,9 +14,9 @@ intchannel floatvalue - + Shall set the selected channel to the given value - + @@ -26,17 +26,17 @@ channel - + Constant channel identity - + value - + The new value for the selected channel - + @@ -44,9 +44,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/ui/ui/draw/matrix/invert.xml b/reference/ui/ui/draw/matrix/invert.xml index ff8fe35c8..e675c9e22 100644 --- a/reference/ui/ui/draw/matrix/invert.xml +++ b/reference/ui/ui/draw/matrix/invert.xml @@ -13,9 +13,9 @@ public UI\Draw\Matrix::invert - + Shall invert this matrix - + diff --git a/reference/ui/ui/draw/matrix/isinvertible.xml b/reference/ui/ui/draw/matrix/isinvertible.xml index a8db70be8..2c00fb6fb 100644 --- a/reference/ui/ui/draw/matrix/isinvertible.xml +++ b/reference/ui/ui/draw/matrix/isinvertible.xml @@ -13,9 +13,9 @@ public boolUI\Draw\Matrix::isInvertible - + Shall detect if this Matrix may be inverted - + diff --git a/reference/ui/ui/draw/matrix/multiply.xml b/reference/ui/ui/draw/matrix/multiply.xml index a7edc58ed..baf521c04 100644 --- a/reference/ui/ui/draw/matrix/multiply.xml +++ b/reference/ui/ui/draw/matrix/multiply.xml @@ -13,9 +13,9 @@ public UI\Draw\MatrixUI\Draw\Matrix::multiply UI\Draw\Matrixmatrix - + Shall multiply this matrix with the given matrix - + @@ -26,9 +26,9 @@ &reftitle.returnvalues; - + The new Matrix - + diff --git a/reference/ui/ui/draw/matrix/rotate.xml b/reference/ui/ui/draw/matrix/rotate.xml index b0c1f13cd..a3c362e8e 100644 --- a/reference/ui/ui/draw/matrix/rotate.xml +++ b/reference/ui/ui/draw/matrix/rotate.xml @@ -14,9 +14,9 @@ UI\Pointpoint floatamount - + Shall rotate this Matrix - + @@ -26,17 +26,17 @@ point - - - + + + amount - - - + + + diff --git a/reference/ui/ui/draw/matrix/scale.xml b/reference/ui/ui/draw/matrix/scale.xml index 68471373f..b6a909db8 100644 --- a/reference/ui/ui/draw/matrix/scale.xml +++ b/reference/ui/ui/draw/matrix/scale.xml @@ -14,9 +14,9 @@ UI\Pointcenter UI\Pointpoint - + Shall scale this Matrix - + @@ -26,17 +26,17 @@ center - - - + + + point - - - + + + diff --git a/reference/ui/ui/draw/matrix/skew.xml b/reference/ui/ui/draw/matrix/skew.xml index 9897d8234..fe9abe8ad 100644 --- a/reference/ui/ui/draw/matrix/skew.xml +++ b/reference/ui/ui/draw/matrix/skew.xml @@ -14,9 +14,9 @@ UI\Pointpoint UI\Pointamount - + Shall skew this Matrix - + @@ -26,17 +26,17 @@ point - - - + + + amount - - - + + + diff --git a/reference/ui/ui/draw/matrix/translate.xml b/reference/ui/ui/draw/matrix/translate.xml index ffd9cd1ae..7118224f0 100644 --- a/reference/ui/ui/draw/matrix/translate.xml +++ b/reference/ui/ui/draw/matrix/translate.xml @@ -13,9 +13,9 @@ public UI\Draw\Matrix::translate UI\Pointpoint - + Shall translate this Matrix - + @@ -25,9 +25,9 @@ point - - - + + + diff --git a/reference/ui/ui/draw/path/addrectangle.xml b/reference/ui/ui/draw/path/addrectangle.xml index 721818a39..aec648b31 100644 --- a/reference/ui/ui/draw/path/addrectangle.xml +++ b/reference/ui/ui/draw/path/addrectangle.xml @@ -14,9 +14,9 @@ UI\Pointpoint UI\Sizesize - + Shall map the path of a rectangle of the given size, at the given point - + @@ -26,17 +26,17 @@ point - + The point to begin the shape - + size - + The size of the rectangle - + diff --git a/reference/ui/ui/draw/path/arcto.xml b/reference/ui/ui/draw/path/arcto.xml index c427a883c..516345a18 100644 --- a/reference/ui/ui/draw/path/arcto.xml +++ b/reference/ui/ui/draw/path/arcto.xml @@ -17,9 +17,9 @@ floatsweep floatnegative - + Shall map the path for an arc - + @@ -29,41 +29,41 @@ point - + The point to begin mapping - + radius - + The radius of the arc - + angle - + The angle of the arc - + sweep - + The sweep of the arc - + negative - - - + + + @@ -71,9 +71,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/ui/ui/draw/path/bezierto.xml b/reference/ui/ui/draw/path/bezierto.xml index c06a23f2a..2a85e1875 100644 --- a/reference/ui/ui/draw/path/bezierto.xml +++ b/reference/ui/ui/draw/path/bezierto.xml @@ -17,9 +17,9 @@ floatsweep floatnegative - + Shall draw a bezier curve - + @@ -29,41 +29,41 @@ point - + The point at which to begin mapping - + radius - + The radius of the curve - + angle - + The angle of the curve - + sweep - + The sweep of the curve - + negative - - - + + + diff --git a/reference/ui/ui/draw/path/closefigure.xml b/reference/ui/ui/draw/path/closefigure.xml index 3342696f2..05d87000f 100644 --- a/reference/ui/ui/draw/path/closefigure.xml +++ b/reference/ui/ui/draw/path/closefigure.xml @@ -13,9 +13,9 @@ public UI\Draw\Path::closeFigure - + Shall close the current figure - + diff --git a/reference/ui/ui/draw/path/construct.xml b/reference/ui/ui/draw/path/construct.xml index bc5318bbb..faa27659f 100644 --- a/reference/ui/ui/draw/path/construct.xml +++ b/reference/ui/ui/draw/path/construct.xml @@ -13,9 +13,9 @@ public UI\Draw\Path::__construct intmodeUI\Draw\Path::Winding - + Shall construct a new path in the given mode - + @@ -25,9 +25,9 @@ mode - + Path::Winding or Path::Alternate - + diff --git a/reference/ui/ui/draw/path/end.xml b/reference/ui/ui/draw/path/end.xml index 5f9ea233d..dd386c0d8 100644 --- a/reference/ui/ui/draw/path/end.xml +++ b/reference/ui/ui/draw/path/end.xml @@ -13,9 +13,9 @@ public UI\Draw\Path::end - + Shall finalize this Path - + diff --git a/reference/ui/ui/draw/path/lineto.xml b/reference/ui/ui/draw/path/lineto.xml index 4eb6bd300..2489c2ad2 100644 --- a/reference/ui/ui/draw/path/lineto.xml +++ b/reference/ui/ui/draw/path/lineto.xml @@ -17,9 +17,9 @@ floatsweep floatnegative - + Shall map the path for a line - + @@ -29,41 +29,41 @@ point - + The point to begin mapping - + radius - - - + + + angle - - - + + + sweep - - - + + + negative - - - + + + @@ -71,9 +71,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/ui/ui/draw/path/newfigure.xml b/reference/ui/ui/draw/path/newfigure.xml index 57cb3b47e..d55bc2ec1 100644 --- a/reference/ui/ui/draw/path/newfigure.xml +++ b/reference/ui/ui/draw/path/newfigure.xml @@ -13,9 +13,9 @@ public UI\Draw\Path::newFigure UI\Pointpoint - + Shall map a new figure at the given point - + @@ -25,9 +25,9 @@ point - + The point to begin mapping - + diff --git a/reference/ui/ui/draw/path/newfigurewitharc.xml b/reference/ui/ui/draw/path/newfigurewitharc.xml index d62cb219e..9fa3b3072 100644 --- a/reference/ui/ui/draw/path/newfigurewitharc.xml +++ b/reference/ui/ui/draw/path/newfigurewitharc.xml @@ -17,9 +17,9 @@ floatsweep floatnegative - - - + + + @@ -29,41 +29,41 @@ point - - - + + + radius - - - + + + angle - - - + + + sweep - - - + + + negative - - - + + + @@ -71,9 +71,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/ui/ui/draw/pen/clip.xml b/reference/ui/ui/draw/pen/clip.xml index 6bbe11506..3eb5e7711 100644 --- a/reference/ui/ui/draw/pen/clip.xml +++ b/reference/ui/ui/draw/pen/clip.xml @@ -13,9 +13,9 @@ public UI\Draw\Pen::clip UI\Draw\Pathpath - + Shall clip the given Path - + @@ -25,9 +25,9 @@ path - + The path to clip - + diff --git a/reference/ui/ui/draw/pen/fill.xml b/reference/ui/ui/draw/pen/fill.xml index 4cb78daa8..762f2860d 100644 --- a/reference/ui/ui/draw/pen/fill.xml +++ b/reference/ui/ui/draw/pen/fill.xml @@ -24,9 +24,9 @@ UI\Draw\Pathpath intwith - + Shall fill the given path - + @@ -36,17 +36,17 @@ path - + The path to fill - + with - + The color or brush to fill with - + diff --git a/reference/ui/ui/draw/pen/restore.xml b/reference/ui/ui/draw/pen/restore.xml index ef8f80bf3..3818efb47 100644 --- a/reference/ui/ui/draw/pen/restore.xml +++ b/reference/ui/ui/draw/pen/restore.xml @@ -13,9 +13,9 @@ public UI\Draw\Pen::restore - + Shall restore a previously saved Pen - + diff --git a/reference/ui/ui/draw/pen/save.xml b/reference/ui/ui/draw/pen/save.xml index 7f854f860..0179a20fb 100644 --- a/reference/ui/ui/draw/pen/save.xml +++ b/reference/ui/ui/draw/pen/save.xml @@ -13,9 +13,9 @@ public UI\Draw\Pen::save - + Shall save the Pen - + diff --git a/reference/ui/ui/draw/pen/stroke.xml b/reference/ui/ui/draw/pen/stroke.xml index 1bc47e966..e30f8d877 100644 --- a/reference/ui/ui/draw/pen/stroke.xml +++ b/reference/ui/ui/draw/pen/stroke.xml @@ -27,9 +27,9 @@ intwith UI\Draw\Strokestroke - + Shall stroke the given path - + @@ -39,25 +39,25 @@ path - + The path to stroke - + with - + The color or brush to stroke with - + stroke - + The configuration of the stroke - + diff --git a/reference/ui/ui/draw/pen/transform.xml b/reference/ui/ui/draw/pen/transform.xml index e421240c6..53187bd0b 100644 --- a/reference/ui/ui/draw/pen/transform.xml +++ b/reference/ui/ui/draw/pen/transform.xml @@ -13,9 +13,9 @@ public UI\Draw\Pen::transform UI\Draw\Matrixmatrix - + Shall perform matrix transformation - + @@ -25,9 +25,9 @@ matrix - + The matrix to use - + diff --git a/reference/ui/ui/draw/pen/write.xml b/reference/ui/ui/draw/pen/write.xml index 4d0d67c80..7a734f586 100644 --- a/reference/ui/ui/draw/pen/write.xml +++ b/reference/ui/ui/draw/pen/write.xml @@ -14,9 +14,9 @@ UI\Pointpoint UI\Draw\Text\Layoutlayout - + Shall draw the given text layout at the given point - + @@ -26,17 +26,17 @@ point - + The point to perform the drawing - + layout - + The layout of the text to draw - + diff --git a/reference/ui/ui/draw/stroke/construct.xml b/reference/ui/ui/draw/stroke/construct.xml index 073e0b7b5..f20688b0e 100644 --- a/reference/ui/ui/draw/stroke/construct.xml +++ b/reference/ui/ui/draw/stroke/construct.xml @@ -16,9 +16,9 @@ floatthickness1 floatmiterLimit10 - + Shall construct a new Stroke - + @@ -28,33 +28,33 @@ cap - + UI\Draw\Line\Cap::Flat, UI\Draw\Line\Cap::Round, or UI\Draw\Line\Cap::Square - + join - + UI\Draw\Line\Join::Miter, UI\Draw\Line\Join::Round, or UI\Draw\Line\Join::Bevel - + thickness - + The thickness of the stroke - + miterLimit - + Miter limit (default is sensible for all supported platforms) - + diff --git a/reference/ui/ui/draw/stroke/getcap.xml b/reference/ui/ui/draw/stroke/getcap.xml index 3a04f4343..6df1d3663 100644 --- a/reference/ui/ui/draw/stroke/getcap.xml +++ b/reference/ui/ui/draw/stroke/getcap.xml @@ -13,9 +13,9 @@ public intUI\Draw\Stroke::getCap - + Shall retrieve the line cap setting of this Stroke - + @@ -26,9 +26,9 @@ &reftitle.returnvalues; - + UI\Draw\Line\Cap::Flat, UI\Draw\Line\Cap::Round, or UI\Draw\Line\Cap::Square - + diff --git a/reference/ui/ui/draw/stroke/getjoin.xml b/reference/ui/ui/draw/stroke/getjoin.xml index f6c376454..604313f8d 100644 --- a/reference/ui/ui/draw/stroke/getjoin.xml +++ b/reference/ui/ui/draw/stroke/getjoin.xml @@ -13,9 +13,9 @@ public intUI\Draw\Stroke::getJoin - + Shall retrieve the line join setting of this Stroke - + @@ -26,9 +26,9 @@ &reftitle.returnvalues; - + UI\Draw\Line\Join::Miter, UI\Draw\Line\Join::Round, or UI\Draw\Line\Join::Bevel - + diff --git a/reference/ui/ui/draw/stroke/getmiterlimit.xml b/reference/ui/ui/draw/stroke/getmiterlimit.xml index 254894115..1c9e1b66c 100644 --- a/reference/ui/ui/draw/stroke/getmiterlimit.xml +++ b/reference/ui/ui/draw/stroke/getmiterlimit.xml @@ -13,9 +13,9 @@ public floatUI\Draw\Stroke::getMiterLimit - + Shall retrieve the miter limit of this Stroke - + @@ -26,9 +26,9 @@ &reftitle.returnvalues; - + The current miter limit - + diff --git a/reference/ui/ui/draw/stroke/getthickness.xml b/reference/ui/ui/draw/stroke/getthickness.xml index 4a1cf9de6..0790ed842 100644 --- a/reference/ui/ui/draw/stroke/getthickness.xml +++ b/reference/ui/ui/draw/stroke/getthickness.xml @@ -13,9 +13,9 @@ public floatUI\Draw\Stroke::getThickness - + Shall retrieve the thickness of this Stroke - + @@ -26,9 +26,9 @@ &reftitle.returnvalues; - + The current thickness - + diff --git a/reference/ui/ui/draw/stroke/setcap.xml b/reference/ui/ui/draw/stroke/setcap.xml index 63116e09d..03c49c446 100644 --- a/reference/ui/ui/draw/stroke/setcap.xml +++ b/reference/ui/ui/draw/stroke/setcap.xml @@ -13,9 +13,9 @@ public UI\Draw\Stroke::setCap intcap - + Shall set the line cap setting for this Stroke - + @@ -24,9 +24,9 @@ cap - + UI\Draw\Line\Cap::Flat, UI\Draw\Line\Cap::Round, or UI\Draw\Line\Cap::Square - + diff --git a/reference/ui/ui/draw/stroke/setjoin.xml b/reference/ui/ui/draw/stroke/setjoin.xml index e82b558af..56297631d 100644 --- a/reference/ui/ui/draw/stroke/setjoin.xml +++ b/reference/ui/ui/draw/stroke/setjoin.xml @@ -13,9 +13,9 @@ public UI\Draw\Stroke::setJoin intjoin - + Shall set the line join setting for this Stroke - + @@ -25,9 +25,9 @@ join - + UI\Draw\Line\Join::Miter, UI\Draw\Line\Join::Round, or UI\Draw\Line\Join::Bevel - + @@ -35,9 +35,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/ui/ui/draw/stroke/setmiterlimit.xml b/reference/ui/ui/draw/stroke/setmiterlimit.xml index 5b9cbb151..4553161db 100644 --- a/reference/ui/ui/draw/stroke/setmiterlimit.xml +++ b/reference/ui/ui/draw/stroke/setmiterlimit.xml @@ -13,9 +13,9 @@ public UI\Draw\Stroke::setMiterLimit floatlimit - + Set the miter limit for this Stroke - + @@ -25,9 +25,9 @@ limit - + The new limit - + diff --git a/reference/ui/ui/draw/stroke/setthickness.xml b/reference/ui/ui/draw/stroke/setthickness.xml index e1bc054f3..ec94e44c7 100644 --- a/reference/ui/ui/draw/stroke/setthickness.xml +++ b/reference/ui/ui/draw/stroke/setthickness.xml @@ -13,9 +13,9 @@ public UI\Draw\Stroke::setThickness floatthickness - + Shall set the thickness for this Stroke - + @@ -25,9 +25,9 @@ thickness - + The new thickness - + diff --git a/reference/ui/ui/draw/text/font.descriptor/construct.xml b/reference/ui/ui/draw/text/font.descriptor/construct.xml index 6c1b47738..7e1c3fa02 100644 --- a/reference/ui/ui/draw/text/font.descriptor/construct.xml +++ b/reference/ui/ui/draw/text/font.descriptor/construct.xml @@ -17,9 +17,9 @@ intitalicUI\Draw\Text\Font\Italic::Normal intstretchUI\Draw\Text\Font\Stretch::Normal - + Shall construct a new Font Descriptor - + @@ -29,41 +29,41 @@ family - + The name of a valid family of fonts - + size - + The preferred size - + weight - + UI\Draw\Text\Font\Weight constant - + italic - + UI\Draw\Text\Font\Italic constant - + stretch - + UI\Draw\Text\Font\Stretch constant - + @@ -75,7 +75,7 @@ &reftitle.returnvalues; - + --> diff --git a/reference/ui/ui/draw/text/font.descriptor/getfamily.xml b/reference/ui/ui/draw/text/font.descriptor/getfamily.xml index 591f46b56..d0d4c997e 100644 --- a/reference/ui/ui/draw/text/font.descriptor/getfamily.xml +++ b/reference/ui/ui/draw/text/font.descriptor/getfamily.xml @@ -13,9 +13,9 @@ public stringUI\Draw\Text\Font\Descriptor::getFamily - + Shall return the requested font family - + @@ -26,9 +26,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/ui/ui/draw/text/font.descriptor/getitalic.xml b/reference/ui/ui/draw/text/font.descriptor/getitalic.xml index 667a8acfd..d5f77d647 100644 --- a/reference/ui/ui/draw/text/font.descriptor/getitalic.xml +++ b/reference/ui/ui/draw/text/font.descriptor/getitalic.xml @@ -13,9 +13,9 @@ public intUI\Draw\Text\Font\Descriptor::getItalic - + Shall return constant setting - + @@ -26,9 +26,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/ui/ui/draw/text/font.descriptor/getsize.xml b/reference/ui/ui/draw/text/font.descriptor/getsize.xml index ccd31d80c..0d1a67234 100644 --- a/reference/ui/ui/draw/text/font.descriptor/getsize.xml +++ b/reference/ui/ui/draw/text/font.descriptor/getsize.xml @@ -13,9 +13,9 @@ public floatUI\Draw\Text\Font\Descriptor::getSize - + Shall return the requested size - + @@ -26,9 +26,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/ui/ui/draw/text/font.descriptor/getstretch.xml b/reference/ui/ui/draw/text/font.descriptor/getstretch.xml index 06bc62956..af5471052 100644 --- a/reference/ui/ui/draw/text/font.descriptor/getstretch.xml +++ b/reference/ui/ui/draw/text/font.descriptor/getstretch.xml @@ -13,9 +13,9 @@ public intUI\Draw\Text\Font\Descriptor::getStretch - + Shall return requested stretch - + @@ -26,9 +26,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/ui/ui/draw/text/font.descriptor/getweight.xml b/reference/ui/ui/draw/text/font.descriptor/getweight.xml index 2fc7ef5f1..046a25fe1 100644 --- a/reference/ui/ui/draw/text/font.descriptor/getweight.xml +++ b/reference/ui/ui/draw/text/font.descriptor/getweight.xml @@ -13,9 +13,9 @@ public intUI\Draw\Text\Font\Descriptor::getWeight - + Shall return requested weight - + @@ -26,9 +26,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/ui/ui/draw/text/font/construct.xml b/reference/ui/ui/draw/text/font/construct.xml index ff73a497e..bdc466a21 100644 --- a/reference/ui/ui/draw/text/font/construct.xml +++ b/reference/ui/ui/draw/text/font/construct.xml @@ -13,9 +13,9 @@ public UI\Draw\Text\Font::__construct UI\Draw\Text\Font\Descriptordescriptor - + Shall construct a new Font using the given descriptor - + @@ -25,9 +25,9 @@ descriptor - + The descriptor for the Font - + diff --git a/reference/ui/ui/draw/text/font/getascent.xml b/reference/ui/ui/draw/text/font/getascent.xml index 7d0e202f3..323a6c150 100644 --- a/reference/ui/ui/draw/text/font/getascent.xml +++ b/reference/ui/ui/draw/text/font/getascent.xml @@ -13,9 +13,9 @@ public floatUI\Draw\Text\Font::getAscent - + - + @@ -26,9 +26,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/ui/ui/draw/text/font/getdescent.xml b/reference/ui/ui/draw/text/font/getdescent.xml index d6248a6dd..5bd0f700e 100644 --- a/reference/ui/ui/draw/text/font/getdescent.xml +++ b/reference/ui/ui/draw/text/font/getdescent.xml @@ -13,9 +13,9 @@ public floatUI\Draw\Text\Font::getDescent - + - + @@ -26,9 +26,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/ui/ui/draw/text/font/getleading.xml b/reference/ui/ui/draw/text/font/getleading.xml index bbf0e83ee..e6654a907 100644 --- a/reference/ui/ui/draw/text/font/getleading.xml +++ b/reference/ui/ui/draw/text/font/getleading.xml @@ -13,9 +13,9 @@ public floatUI\Draw\Text\Font::getLeading - + - + @@ -26,9 +26,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/ui/ui/draw/text/font/getunderlineposition.xml b/reference/ui/ui/draw/text/font/getunderlineposition.xml index dd178b938..b717758ce 100644 --- a/reference/ui/ui/draw/text/font/getunderlineposition.xml +++ b/reference/ui/ui/draw/text/font/getunderlineposition.xml @@ -13,9 +13,9 @@ public floatUI\Draw\Text\Font::getUnderlinePosition - + - + @@ -26,9 +26,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/ui/ui/draw/text/font/getunderlinethickness.xml b/reference/ui/ui/draw/text/font/getunderlinethickness.xml index 7e989fb94..f24a3de29 100644 --- a/reference/ui/ui/draw/text/font/getunderlinethickness.xml +++ b/reference/ui/ui/draw/text/font/getunderlinethickness.xml @@ -13,9 +13,9 @@ public floatUI\Draw\Text\Font::getUnderlineThickness - + - + @@ -26,9 +26,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/ui/ui/draw/text/layout/construct.xml b/reference/ui/ui/draw/text/layout/construct.xml index e52d13520..7a1b01d4d 100644 --- a/reference/ui/ui/draw/text/layout/construct.xml +++ b/reference/ui/ui/draw/text/layout/construct.xml @@ -15,9 +15,9 @@ UI\Draw\Text\Fontfont floatwidth - + Shall construct a new Text Layout - + @@ -27,25 +27,25 @@ text - + The text for the layout - + font - + The font to use for writing - + width - + The width of the layout - + diff --git a/reference/ui/ui/draw/text/layout/setcolor.xml b/reference/ui/ui/draw/text/layout/setcolor.xml index e299ecd3b..b160ad808 100644 --- a/reference/ui/ui/draw/text/layout/setcolor.xml +++ b/reference/ui/ui/draw/text/layout/setcolor.xml @@ -21,9 +21,9 @@ intstart0 intend - + Shall set the Color for all of, or a range of the text in the Layout - + @@ -33,25 +33,25 @@ color - + The color to use - + start - + The starting character - + end - + The ending character, by default the end of the string - + diff --git a/reference/ui/ui/draw/text/layout/setwidth.xml b/reference/ui/ui/draw/text/layout/setwidth.xml index 031c7f5df..6683379c1 100644 --- a/reference/ui/ui/draw/text/layout/setwidth.xml +++ b/reference/ui/ui/draw/text/layout/setwidth.xml @@ -13,9 +13,9 @@ public UI\Draw\Text\Layout::setWidth floatwidth - + Shall set the width of this Text Layout - + @@ -25,9 +25,9 @@ width - + The new width - + diff --git a/reference/ui/ui/executor/construct.xml b/reference/ui/ui/executor/construct.xml index 7f7dda552..09a84fcb9 100644 --- a/reference/ui/ui/executor/construct.xml +++ b/reference/ui/ui/executor/construct.xml @@ -11,7 +11,7 @@ &reftitle.description; public UI\Executor::__construct - + public UI\Executor::__construct @@ -22,9 +22,9 @@ intseconds intmicroseconds - + Shall construct an executor with the given interval, will not start executing until main loop is entered - + @@ -34,17 +34,17 @@ seconds - + Seconds between executions - + microseconds - + Microseconds between executions - + @@ -56,7 +56,7 @@ &reftitle.returnvalues; - + --> diff --git a/reference/ui/ui/executor/kill.xml b/reference/ui/ui/executor/kill.xml index 7bffdc877..b1b262581 100644 --- a/reference/ui/ui/executor/kill.xml +++ b/reference/ui/ui/executor/kill.xml @@ -13,9 +13,9 @@ public voidUI\Executor::kill - + Shall stop an executor, the executor cannot be restarted - + @@ -26,9 +26,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/ui/ui/executor/onexecute.xml b/reference/ui/ui/executor/onexecute.xml index 81c6f665f..cf524a304 100644 --- a/reference/ui/ui/executor/onexecute.xml +++ b/reference/ui/ui/executor/onexecute.xml @@ -13,9 +13,9 @@ abstract protected voidUI\Executor::onExecute - + Shall be repetitively queued for execution in the main thread - + @@ -26,9 +26,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/ui/ui/executor/setinterval.xml b/reference/ui/ui/executor/setinterval.xml index b0914670c..32a3f6bcf 100644 --- a/reference/ui/ui/executor/setinterval.xml +++ b/reference/ui/ui/executor/setinterval.xml @@ -18,9 +18,9 @@ intseconds intmicroseconds - + Shall set the new interval. An interval of 0 will pause the executor until a new interval has been set - + @@ -30,17 +30,17 @@ seconds - - - + + + microseconds - - - + + + @@ -48,9 +48,9 @@ &reftitle.returnvalues; - + Indication of success - + diff --git a/reference/ui/ui/menu/append.xml b/reference/ui/ui/menu/append.xml index 98e183927..d06127983 100644 --- a/reference/ui/ui/menu/append.xml +++ b/reference/ui/ui/menu/append.xml @@ -14,9 +14,9 @@ stringname stringtypeUI\MenuItem::class - + Shall append a new Menu Item - + @@ -26,17 +26,17 @@ name - + The name (text) for the new item - + type - + The type for the new item - + @@ -44,9 +44,9 @@ &reftitle.returnvalues; - + A constructed object of the given type - + diff --git a/reference/ui/ui/menu/appendabout.xml b/reference/ui/ui/menu/appendabout.xml index c10599866..720f3477e 100644 --- a/reference/ui/ui/menu/appendabout.xml +++ b/reference/ui/ui/menu/appendabout.xml @@ -13,9 +13,9 @@ public UI\MenuItemUI\Menu::appendAbout stringtypeUI\MenuItem::class - + Shall append an About menu item - + @@ -25,9 +25,9 @@ type - + The type for the new item - + @@ -35,9 +35,9 @@ &reftitle.returnvalues; - + A constructed About menu item of the given type - + diff --git a/reference/ui/ui/menu/appendcheck.xml b/reference/ui/ui/menu/appendcheck.xml index 2c6d7dff2..7c5f3d4b7 100644 --- a/reference/ui/ui/menu/appendcheck.xml +++ b/reference/ui/ui/menu/appendcheck.xml @@ -14,9 +14,9 @@ stringname stringtypeUI\MenuItem::class - + Shall append a checkable menu item - + @@ -26,17 +26,17 @@ name - + The name (text) for the new item - + type - + The type for the new item - + @@ -44,9 +44,9 @@ &reftitle.returnvalues; - + A constructed checkable menu item of the given type - + diff --git a/reference/ui/ui/menu/appendpreferences.xml b/reference/ui/ui/menu/appendpreferences.xml index 2dbab7656..40692bfa0 100644 --- a/reference/ui/ui/menu/appendpreferences.xml +++ b/reference/ui/ui/menu/appendpreferences.xml @@ -13,9 +13,9 @@ public UI\MenuItemUI\Menu::appendPreferences stringtypeUI\MenuItem::class - + Shall append a Preferences menu item - + @@ -25,9 +25,9 @@ type - + The type for the new item - + @@ -35,9 +35,9 @@ &reftitle.returnvalues; - + A constructed Preferences menu item of the given type - + diff --git a/reference/ui/ui/menu/appendquit.xml b/reference/ui/ui/menu/appendquit.xml index a1d03b0b3..3b85578a0 100644 --- a/reference/ui/ui/menu/appendquit.xml +++ b/reference/ui/ui/menu/appendquit.xml @@ -13,9 +13,9 @@ public UI\MenuItemUI\Menu::appendQuit stringtypeUI\MenuItem::class - + Shall append a Quit menu item - + @@ -25,9 +25,9 @@ type - + The type for the new item - + @@ -35,9 +35,9 @@ &reftitle.returnvalues; - + A constructed Quit menu item of the given type - + diff --git a/reference/ui/ui/menu/appendseparator.xml b/reference/ui/ui/menu/appendseparator.xml index 078c25498..184fb57a6 100644 --- a/reference/ui/ui/menu/appendseparator.xml +++ b/reference/ui/ui/menu/appendseparator.xml @@ -13,9 +13,9 @@ public UI\Menu::appendSeparator - + Shall append a separator - + diff --git a/reference/ui/ui/menu/construct.xml b/reference/ui/ui/menu/construct.xml index cd326d0e9..24f225275 100644 --- a/reference/ui/ui/menu/construct.xml +++ b/reference/ui/ui/menu/construct.xml @@ -13,9 +13,9 @@ public UI\Menu::__construct stringname - + Shall construct a new Menu - + @@ -25,9 +25,9 @@ name - + The name (text) for the menu - + diff --git a/reference/ui/ui/menuitem/disable.xml b/reference/ui/ui/menuitem/disable.xml index 16d9dced3..81f29e92c 100644 --- a/reference/ui/ui/menuitem/disable.xml +++ b/reference/ui/ui/menuitem/disable.xml @@ -13,9 +13,9 @@ public UI\MenuItem::disable - + Shall disable this Menu Item - + diff --git a/reference/ui/ui/menuitem/enable.xml b/reference/ui/ui/menuitem/enable.xml index ff96fe1c2..3990907b0 100644 --- a/reference/ui/ui/menuitem/enable.xml +++ b/reference/ui/ui/menuitem/enable.xml @@ -13,9 +13,9 @@ public UI\MenuItem::enable - + Shall enable this Menu Item - + diff --git a/reference/ui/ui/menuitem/ischecked.xml b/reference/ui/ui/menuitem/ischecked.xml index f79262d35..1e5217b70 100644 --- a/reference/ui/ui/menuitem/ischecked.xml +++ b/reference/ui/ui/menuitem/ischecked.xml @@ -13,9 +13,9 @@ public boolUI\MenuItem::isChecked - + Shall detect if this Menu Item is checked - + diff --git a/reference/ui/ui/menuitem/onclick.xml b/reference/ui/ui/menuitem/onclick.xml index 67192168a..d16c92a1c 100644 --- a/reference/ui/ui/menuitem/onclick.xml +++ b/reference/ui/ui/menuitem/onclick.xml @@ -13,9 +13,9 @@ protected UI\MenuItem::onClick - + Shall be executed when this Menu Item is clicked - + diff --git a/reference/ui/ui/menuitem/setchecked.xml b/reference/ui/ui/menuitem/setchecked.xml index af2409f2f..f92b54bd3 100644 --- a/reference/ui/ui/menuitem/setchecked.xml +++ b/reference/ui/ui/menuitem/setchecked.xml @@ -13,9 +13,9 @@ public UI\MenuItem::setChecked boolchecked - + Shall set the checked status of this Menu Item - + @@ -25,9 +25,9 @@ checked - + The new status - + diff --git a/reference/ui/ui/point/at.xml b/reference/ui/ui/point/at.xml index 857af3b10..6db68b932 100644 --- a/reference/ui/ui/point/at.xml +++ b/reference/ui/ui/point/at.xml @@ -17,9 +17,9 @@ public static UI\PointUI\Point::at UI\Sizesize - + Shall return a UI\Point object where x and y are equal to those supplied, either in float or UI\Size form - + @@ -29,17 +29,17 @@ point - + The value for x and y - + size - + The Size to convert - + @@ -47,9 +47,9 @@ &reftitle.returnvalues; - + The resulting Point - + diff --git a/reference/ui/ui/point/construct.xml b/reference/ui/ui/point/construct.xml index f6b436eac..32ef9f14c 100644 --- a/reference/ui/ui/point/construct.xml +++ b/reference/ui/ui/point/construct.xml @@ -14,9 +14,9 @@ floatx floaty - + Construct a new Point using new co-ordinates - + @@ -25,17 +25,17 @@ x - + The new X co-ordinate - + y - + The new Y co-ordinate - + diff --git a/reference/ui/ui/point/getx.xml b/reference/ui/ui/point/getx.xml index a0ea3ec3e..03f44d628 100644 --- a/reference/ui/ui/point/getx.xml +++ b/reference/ui/ui/point/getx.xml @@ -13,9 +13,9 @@ public floatUI\Point::getX - + Retrieves the X co-ordinate - + @@ -25,9 +25,9 @@ &reftitle.returnvalues; - + The current X co-ordinate - + diff --git a/reference/ui/ui/point/gety.xml b/reference/ui/ui/point/gety.xml index 81091f840..2dc9b91fb 100644 --- a/reference/ui/ui/point/gety.xml +++ b/reference/ui/ui/point/gety.xml @@ -13,9 +13,9 @@ public floatUI\Point::getY - + Retrieves the Y co-ordinate - + @@ -25,9 +25,9 @@ &reftitle.returnvalues; - + The current Y co-ordinate - + diff --git a/reference/ui/ui/point/setx.xml b/reference/ui/ui/point/setx.xml index 89bdaa4fb..b96747117 100644 --- a/reference/ui/ui/point/setx.xml +++ b/reference/ui/ui/point/setx.xml @@ -13,9 +13,9 @@ public UI\Point::setX floatpoint - + Set the X co-ordinate - + @@ -24,9 +24,9 @@ point - + The new X co-ordinate - + @@ -34,9 +34,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/ui/ui/point/sety.xml b/reference/ui/ui/point/sety.xml index 8032d4bf5..1ecb50727 100644 --- a/reference/ui/ui/point/sety.xml +++ b/reference/ui/ui/point/sety.xml @@ -13,9 +13,9 @@ public UI\Point::setY floatpoint - + Set the Y co-ordinate - + @@ -24,9 +24,9 @@ point - + The new Y co-ordinate - + @@ -34,9 +34,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/ui/ui/size/construct.xml b/reference/ui/ui/size/construct.xml index 026366a3a..14f15ad5f 100644 --- a/reference/ui/ui/size/construct.xml +++ b/reference/ui/ui/size/construct.xml @@ -14,9 +14,9 @@ floatwidth floatheight - + Construct a new Size using new width and height - + @@ -26,17 +26,17 @@ width - + The new width - + height - + The new height - + @@ -48,7 +48,7 @@ &reftitle.returnvalues; - + --> diff --git a/reference/ui/ui/size/getheight.xml b/reference/ui/ui/size/getheight.xml index 074078af2..27b8ed021 100644 --- a/reference/ui/ui/size/getheight.xml +++ b/reference/ui/ui/size/getheight.xml @@ -13,9 +13,9 @@ public floatUI\Size::getHeight - + Retrieves the Height - + @@ -26,9 +26,9 @@ &reftitle.returnvalues; - + The current Height - + diff --git a/reference/ui/ui/size/getwidth.xml b/reference/ui/ui/size/getwidth.xml index 2e5454599..e8ce4a4a1 100644 --- a/reference/ui/ui/size/getwidth.xml +++ b/reference/ui/ui/size/getwidth.xml @@ -13,9 +13,9 @@ public floatUI\Size::getWidth - + Retrieves the Width - + @@ -26,9 +26,9 @@ &reftitle.returnvalues; - + The current Width - + diff --git a/reference/ui/ui/size/of.xml b/reference/ui/ui/size/of.xml index 476f97809..4a93205d5 100644 --- a/reference/ui/ui/size/of.xml +++ b/reference/ui/ui/size/of.xml @@ -17,9 +17,9 @@ public static UI\SizeUI\Size::of UI\Pointpoint - + Shall return a UI\Size object where width and height are equal to those supplied, either in float or UI\Point form - + @@ -29,17 +29,17 @@ size - + The value for width and height - + point - + The Point to convert - + @@ -47,9 +47,9 @@ &reftitle.returnvalues; - + The resulting Size - + diff --git a/reference/ui/ui/size/setheight.xml b/reference/ui/ui/size/setheight.xml index 2d505cd40..9e9314154 100644 --- a/reference/ui/ui/size/setheight.xml +++ b/reference/ui/ui/size/setheight.xml @@ -13,9 +13,9 @@ public UI\Size::setHeight floatsize - + Set new Height - + @@ -25,9 +25,9 @@ size - + The new Height - + @@ -35,9 +35,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/ui/ui/size/setwidth.xml b/reference/ui/ui/size/setwidth.xml index 6269bbb7f..9f699f12f 100644 --- a/reference/ui/ui/size/setwidth.xml +++ b/reference/ui/ui/size/setwidth.xml @@ -13,9 +13,9 @@ public UI\Size::setWidth floatsize - + Set new Width - + @@ -25,9 +25,9 @@ size - + The new Width - + @@ -35,9 +35,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/ui/ui/window/add.xml b/reference/ui/ui/window/add.xml index 584e36d62..a0c21aa4d 100644 --- a/reference/ui/ui/window/add.xml +++ b/reference/ui/ui/window/add.xml @@ -13,9 +13,9 @@ public UI\Window::add UI\Controlcontrol - + Shall add a Control to this Window - + @@ -25,9 +25,9 @@ control - + The Control to add - + @@ -35,9 +35,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/ui/ui/window/construct.xml b/reference/ui/ui/window/construct.xml index 704c4692c..ce8776f04 100644 --- a/reference/ui/ui/window/construct.xml +++ b/reference/ui/ui/window/construct.xml @@ -15,9 +15,9 @@ Sizesize boolmenu&false; - + Shall construct a new Window - + @@ -27,25 +27,25 @@ title - + The title of the Window - + size - + The size of the Window - + menu - + Menu switch - + @@ -57,7 +57,7 @@ &reftitle.returnvalues; - + --> diff --git a/reference/ui/ui/window/error.xml b/reference/ui/ui/window/error.xml index 1d19857c7..dc703e9a4 100644 --- a/reference/ui/ui/window/error.xml +++ b/reference/ui/ui/window/error.xml @@ -14,9 +14,9 @@ stringtitle stringmsg - + Shall show an error box - + @@ -26,17 +26,17 @@ title - + The title of the error box - + msg - + The message for the error box - + diff --git a/reference/ui/ui/window/getsize.xml b/reference/ui/ui/window/getsize.xml index 398db5fd5..7a9b97fbd 100644 --- a/reference/ui/ui/window/getsize.xml +++ b/reference/ui/ui/window/getsize.xml @@ -13,9 +13,9 @@ public UI\SizeUI\Window::getSize - + Shall return the size of this Window - + @@ -26,9 +26,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/ui/ui/window/gettitle.xml b/reference/ui/ui/window/gettitle.xml index 6687a4411..072a5449c 100644 --- a/reference/ui/ui/window/gettitle.xml +++ b/reference/ui/ui/window/gettitle.xml @@ -13,9 +13,9 @@ public stringUI\Window::getTitle - + Shall retrieve the title of this Window - + @@ -26,9 +26,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/ui/ui/window/hasborders.xml b/reference/ui/ui/window/hasborders.xml index 7f601c91b..97e512102 100644 --- a/reference/ui/ui/window/hasborders.xml +++ b/reference/ui/ui/window/hasborders.xml @@ -13,9 +13,9 @@ public boolUI\Window::hasBorders - + Shall detect if borders are used on this Window - + @@ -26,9 +26,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/ui/ui/window/hasmargin.xml b/reference/ui/ui/window/hasmargin.xml index dd730ad7f..4549d7036 100644 --- a/reference/ui/ui/window/hasmargin.xml +++ b/reference/ui/ui/window/hasmargin.xml @@ -13,9 +13,9 @@ public boolUI\Window::hasMargin - + Shall detect if margins are used on this Window - + @@ -26,9 +26,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/ui/ui/window/isfullscreen.xml b/reference/ui/ui/window/isfullscreen.xml index be55a2704..405f68cf4 100644 --- a/reference/ui/ui/window/isfullscreen.xml +++ b/reference/ui/ui/window/isfullscreen.xml @@ -26,9 +26,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/ui/ui/window/msg.xml b/reference/ui/ui/window/msg.xml index a229906ec..bf39acc5e 100644 --- a/reference/ui/ui/window/msg.xml +++ b/reference/ui/ui/window/msg.xml @@ -14,9 +14,9 @@ stringtitle stringmsg - + Shall show a message box - + @@ -26,17 +26,17 @@ title - + The title of the message box - + msg - + The message - + diff --git a/reference/ui/ui/window/onclosing.xml b/reference/ui/ui/window/onclosing.xml index 6c7653fe1..cb0a31db1 100644 --- a/reference/ui/ui/window/onclosing.xml +++ b/reference/ui/ui/window/onclosing.xml @@ -13,9 +13,9 @@ protected intUI\Window::onClosing - - Should gracefully destroy this Window - + + Should gracefully destroy this Window + @@ -26,9 +26,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/ui/ui/window/open.xml b/reference/ui/ui/window/open.xml index 5e4f799d6..1f45e8a59 100644 --- a/reference/ui/ui/window/open.xml +++ b/reference/ui/ui/window/open.xml @@ -13,9 +13,9 @@ public stringUI\Window::open - + Shall show an open file dialog - + @@ -26,9 +26,9 @@ &reftitle.returnvalues; - + Returns the name of the file selected for opening - + diff --git a/reference/ui/ui/window/save.xml b/reference/ui/ui/window/save.xml index bebbc89f5..7c5ca3b4e 100644 --- a/reference/ui/ui/window/save.xml +++ b/reference/ui/ui/window/save.xml @@ -13,9 +13,9 @@ public stringUI\Window::save - + Shall show a save dialog - + @@ -26,9 +26,9 @@ &reftitle.returnvalues; - + Returns the file name selecting for saving - + diff --git a/reference/ui/ui/window/setborders.xml b/reference/ui/ui/window/setborders.xml index 2074dccc6..a01a88f0a 100644 --- a/reference/ui/ui/window/setborders.xml +++ b/reference/ui/ui/window/setborders.xml @@ -13,9 +13,9 @@ public UI\Window::setBorders boolborders - + Shall enable or disable the use of borders on this Window - + @@ -25,9 +25,9 @@ borders - - - + + + diff --git a/reference/ui/ui/window/setfullscreen.xml b/reference/ui/ui/window/setfullscreen.xml index 59b1e6152..a7899972a 100644 --- a/reference/ui/ui/window/setfullscreen.xml +++ b/reference/ui/ui/window/setfullscreen.xml @@ -13,9 +13,9 @@ public UI\Window::setFullScreen boolfull - + Shall enable or disable the use of the full screen for this Window - + &warn.undocumented.func; @@ -27,9 +27,9 @@ full - - - + + + diff --git a/reference/ui/ui/window/setmargin.xml b/reference/ui/ui/window/setmargin.xml index ebbd5d036..a1004fbe8 100644 --- a/reference/ui/ui/window/setmargin.xml +++ b/reference/ui/ui/window/setmargin.xml @@ -13,9 +13,9 @@ public UI\Window::setMargin boolmargin - + Shall enable or disable the use of margins for this Window - + @@ -25,9 +25,9 @@ margin - - - + + + diff --git a/reference/ui/ui/window/setsize.xml b/reference/ui/ui/window/setsize.xml index 3cfa9af1d..8acc58f09 100644 --- a/reference/ui/ui/window/setsize.xml +++ b/reference/ui/ui/window/setsize.xml @@ -13,9 +13,9 @@ public UI\Window::setSize UI\Sizesize - + Shall set the size of this Window - + @@ -25,9 +25,9 @@ size - - - + + + @@ -35,9 +35,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/ui/ui/window/settitle.xml b/reference/ui/ui/window/settitle.xml index 86131fc23..2c2145ae1 100644 --- a/reference/ui/ui/window/settitle.xml +++ b/reference/ui/ui/window/settitle.xml @@ -13,9 +13,9 @@ public UI\Window::setTitle stringtitle - + Shall set the title for this Window - + @@ -25,9 +25,9 @@ title - + The new title - + diff --git a/reference/uopz/book.xml b/reference/uopz/book.xml index f36619cea..7409659f7 100644 --- a/reference/uopz/book.xml +++ b/reference/uopz/book.xml @@ -8,16 +8,16 @@ &reftitle.intro; - + The uopz - User Operations for Zend - extension exposes Zend Engine functionality normally used at compilation and execution time in order to allow modification of the internal structures that represent PHP code, and for user code to interact with the VM. - - + + uopz supports the following activities: - + Overloading some opcodes including ZEND_EXIT and ZEND_NEW Backup and restore functions and methods @@ -29,9 +29,9 @@ Runtime composition and modification of classes - + All of the activities supported are compatible with opcache - + diff --git a/reference/uopz/configure.xml b/reference/uopz/configure.xml index ac2389dee..e1d2737a8 100644 --- a/reference/uopz/configure.xml +++ b/reference/uopz/configure.xml @@ -4,13 +4,13 @@
    &reftitle.install; - + Use when compiling PHP. - + - + Windows users should include php_uopz.dll into &php.ini; - +
    diff --git a/reference/uopz/constants.xml b/reference/uopz/constants.xml index 7ff31d9da..a0d6fc7bc 100644 --- a/reference/uopz/constants.xml +++ b/reference/uopz/constants.xml @@ -4,9 +4,9 @@ &reftitle.constants; &extension.constants; - + The following opcodes are defined as constants by uopz before 5.0.0: - +     @@ -98,11 +98,11 @@ - + The following constants control the VM's behaviour after a user handler is invoked, be extremely careful! These constants are removed as of uopz 5.0.0. - + @@ -173,9 +173,9 @@ - + The following modifiers are registered as constants by uopz - + diff --git a/reference/uopz/functions/uopz-add-function.xml b/reference/uopz/functions/uopz-add-function.xml index 86b4f3525..dbc851604 100644 --- a/reference/uopz/functions/uopz-add-function.xml +++ b/reference/uopz/functions/uopz-add-function.xml @@ -23,9 +23,9 @@ intflagsZEND_ACC_PUBLIC intall&true; - + Adds a non-existent function or method. - + @@ -34,42 +34,42 @@ class - + The name of the class. - + function - + The name of the function or method. - + handler - + The Closure that defines the new function or method. - + flags - + Flags to set for the new function or method. - + all - + Whether all classes that descend from class will also be affected. - + @@ -77,17 +77,17 @@ &reftitle.returnvalues; - + &return.success; - + &reftitle.errors; - - uopz_add_function throws a RuntimeException + + uopz_add_function throws a RuntimeException if the function or method to add already exists. - + diff --git a/reference/uopz/functions/uopz-allow-exit.xml b/reference/uopz/functions/uopz-allow-exit.xml index 9039fcf4e..3c240df91 100644 --- a/reference/uopz/functions/uopz-allow-exit.xml +++ b/reference/uopz/functions/uopz-allow-exit.xml @@ -13,11 +13,11 @@ voiduopz_allow_exit boolallow - + By default uopz disables the exit opcode, so exit calls are practically ignored. uopz_allow_exit allows to control this behavior. - + @@ -26,9 +26,9 @@ allow - + Whether to allow the execution of exit opcodes or not. - + @@ -36,9 +36,9 @@ &reftitle.returnvalues; - + &return.void; - + @@ -68,9 +68,9 @@ echo 2; &reftitle.notes; - + OPcache optimizes away dead code after unconditional exit. - + diff --git a/reference/uopz/functions/uopz-backup.xml b/reference/uopz/functions/uopz-backup.xml index 49b4dbd74..f8149224b 100644 --- a/reference/uopz/functions/uopz-backup.xml +++ b/reference/uopz/functions/uopz-backup.xml @@ -22,9 +22,9 @@ stringclass stringfunction - + Backup a function at runtime, to be restored on shutdown - + @@ -34,17 +34,17 @@ class - + The name of the class containing the function to backup - + function - + The name of the function - + @@ -52,9 +52,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/uopz/functions/uopz-compose.xml b/reference/uopz/functions/uopz-compose.xml index 88b5a65a1..fa664385d 100644 --- a/reference/uopz/functions/uopz-compose.xml +++ b/reference/uopz/functions/uopz-compose.xml @@ -21,9 +21,9 @@ arrayproperties intflags - + Creates a new class of the given name that implements, extends, or uses all of the provided classes - + @@ -32,41 +32,41 @@ name - + A legal class name - + classes - + An array of class, interface and trait names - + methods - + An associative array of methods, values are either closures or [modifiers => closure] - + properties - + An associative array of properties, keys are names, values are modifiers - + flags - + Entry type, by default ZEND_ACC_CLASS - + @@ -74,9 +74,9 @@ &reftitle.returnvalues; - + - + diff --git a/reference/uopz/functions/uopz-copy.xml b/reference/uopz/functions/uopz-copy.xml index ea9e85a69..5748058e5 100644 --- a/reference/uopz/functions/uopz-copy.xml +++ b/reference/uopz/functions/uopz-copy.xml @@ -22,9 +22,9 @@ stringclass stringfunction - + Copy a function by name - + @@ -34,17 +34,17 @@ class - + The name of the class containing the function to copy - + function - + The name of the function - + @@ -52,9 +52,9 @@ &reftitle.returnvalues; - + A Closure for the specified function - + diff --git a/reference/uopz/functions/uopz-del-function.xml b/reference/uopz/functions/uopz-del-function.xml index 4215982be..2dc42cb89 100644 --- a/reference/uopz/functions/uopz-del-function.xml +++ b/reference/uopz/functions/uopz-del-function.xml @@ -19,9 +19,9 @@ stringfunction intall&true; - + Deletes a previously added function or method. - + @@ -30,26 +30,26 @@ class - + The name of the class. - + function - + The name of the function or method. - + all - + Whether all classes that descend from class will also be affected. - + @@ -57,17 +57,17 @@ &reftitle.returnvalues; - + &return.success; - + &reftitle.errors; - - uopz_del_function throws a RuntimeException + + uopz_del_function throws a RuntimeException if the function or method to delete has not been added by uopz_add_function. - + diff --git a/reference/uopz/functions/uopz-delete.xml b/reference/uopz/functions/uopz-delete.xml index fab090309..7c3f4a432 100644 --- a/reference/uopz/functions/uopz-delete.xml +++ b/reference/uopz/functions/uopz-delete.xml @@ -22,9 +22,9 @@ stringclass stringfunction - + Deletes a function or method - + @@ -33,15 +33,15 @@ class - - + + function - - + + @@ -49,9 +49,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/uopz/functions/uopz-extend.xml b/reference/uopz/functions/uopz-extend.xml index aeaede09f..9d5dd51e3 100644 --- a/reference/uopz/functions/uopz-extend.xml +++ b/reference/uopz/functions/uopz-extend.xml @@ -14,9 +14,9 @@ stringclass stringparent - + Makes class extend parent - + @@ -25,17 +25,17 @@ class - + The name of the class to extend - + parent - + The name of the class to inherit - + @@ -43,15 +43,15 @@ &reftitle.returnvalues; - + &return.success; - + &reftitle.errors; - As of PHP 7.4.0, uopz_extend throws a RuntimeException, + As of PHP 7.4.0, uopz_extend throws a RuntimeException, if OPcache is enabled, and the class entry of either class or parent (if it is a trait) is immutable. diff --git a/reference/uopz/functions/uopz-flags.xml b/reference/uopz/functions/uopz-flags.xml index aa37db539..9059bc5da 100644 --- a/reference/uopz/functions/uopz-flags.xml +++ b/reference/uopz/functions/uopz-flags.xml @@ -20,9 +20,9 @@ stringfunction intflagsPHP_INT_MAX - + Get or set the flags on a class or function entry at runtime - + @@ -32,28 +32,28 @@ class - + The name of a class - + function - + The name of the function. If class is given and an empty string is passed as function, uopz_flags gets or sets the flags of the class entry. - + - + flags - + A valid set of ZEND_ACC_ flags. If omitted, uopz_flags acts as getter. - + @@ -61,16 +61,16 @@ &reftitle.returnvalues; - + If setting, returns old flags, else returns flags - + &reftitle.errors; As of PHP 7.4.0, if the parameter flags is passed, - uopz_flags throws a RuntimeException, + uopz_flags throws a RuntimeException, if OPcache is enabled, and the class entry of class or the function entry of function is immutable. diff --git a/reference/uopz/functions/uopz-function.xml b/reference/uopz/functions/uopz-function.xml index 79b208885..b6fa7a66b 100644 --- a/reference/uopz/functions/uopz-function.xml +++ b/reference/uopz/functions/uopz-function.xml @@ -26,9 +26,9 @@ Closurehandler intmodifiers - + Creates a function at runtime - + @@ -38,33 +38,33 @@ class - + The name of the class to receive the new function - + function - + The name of the function - + handler - + The Closure for the function - + modifiers - + The modifiers for the function, by default copied or ZEND_ACC_PUBLIC - + @@ -72,9 +72,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/uopz/functions/uopz-get-exit-status.xml b/reference/uopz/functions/uopz-get-exit-status.xml index 7833874ee..50f42d1f2 100644 --- a/reference/uopz/functions/uopz-get-exit-status.xml +++ b/reference/uopz/functions/uopz-get-exit-status.xml @@ -13,10 +13,10 @@ mixeduopz_get_exit_status - + Retrieves the last set exit status, i.e. the value passed to exit. - + @@ -26,10 +26,10 @@ &reftitle.returnvalues; - + This function returns the last exit status, or &null; if exit has not been called. - + @@ -39,7 +39,7 @@ ]]> @@ -55,9 +55,9 @@ echo uopz_get_exit_status();?> &reftitle.notes; - + OPcache optimizes away dead code after unconditional exit. - + diff --git a/reference/uopz/functions/uopz-get-hook.xml b/reference/uopz/functions/uopz-get-hook.xml index 2b3bc2385..ccc0cf2e4 100644 --- a/reference/uopz/functions/uopz-get-hook.xml +++ b/reference/uopz/functions/uopz-get-hook.xml @@ -18,9 +18,9 @@ stringclass stringfunction - + Gets the previously set hook on a function or method. - + @@ -29,17 +29,17 @@ class - + The name of the class. - + function - + The name of the function or method. - + @@ -47,10 +47,10 @@ &reftitle.returnvalues; - + Returns the previously set hook on a function or method, or &null; if no hook has been set. - + diff --git a/reference/uopz/functions/uopz-get-mock.xml b/reference/uopz/functions/uopz-get-mock.xml index acc6abbb8..402839ae7 100644 --- a/reference/uopz/functions/uopz-get-mock.xml +++ b/reference/uopz/functions/uopz-get-mock.xml @@ -13,9 +13,9 @@ mixeduopz_get_mock stringclass - + Returns the current mock for class. - + @@ -24,19 +24,19 @@ class - + The name of the mocked class. - + &reftitle.returnvalues; - + Either a string containing the name of the mock, or an object, or &null; if no mock has been set. - + diff --git a/reference/uopz/functions/uopz-get-property.xml b/reference/uopz/functions/uopz-get-property.xml index 6576e91c8..78dded6e6 100644 --- a/reference/uopz/functions/uopz-get-property.xml +++ b/reference/uopz/functions/uopz-get-property.xml @@ -19,11 +19,11 @@ objectinstance stringproperty - + Gets the value of a static class property, if class is given, or the value of an instance property, if instance is given. - + @@ -32,25 +32,25 @@ class - + The name of the class. - + instance - + The object instance. - + property - + The name of the property. - + @@ -58,10 +58,10 @@ &reftitle.returnvalues; - + Returns the value of the class or instance property, or &null; if the property is not defined. - + diff --git a/reference/uopz/functions/uopz-get-return.xml b/reference/uopz/functions/uopz-get-return.xml index 41fed270e..8c34b9ca3 100644 --- a/reference/uopz/functions/uopz-get-return.xml +++ b/reference/uopz/functions/uopz-get-return.xml @@ -18,9 +18,9 @@ stringclass stringfunction - + Gets the return value of the function previously set by uopz_set_return. - + @@ -29,17 +29,17 @@ class - + The name of the class containing the function - + function - + The name of the function - + @@ -47,9 +47,9 @@ &reftitle.returnvalues; - + The return value or Closure previously set. - + diff --git a/reference/uopz/functions/uopz-get-static.xml b/reference/uopz/functions/uopz-get-static.xml index 93ce34b94..306659540 100644 --- a/reference/uopz/functions/uopz-get-static.xml +++ b/reference/uopz/functions/uopz-get-static.xml @@ -18,9 +18,9 @@ arrayuopz_get_static stringfunction - + Gets the static variables from function or method scope. - + @@ -29,17 +29,17 @@ class - + The name of the class. - + function - + The name of the function or method. - + @@ -47,10 +47,10 @@ &reftitle.returnvalues; - + Returns an associative array of variable names mapped to their current values on success, or &null; if the function or method does not exist. - + As of PHP 8.3.0, static initializers are either computed during compile time, or if that is not possible, only when the function or method is run the first diff --git a/reference/uopz/functions/uopz-implement.xml b/reference/uopz/functions/uopz-implement.xml index fc8722d0c..6df1b19fe 100644 --- a/reference/uopz/functions/uopz-implement.xml +++ b/reference/uopz/functions/uopz-implement.xml @@ -14,9 +14,9 @@ stringclass stringinterface - + Makes class implement interface - + @@ -26,17 +26,17 @@ class - + - + interface - - - + + + @@ -44,15 +44,15 @@ &reftitle.returnvalues; - + &return.success; - + &reftitle.errors; - As of PHP 7.4.0, uopz_implement throws a RuntimeException, + As of PHP 7.4.0, uopz_implement throws a RuntimeException, if OPcache is enabled, and the class entry of class is immutable. diff --git a/reference/uopz/functions/uopz-overload.xml b/reference/uopz/functions/uopz-overload.xml index 0539df8f3..a1cc71277 100644 --- a/reference/uopz/functions/uopz-overload.xml +++ b/reference/uopz/functions/uopz-overload.xml @@ -18,9 +18,9 @@ intopcode Callablecallable - + Overloads the specified opcode with the user defined function - + @@ -30,17 +30,17 @@ opcode - + A valid opcode, see constants for details of supported codes - + callable - - - + + + @@ -48,9 +48,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/uopz/functions/uopz-redefine.xml b/reference/uopz/functions/uopz-redefine.xml index 6bece72b5..c45d37032 100644 --- a/reference/uopz/functions/uopz-redefine.xml +++ b/reference/uopz/functions/uopz-redefine.xml @@ -20,9 +20,9 @@ stringconstant mixedvalue - + Redefines the given constant as value - + @@ -31,25 +31,25 @@ class - + The name of the class containing the constant - + constant - + The name of the constant - + value - + The new value for the constant, must be a valid type for a constant variable - + @@ -57,9 +57,9 @@ &reftitle.returnvalues; - + &return.success; - + diff --git a/reference/uopz/functions/uopz-rename.xml b/reference/uopz/functions/uopz-rename.xml index 064747c99..7f40624ed 100644 --- a/reference/uopz/functions/uopz-rename.xml +++ b/reference/uopz/functions/uopz-rename.xml @@ -24,13 +24,13 @@ stringfunction stringrename - + Renames function to rename - + - + If both functions exist, this effectively swaps their names - + @@ -40,25 +40,25 @@ class - + The name of the class containing the function - + function - + The name of an existing function - + rename - + The new name for the function - + @@ -66,9 +66,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/uopz/functions/uopz-restore.xml b/reference/uopz/functions/uopz-restore.xml index 80a678640..b66f0bb2d 100644 --- a/reference/uopz/functions/uopz-restore.xml +++ b/reference/uopz/functions/uopz-restore.xml @@ -22,9 +22,9 @@ stringclass stringfunction - + Restore a previously backed up function - + @@ -34,17 +34,17 @@ class - + The name of the class containing the function to restore - + function - + The name of the function - + @@ -52,9 +52,9 @@ &reftitle.returnvalues; - - - + + + diff --git a/reference/uopz/functions/uopz-set-hook.xml b/reference/uopz/functions/uopz-set-hook.xml index 6cf4041c6..dba37a9b7 100644 --- a/reference/uopz/functions/uopz-set-hook.xml +++ b/reference/uopz/functions/uopz-set-hook.xml @@ -20,9 +20,9 @@ stringfunction Closurehook - + Sets a hook to execute when entering a function or method. - + @@ -31,25 +31,25 @@ class - + The name of the class. - + function - + The name of the function or method. - + hook - + A closure to execute when entering the function or method. - + @@ -57,9 +57,9 @@ &reftitle.returnvalues; - + &return.success; - + diff --git a/reference/uopz/functions/uopz-set-mock.xml b/reference/uopz/functions/uopz-set-mock.xml index fedc74606..0c766886c 100644 --- a/reference/uopz/functions/uopz-set-mock.xml +++ b/reference/uopz/functions/uopz-set-mock.xml @@ -14,16 +14,16 @@ stringclass mixedmock - + If mock is a string containing the name of a class then it will be instantiated instead of class. mock can also be an object. - + - + Only dynamic access to properties and methods will use the mock object. Static access still uses the original class. See example below. - + @@ -33,19 +33,19 @@ class - + The name of the class to be mocked. - + mock - + The mock to use in the form of a string containing the name of the class to use or an object. If a string is passed, it has to be the fully qualified class name. It is recommended to use the ::class magic constant in this case. - + @@ -53,9 +53,9 @@ &reftitle.returnvalues; - + &return.void; - + @@ -142,9 +142,9 @@ mockA <function>uopz_set_mock</function> and static members - + As of uopz 6.0.0 mocking static members is no longer supported. - + - + Output of the above example in uopz 5: - + stringproperty mixedvalue - + Sets the value of an existing static class property, if class is given, or the value of an instance property (regardless whether the instance property already exists), if instance is given. - + @@ -34,33 +34,33 @@ class - + The name of the class. - + instance - + The object instance. - + property - + The name of the property. - + value - + The value to assign to the property. - + @@ -68,9 +68,9 @@ &reftitle.returnvalues; - + &return.void; - + diff --git a/reference/uopz/functions/uopz-set-return.xml b/reference/uopz/functions/uopz-set-return.xml index e0400cc03..f890dff3a 100644 --- a/reference/uopz/functions/uopz-set-return.xml +++ b/reference/uopz/functions/uopz-set-return.xml @@ -22,15 +22,15 @@ mixedvalue boolexecute&false; - + Sets the return value of the function to value. If value is a Closure and execute is set, the Closure will be executed in place of the original function. It is possible to call the original function from the Closure. - + - + This function replaces uopz_rename. - + @@ -40,33 +40,33 @@ class - + The name of the class containing the function - + function - + The name of an existing function - + value - + The value the function should return. If a Closure is provided and the execute flag is set, the Closure will be executed in place of the original function. - + execute - + If true, and a Closure was provided as the value, the Closure will be executed in place of the original function. - + @@ -74,9 +74,9 @@ &reftitle.returnvalues; - + True if succeeded, false otherwise. - + diff --git a/reference/uopz/functions/uopz-undefine.xml b/reference/uopz/functions/uopz-undefine.xml index ef16d3467..99aefb845 100644 --- a/reference/uopz/functions/uopz-undefine.xml +++ b/reference/uopz/functions/uopz-undefine.xml @@ -18,9 +18,9 @@ stringclass stringconstant - + Removes the constant at runtime - + @@ -29,17 +29,17 @@ class - + The name of the class containing constant - + constant - + The name of an existing constant - + @@ -47,9 +47,9 @@ &reftitle.returnvalues; - + &return.success; - + diff --git a/reference/uopz/functions/uopz-unset-hook.xml b/reference/uopz/functions/uopz-unset-hook.xml index a12820ea9..ad1408be3 100644 --- a/reference/uopz/functions/uopz-unset-hook.xml +++ b/reference/uopz/functions/uopz-unset-hook.xml @@ -18,9 +18,9 @@ stringclass stringfunction - + Removes the previously set hook on a function or method. - + @@ -29,17 +29,17 @@ class - + The name of the class. - + function - + The name of the function or method. - + @@ -47,9 +47,9 @@ &reftitle.returnvalues; - + &return.success; - + diff --git a/reference/uopz/functions/uopz-unset-mock.xml b/reference/uopz/functions/uopz-unset-mock.xml index fc83562a0..4d0d63d98 100644 --- a/reference/uopz/functions/uopz-unset-mock.xml +++ b/reference/uopz/functions/uopz-unset-mock.xml @@ -13,9 +13,9 @@ voiduopz_unset_mock stringclass - + Unsets the previously set mock for class. - + @@ -24,9 +24,9 @@ class - + The name of the mocked class. - + @@ -34,17 +34,17 @@ &reftitle.returnvalues; - + &return.void; - + &reftitle.errors; - - A RuntimeException is thrown, if no mock was previously + + A RuntimeException is thrown, if no mock was previously set for class. - + diff --git a/reference/uopz/functions/uopz-unset-return.xml b/reference/uopz/functions/uopz-unset-return.xml index a9437042d..f2b749800 100644 --- a/reference/uopz/functions/uopz-unset-return.xml +++ b/reference/uopz/functions/uopz-unset-return.xml @@ -18,9 +18,9 @@ stringclass stringfunction - + Unsets the return value of the function previously set by uopz_set_return. - + @@ -29,17 +29,17 @@ class - + The name of the class containing the function - + function - + The name of the function - + @@ -47,9 +47,9 @@ &reftitle.returnvalues; - + True on success - + diff --git a/reference/uopz/functions/uopz_set_static.xml b/reference/uopz/functions/uopz_set_static.xml index 52b09fab9..711472d14 100644 --- a/reference/uopz/functions/uopz_set_static.xml +++ b/reference/uopz/functions/uopz_set_static.xml @@ -20,9 +20,9 @@ stringfunction arraystatic - + Sets the static variables in function or method scope. - + @@ -31,26 +31,26 @@ class - + The name of the class. - + function - + The name of the function or method. - + static - + The associative array of variable names mapped to their values. - + @@ -58,9 +58,9 @@ &reftitle.returnvalues; - + &return.void; - + diff --git a/reference/uopz/setup.xml b/reference/uopz/setup.xml index 2eb2c9891..2f22960c0 100644 --- a/reference/uopz/setup.xml +++ b/reference/uopz/setup.xml @@ -6,27 +6,27 @@
    &reftitle.required; - + As of uopz 5.0 PHP 7.0 is required. As of uopz 5.1, PHP 7.1+ is required. - +
    &reftitle.install; - + uopz releases are hosted by PECL and the source code by github, the easiest route to installation is the normal PECL route: &url.pecl.package;uopz. - - + + Windows users can download prebuilt release binaries from the PECL website. - - + + As of uopz 5.0.0 the extension must be loaded as extension. Before this version it must be loaded as zend_extension. - +
    @@ -79,9 +79,9 @@ bool - + If enabled, uopz should stop having any effect on the engine. - + @@ -90,10 +90,10 @@ bool - + Whether to allow the execution of exit opcodes or not. This setting can be overridden during runtime by calling uopz_allow_exit. - + @@ -102,9 +102,9 @@ bool - + Enables the ability to use uopz_overload. - + diff --git a/reference/v8js/book.xml b/reference/v8js/book.xml index 7bc3c086f..0be831842 100644 --- a/reference/v8js/book.xml +++ b/reference/v8js/book.xml @@ -8,9 +8,9 @@ &reftitle.intro; - + This extension embeds the V8 Javascript Engine into PHP. - + &reference.v8js.setup; diff --git a/reference/v8js/configure.xml b/reference/v8js/configure.xml index 843a22356..d08fa1c0b 100644 --- a/reference/v8js/configure.xml +++ b/reference/v8js/configure.xml @@ -4,12 +4,12 @@
    &reftitle.install; - + &pecl.info; &url.pecl.package;v8js - + + -
    diff --git a/reference/v8js/examples.xml b/reference/v8js/examples.xml index 20ed5fca3..5dcbd0bd0 100644 --- a/reference/v8js/examples.xml +++ b/reference/v8js/examples.xml @@ -3,9 +3,9 @@ &reftitle.examples; - + Basic usage - + Basic Javascript execution diff --git a/reference/v8js/ini.xml b/reference/v8js/ini.xml index 636ece675..3713bc789 100644 --- a/reference/v8js/ini.xml +++ b/reference/v8js/ini.xml @@ -44,10 +44,10 @@ int - + Sets limit for disposed contexts before forcing V8 to do garbage collection. - + @@ -68,10 +68,10 @@ $ php -r 'ini_set("v8js.flags", "--help"); new V8Js;' | less - + For these flags to be effective in runtime the ini_set() call has to be done before any V8Js objects are instantiated! - + diff --git a/reference/v8js/setup.xml b/reference/v8js/setup.xml index 83e6faa92..c400e6a21 100644 --- a/reference/v8js/setup.xml +++ b/reference/v8js/setup.xml @@ -6,9 +6,9 @@
    &reftitle.required; - + PHP and V8 library and headers installed in proper paths. - +
    &reference.v8js.configure; diff --git a/reference/v8js/v8js.xml b/reference/v8js/v8js.xml index 059ff7fe2..a3c8bbde3 100644 --- a/reference/v8js/v8js.xml +++ b/reference/v8js/v8js.xml @@ -10,14 +10,14 @@
    &reftitle.intro; - + This is the core class for V8Js extension. Each instance created from this class has own context in which all JavaScript is compiled and executed. - - + + See V8Js::__construct for more information. - +
    @@ -70,21 +70,21 @@ V8Js::V8_VERSION - The V8 Javascript Engine version. + The V8 Javascript Engine version. V8Js::FLAG_NONE - No flags. + No flags. V8Js::FLAG_FORCE_ARRAY - Forces all JS objects to be associative arrays in PHP. + Forces all JS objects to be associative arrays in PHP. diff --git a/reference/v8js/v8js/construct.xml b/reference/v8js/v8js/construct.xml index 838906a21..f51102f2c 100644 --- a/reference/v8js/v8js/construct.xml +++ b/reference/v8js/v8js/construct.xml @@ -16,9 +16,9 @@ arrayextensionsarray() boolreport_uncaught_exceptions&true; - + Constructs a new V8Js object. - + @@ -28,31 +28,31 @@ object_name - + The name of the object passed to Javascript. - + variables - + Map of PHP variables that will be available in Javascript. Must be an associative array in format array("name-for-js" => "name-of-php-variable"). Defaults to empty array. - + extensions - List of extensions registered using V8Js::registerExtension which should be available + List of extensions registered using V8Js::registerExtension which should be available in the Javascript context of the created V8Js object. - + Extensions registered to be enabled automatically do not need to be listed in this array. Also if an extension has dependencies, those dependencies can be omitted as well. Defaults to empty array. - + @@ -60,10 +60,10 @@ report_uncaught_exceptions - + Controls whether uncaught Javascript exceptions are reported immediately or not. Defaults to &true;. If set to &false; the uncaught exception can be accessed using V8Js::getPendingException. - + diff --git a/reference/v8js/v8js/executestring.xml b/reference/v8js/v8js/executestring.xml index 1e427a1cd..aa5ac65ca 100644 --- a/reference/v8js/v8js/executestring.xml +++ b/reference/v8js/v8js/executestring.xml @@ -15,9 +15,9 @@ stringidentifier"V8Js::executeString()" intflagsV8Js::FLAG_NONE - + Compiles and executes the string passed with script as Javascript code. - + @@ -26,17 +26,17 @@ script - + The code string to be executed. - + identifier - + Identifier string for the executed code. Used for debugging. - + @@ -48,15 +48,15 @@ V8Js::FLAG_NONE. - + V8Js::FLAG_NONE: no flags - + - + V8Js::FLAG_FORCE_ARRAY: forces all Javascript objects passed to PHP to be associative arrays - + @@ -67,9 +67,9 @@ &reftitle.returnvalues; - + Returns the last variable instantiated in the Javascript code converted to matching PHP variable type. - + diff --git a/reference/v8js/v8js/getextensions.xml b/reference/v8js/v8js/getextensions.xml index dbe9114cc..10ae07d92 100644 --- a/reference/v8js/v8js/getextensions.xml +++ b/reference/v8js/v8js/getextensions.xml @@ -13,9 +13,9 @@ public static arrayV8Js::getExtensions - + This function returns array of Javascript extensions registered using V8Js::registerExtension. - + @@ -25,9 +25,9 @@ &reftitle.returnvalues; - + Returns an array of registered extensions or an empty array if there are none. - + diff --git a/reference/v8js/v8js/getpendingexception.xml b/reference/v8js/v8js/getpendingexception.xml index 217564dc3..08a9e26b6 100644 --- a/reference/v8js/v8js/getpendingexception.xml +++ b/reference/v8js/v8js/getpendingexception.xml @@ -13,10 +13,10 @@ public V8JsExceptionV8Js::getPendingException - - Returns any pending uncaught Javascript exception as V8JsException + + Returns any pending uncaught Javascript exception as V8JsException left from earlier V8Js::executeString call(s). - + @@ -26,9 +26,9 @@ &reftitle.returnvalues; - - Either V8JsException or &null;. - + + Either V8JsException or &null;. + diff --git a/reference/v8js/v8js/registerextension.xml b/reference/v8js/v8js/registerextension.xml index 07ff8422b..5f376c5c3 100644 --- a/reference/v8js/v8js/registerextension.xml +++ b/reference/v8js/v8js/registerextension.xml @@ -16,10 +16,10 @@ arraydependenciesarray() boolauto_enable&false; - + Registers passed Javascript script as extension to be used in V8Js contexts. - + @@ -28,17 +28,17 @@ extension_name - + Name of the extension to be registered. - + script - + The Javascript code to be registered. - + @@ -48,10 +48,10 @@ Array of extension names the extension to be registered depends on. Any such extension is enabled automatically when this extension is loaded. - + All extensions, including the dependencies, must be registered before any V8Js are created which use them. - + @@ -59,9 +59,9 @@ auto_enable - + If set to &true;, the extension will be enabled automatically in all V8Js contexts. - + @@ -69,9 +69,9 @@ &reftitle.returnvalues; - + Returns &true; if extension was registered successfully, &false; otherwise. - + diff --git a/reference/v8js/v8jsexception.xml b/reference/v8js/v8jsexception.xml index 4e5cb3c7c..6c775b25e 100644 --- a/reference/v8js/v8jsexception.xml +++ b/reference/v8js/v8jsexception.xml @@ -3,7 +3,7 @@ - The <classname>V8JsException</classname> class + The <exceptionname>V8JsException</exceptionname> class V8JsException @@ -11,9 +11,9 @@
    &reftitle.intro; - + - +
    @@ -29,7 +29,7 @@ V8JsException - + extends Exception @@ -56,10 +56,10 @@ &InheritedProperties; - + &Methods; - + &InheritedMethods; @@ -68,7 +68,7 @@
    - +
    &reftitle.properties; @@ -76,25 +76,25 @@ JsFileName - + JsLineNumber - + JsSourceLine - + JsTrace - + diff --git a/reference/v8js/v8jsexception/getjsfilename.xml b/reference/v8js/v8jsexception/getjsfilename.xml index d5926ad3b..837acd737 100644 --- a/reference/v8js/v8jsexception/getjsfilename.xml +++ b/reference/v8js/v8jsexception/getjsfilename.xml @@ -13,9 +13,9 @@ final public stringV8JsException::getJsFileName - + - + &warn.undocumented.func; @@ -28,9 +28,9 @@ &reftitle.returnvalues; - + - + diff --git a/reference/v8js/v8jsexception/getjslinenumber.xml b/reference/v8js/v8jsexception/getjslinenumber.xml index 172fd7d3d..d27e124be 100644 --- a/reference/v8js/v8jsexception/getjslinenumber.xml +++ b/reference/v8js/v8jsexception/getjslinenumber.xml @@ -13,9 +13,9 @@ final public intV8JsException::getJsLineNumber - + - + &warn.undocumented.func; @@ -28,9 +28,9 @@ &reftitle.returnvalues; - + - + diff --git a/reference/v8js/v8jsexception/getjssourceline.xml b/reference/v8js/v8jsexception/getjssourceline.xml index adc21d43e..7137c05eb 100644 --- a/reference/v8js/v8jsexception/getjssourceline.xml +++ b/reference/v8js/v8jsexception/getjssourceline.xml @@ -13,9 +13,9 @@ final public stringV8JsException::getJsSourceLine - + - + &warn.undocumented.func; @@ -28,9 +28,9 @@ &reftitle.returnvalues; - + - + diff --git a/reference/v8js/v8jsexception/getjstrace.xml b/reference/v8js/v8jsexception/getjstrace.xml index dc3489a54..c50b32098 100644 --- a/reference/v8js/v8jsexception/getjstrace.xml +++ b/reference/v8js/v8jsexception/getjstrace.xml @@ -13,9 +13,9 @@ final public stringV8JsException::getJsTrace - + - + &warn.undocumented.func; @@ -28,9 +28,9 @@ &reftitle.returnvalues; - + - + diff --git a/reference/var_representation/constants.xml b/reference/var_representation/constants.xml index a67d0615b..40453facc 100644 --- a/reference/var_representation/constants.xml +++ b/reference/var_representation/constants.xml @@ -11,7 +11,7 @@ - var_representation flag indicating that newlines + var_representation flag indicating that newlines should not be used for whitespace in variable representations. diff --git a/reference/var_representation/functions/var-representation.xml b/reference/var_representation/functions/var-representation.xml index 92dfd18e3..9ce97afc8 100644 --- a/reference/var_representation/functions/var-representation.xml +++ b/reference/var_representation/functions/var-representation.xml @@ -13,7 +13,7 @@ intflags0 - var_representation (from the var_representation PECL) returns a string with structured information about the + var_representation (from the var_representation PECL) returns a string with structured information about the given variable. It is similar to var_export with differences in indentation, string escaping, and array representations. @@ -24,21 +24,21 @@ value - + The variable to generate a representation of. - + flags - + Bitmask consisting of - VAR_REPRESENTATION_SINGLE_LINE, + VAR_REPRESENTATION_SINGLE_LINE, VAR_REPRESENTATION_UNESCAPED. The behaviour of these constants is described on the var_representation constants page. - + @@ -46,9 +46,9 @@ &reftitle.returnvalues; - + Returns the variable representation. - + diff --git a/reference/var_representation/setup.xml b/reference/var_representation/setup.xml index 32ebb0ebb..dd518d1f6 100644 --- a/reference/var_representation/setup.xml +++ b/reference/var_representation/setup.xml @@ -4,16 +4,16 @@
    &reftitle.install; - + &pecl.moved; - - + + &pecl.info; &url.pecl.package;var_representation. - - + + &pecl.windows.download.avail; - +
    diff --git a/reference/varnish/book.xml b/reference/varnish/book.xml index 1d729556d..c97f5ef18 100644 --- a/reference/varnish/book.xml +++ b/reference/varnish/book.xml @@ -8,11 +8,11 @@ &reftitle.intro; - + Varnish Cache is an open source, state of the art web application accelerator. The extension makes it possible to interact with a running varnish instance through TCP socket or shared memory. - + &reference.varnish.setup; diff --git a/reference/varnish/configure.xml b/reference/varnish/configure.xml index 46494e7c2..1b59e674a 100644 --- a/reference/varnish/configure.xml +++ b/reference/varnish/configure.xml @@ -4,12 +4,12 @@
    &reftitle.install; - + &pecl.info; &url.pecl.package;varnish - + + -
    diff --git a/reference/varnish/examples.xml b/reference/varnish/examples.xml index bbdd67e1e..c6dd78992 100644 --- a/reference/varnish/examples.xml +++ b/reference/varnish/examples.xml @@ -4,9 +4,9 @@ &reftitle.examples;
    Basic VarnishAdmin usage - + The example illustrates a simple usage of the ban functionality - + Ban an URL @@ -25,7 +25,7 @@ $va = new VarnishAdmin($args); try { if(!$va->connect()) { throw new VarnishException("Connection failed\n"); - } + } } catch (VarnishException $e) { echo $e->getMessage(); exit(3); @@ -34,7 +34,7 @@ try { try { if(!$va->auth()) { throw new VarnishException("Auth failed\n"); - } + } } catch (VarnishException $e) { echo $e->getMessage(); exit(3); @@ -59,10 +59,10 @@ exit(0);
    Basic VarnishStat usage - + The example illustrates getting varnish statistic snapshot from shared memory - + Get statistic snapshot @@ -86,9 +86,9 @@ exit(0);
    Basic VarnishLog usage - + The example illustrates reading varnish log lines from shared memory - + Read varnish shared memory log diff --git a/reference/varnish/setup.xml b/reference/varnish/setup.xml index f9f705a09..ac87541bb 100644 --- a/reference/varnish/setup.xml +++ b/reference/varnish/setup.xml @@ -6,21 +6,21 @@
    &reftitle.required; - + To use this extension, a version of Varnish Cache greater than or equal to 3.0 is required to be installed, which is available on the Varnish Cache homepage. - +
    &reftitle.install; - + &pecl.moved; - - + + &pecl.info; &url.pecl.package;varnish. - +
    diff --git a/reference/varnish/varnishadmin.xml b/reference/varnish/varnishadmin.xml index 6288354f8..8954d984b 100644 --- a/reference/varnish/varnishadmin.xml +++ b/reference/varnish/varnishadmin.xml @@ -11,9 +11,9 @@
    &reftitle.intro; - + - +
    @@ -31,7 +31,7 @@ - + &Methods; diff --git a/reference/varnish/varnishadmin/auth.xml b/reference/varnish/varnishadmin/auth.xml index ca30da15e..36940f629 100644 --- a/reference/varnish/varnishadmin/auth.xml +++ b/reference/varnish/varnishadmin/auth.xml @@ -13,9 +13,9 @@ public boolVarnishAdmin::auth - + - + @@ -25,9 +25,9 @@ &reftitle.returnvalues; - + &return.success; - + diff --git a/reference/varnish/varnishadmin/ban.xml b/reference/varnish/varnishadmin/ban.xml index 2b37d5f36..93d3ab94e 100644 --- a/reference/varnish/varnishadmin/ban.xml +++ b/reference/varnish/varnishadmin/ban.xml @@ -13,9 +13,9 @@ public intVarnishAdmin::ban stringvcl_regex - + - + @@ -25,9 +25,9 @@ vcl_regex - + Varnish VCL expression. It's based on the varnish ban command. - + @@ -36,9 +36,9 @@ &reftitle.returnvalues; - - Returns the varnish command status. - + + Returns the varnish command status. + diff --git a/reference/varnish/varnishadmin/banurl.xml b/reference/varnish/varnishadmin/banurl.xml index 437db78bb..811db75c4 100644 --- a/reference/varnish/varnishadmin/banurl.xml +++ b/reference/varnish/varnishadmin/banurl.xml @@ -13,9 +13,9 @@ public intVarnishAdmin::banUrl stringvcl_regex - + - + @@ -25,10 +25,10 @@ vcl_regex - + URL regular expression in PCRE compatible syntax. It's based on the ban.url varnish command. - + @@ -37,9 +37,9 @@ &reftitle.returnvalues; - - Returns the varnish command status. - + + Returns the varnish command status. + diff --git a/reference/varnish/varnishadmin/clearpanic.xml b/reference/varnish/varnishadmin/clearpanic.xml index 8fafee346..3b65d7745 100644 --- a/reference/varnish/varnishadmin/clearpanic.xml +++ b/reference/varnish/varnishadmin/clearpanic.xml @@ -13,9 +13,9 @@ public intVarnishAdmin::clearPanic - + - + @@ -25,9 +25,9 @@ &reftitle.returnvalues; - - Returns the varnish command status. - + + Returns the varnish command status. + diff --git a/reference/varnish/varnishadmin/connect.xml b/reference/varnish/varnishadmin/connect.xml index 3462976d1..e83b192be 100644 --- a/reference/varnish/varnishadmin/connect.xml +++ b/reference/varnish/varnishadmin/connect.xml @@ -13,9 +13,9 @@ public boolVarnishAdmin::connect - + - + @@ -25,9 +25,9 @@ &reftitle.returnvalues; - + &return.success; - + diff --git a/reference/varnish/varnishadmin/construct.xml b/reference/varnish/varnishadmin/construct.xml index b2cc38a68..d288ed653 100644 --- a/reference/varnish/varnishadmin/construct.xml +++ b/reference/varnish/varnishadmin/construct.xml @@ -13,9 +13,9 @@ public VarnishAdmin::__construct arrayargs - + - + @@ -24,7 +24,7 @@ args - + Configuration arguments. The possible keys are: - + @@ -42,8 +42,8 @@ VARNISH_CONFIG_COMPAT - varnish major version compatibility &reftitle.returnvalues; - - + + diff --git a/reference/varnish/varnishadmin/disconnect.xml b/reference/varnish/varnishadmin/disconnect.xml index 62b704adf..70f40ea6f 100644 --- a/reference/varnish/varnishadmin/disconnect.xml +++ b/reference/varnish/varnishadmin/disconnect.xml @@ -13,9 +13,9 @@ public boolVarnishAdmin::disconnect - + - + @@ -25,9 +25,9 @@ &reftitle.returnvalues; - + &return.success; - + diff --git a/reference/varnish/varnishadmin/getpanic.xml b/reference/varnish/varnishadmin/getpanic.xml index 1ad6b6b77..88fc25208 100644 --- a/reference/varnish/varnishadmin/getpanic.xml +++ b/reference/varnish/varnishadmin/getpanic.xml @@ -13,23 +13,23 @@ public stringVarnishAdmin::getPanic - + - + &reftitle.parameters; &no.function.parameters; - - + + &reftitle.returnvalues; - + Returns the last panic message on the current varnish instance. - + diff --git a/reference/varnish/varnishadmin/getparams.xml b/reference/varnish/varnishadmin/getparams.xml index a07cee2e2..2ead1ec20 100644 --- a/reference/varnish/varnishadmin/getparams.xml +++ b/reference/varnish/varnishadmin/getparams.xml @@ -13,9 +13,9 @@ public arrayVarnishAdmin::getParams - + - + @@ -25,9 +25,9 @@ &reftitle.returnvalues; - + Returns an array with the varnish configuration parameters. - + diff --git a/reference/varnish/varnishadmin/isrunning.xml b/reference/varnish/varnishadmin/isrunning.xml index 2a88d860f..d87999e50 100644 --- a/reference/varnish/varnishadmin/isrunning.xml +++ b/reference/varnish/varnishadmin/isrunning.xml @@ -13,9 +13,9 @@ public boolVarnishAdmin::isRunning - + - + @@ -25,9 +25,9 @@ &reftitle.returnvalues; - + &return.success; - + diff --git a/reference/varnish/varnishadmin/setcompat.xml b/reference/varnish/varnishadmin/setcompat.xml index 9f47fc8ff..d82e5d686 100644 --- a/reference/varnish/varnishadmin/setcompat.xml +++ b/reference/varnish/varnishadmin/setcompat.xml @@ -13,9 +13,9 @@ public voidVarnishAdmin::setCompat intcompat - + - + @@ -25,9 +25,9 @@ compat - + Varnish compatibility option. - + @@ -36,9 +36,9 @@ &reftitle.returnvalues; - + - + diff --git a/reference/varnish/varnishadmin/sethost.xml b/reference/varnish/varnishadmin/sethost.xml index a72bcaa06..e01ab5a16 100644 --- a/reference/varnish/varnishadmin/sethost.xml +++ b/reference/varnish/varnishadmin/sethost.xml @@ -13,9 +13,9 @@ public voidVarnishAdmin::setHost stringhost - + - + @@ -25,9 +25,9 @@ host - + Connection host configuration parameter. - + @@ -36,9 +36,9 @@ &reftitle.returnvalues; - + - + diff --git a/reference/varnish/varnishadmin/setident.xml b/reference/varnish/varnishadmin/setident.xml index 37b56a3ac..61057eb4d 100644 --- a/reference/varnish/varnishadmin/setident.xml +++ b/reference/varnish/varnishadmin/setident.xml @@ -13,9 +13,9 @@ public voidVarnishAdmin::setIdent stringident - + - + @@ -25,9 +25,9 @@ ident - + Connection ident configuration parameter. - + @@ -36,9 +36,9 @@ &reftitle.returnvalues; - + - + diff --git a/reference/varnish/varnishadmin/setparam.xml b/reference/varnish/varnishadmin/setparam.xml index e3262f8da..996d3295a 100644 --- a/reference/varnish/varnishadmin/setparam.xml +++ b/reference/varnish/varnishadmin/setparam.xml @@ -14,9 +14,9 @@ stringname stringintvalue - + - + @@ -26,17 +26,17 @@ name - + Varnish configuration param name. - + value - + Varnish configuration param value. - + @@ -45,9 +45,9 @@ &reftitle.returnvalues; - + Returns the varnish command status. - + diff --git a/reference/varnish/varnishadmin/setport.xml b/reference/varnish/varnishadmin/setport.xml index b554f92d3..d40b55df0 100644 --- a/reference/varnish/varnishadmin/setport.xml +++ b/reference/varnish/varnishadmin/setport.xml @@ -13,9 +13,9 @@ public voidVarnishAdmin::setPort intport - + - + @@ -25,9 +25,9 @@ port - + Connection port configuration parameter. - + @@ -36,9 +36,9 @@ &reftitle.returnvalues; - + - + diff --git a/reference/varnish/varnishadmin/setsecret.xml b/reference/varnish/varnishadmin/setsecret.xml index ca8311b4c..968933777 100644 --- a/reference/varnish/varnishadmin/setsecret.xml +++ b/reference/varnish/varnishadmin/setsecret.xml @@ -13,9 +13,9 @@ public voidVarnishAdmin::setSecret stringsecret - + - + @@ -25,9 +25,9 @@ secret - + Connection secret configuration parameter. - + @@ -36,9 +36,9 @@ &reftitle.returnvalues; - + - + diff --git a/reference/varnish/varnishadmin/settimeout.xml b/reference/varnish/varnishadmin/settimeout.xml index 6e4df91d7..e9ca699be 100644 --- a/reference/varnish/varnishadmin/settimeout.xml +++ b/reference/varnish/varnishadmin/settimeout.xml @@ -13,9 +13,9 @@ public voidVarnishAdmin::setTimeout inttimeout - + - + @@ -25,9 +25,9 @@ timeout - + Connection timeout configuration parameter. - + @@ -36,9 +36,9 @@ &reftitle.returnvalues; - + - + diff --git a/reference/varnish/varnishadmin/start.xml b/reference/varnish/varnishadmin/start.xml index 4e7ae0473..5d7f3d540 100644 --- a/reference/varnish/varnishadmin/start.xml +++ b/reference/varnish/varnishadmin/start.xml @@ -13,9 +13,9 @@ public intVarnishAdmin::start - + - + @@ -25,9 +25,9 @@ &reftitle.returnvalues; - + Returns the varnish command status. - + diff --git a/reference/varnish/varnishadmin/stop.xml b/reference/varnish/varnishadmin/stop.xml index 73b131b0e..365e58532 100644 --- a/reference/varnish/varnishadmin/stop.xml +++ b/reference/varnish/varnishadmin/stop.xml @@ -13,9 +13,9 @@ public intVarnishAdmin::stop - + - + @@ -25,9 +25,9 @@ &reftitle.returnvalues; - + Returns the varnish command status. - + diff --git a/reference/varnish/varnishexception.xml b/reference/varnish/varnishexception.xml index 008f90297..5649f497c 100644 --- a/reference/varnish/varnishexception.xml +++ b/reference/varnish/varnishexception.xml @@ -11,9 +11,9 @@
    &reftitle.intro; - + - +
    @@ -29,7 +29,7 @@ VarnishException - + extends Exception @@ -38,7 +38,7 @@ &InheritedProperties; - + &InheritedMethods; @@ -47,7 +47,7 @@
    - + diff --git a/reference/varnish/varnishlog.xml b/reference/varnish/varnishlog.xml index 04aa68e21..f6b01aae5 100644 --- a/reference/varnish/varnishlog.xml +++ b/reference/varnish/varnishlog.xml @@ -11,9 +11,9 @@
    &reftitle.intro; - + - +
    @@ -360,364 +360,364 @@ VarnishLog::TAG_Debug - + VarnishLog::TAG_Error - + VarnishLog::TAG_CLI - + VarnishLog::TAG_StatSess - + VarnishLog::TAG_ReqEnd - + VarnishLog::TAG_SessionOpen - + VarnishLog::TAG_SessionClose - + VarnishLog::TAG_BackendOpen - + VarnishLog::TAG_BackendXID - + VarnishLog::TAG_BackendReuse - + VarnishLog::TAG_BackendClose - + VarnishLog::TAG_HttpGarbage - + VarnishLog::TAG_Backend - + VarnishLog::TAG_Length - + VarnishLog::TAG_FetchError - + VarnishLog::TAG_RxRequest - + VarnishLog::TAG_RxResponse - + VarnishLog::TAG_RxStatus - + VarnishLog::TAG_RxURL - + VarnishLog::TAG_RxProtocol - + VarnishLog::TAG_RxHeader - + VarnishLog::TAG_TxRequest - + VarnishLog::TAG_TxResponse - + VarnishLog::TAG_TxStatus - + VarnishLog::TAG_TxURL - + VarnishLog::TAG_TxProtocol - + VarnishLog::TAG_TxHeader - + VarnishLog::TAG_ObjRequest - + VarnishLog::TAG_ObjResponse - + VarnishLog::TAG_ObjStatus - + VarnishLog::TAG_ObjURL - + VarnishLog::TAG_ObjProtocol - + VarnishLog::TAG_ObjHeader - + VarnishLog::TAG_LostHeader - + VarnishLog::TAG_TTL - + VarnishLog::TAG_Fetch_Body - + VarnishLog::TAG_VCL_acl - + VarnishLog::TAG_VCL_call - + VarnishLog::TAG_VCL_trace - + VarnishLog::TAG_VCL_return - + VarnishLog::TAG_VCL_error - + VarnishLog::TAG_ReqStart - + VarnishLog::TAG_Hit - + VarnishLog::TAG_HitPass - + VarnishLog::TAG_ExpBan - + VarnishLog::TAG_ExpKill - + VarnishLog::TAG_WorkThread - + VarnishLog::TAG_ESI_xmlerror - + VarnishLog::TAG_Hash - + VarnishLog::TAG_Backend_health - + VarnishLog::TAG_VCL_Log - + VarnishLog::TAG_Gzip - + diff --git a/reference/varnish/varnishlog/construct.xml b/reference/varnish/varnishlog/construct.xml index dd03cc1ab..4b31dfa69 100644 --- a/reference/varnish/varnishlog/construct.xml +++ b/reference/varnish/varnishlog/construct.xml @@ -13,9 +13,9 @@ public VarnishLog::__construct arrayargs - + - +     @@ -24,12 +24,12 @@ args - + Configuration arguments. The possible keys are: - + @@ -37,9 +37,9 @@ VARNISH_CONFIG_IDENT - local varnish instance ident path &reftitle.returnvalues; - + - + diff --git a/reference/varnish/varnishlog/getline.xml b/reference/varnish/varnishlog/getline.xml index 34c26da02..0c12a0154 100644 --- a/reference/varnish/varnishlog/getline.xml +++ b/reference/varnish/varnishlog/getline.xml @@ -13,9 +13,9 @@ public arrayVarnishLog::getLine - + - + @@ -25,9 +25,9 @@ &reftitle.returnvalues; - + Returns an array with the log line data. - + diff --git a/reference/varnish/varnishlog/gettagname.xml b/reference/varnish/varnishlog/gettagname.xml index 6a7e351c9..2fc26135f 100644 --- a/reference/varnish/varnishlog/gettagname.xml +++ b/reference/varnish/varnishlog/gettagname.xml @@ -13,9 +13,9 @@ public static stringVarnishLog::getTagName intindex - + - + @@ -25,9 +25,9 @@ index - + Log tag index. - + @@ -36,9 +36,9 @@ &reftitle.returnvalues; - + Returns the log tag name as &string;. - + diff --git a/reference/varnish/varnishstat.xml b/reference/varnish/varnishstat.xml index d6ce39da0..6687c97fe 100644 --- a/reference/varnish/varnishstat.xml +++ b/reference/varnish/varnishstat.xml @@ -11,9 +11,9 @@
    &reftitle.intro; - + - +
    @@ -31,7 +31,7 @@ - + &Methods; diff --git a/reference/varnish/varnishstat/construct.xml b/reference/varnish/varnishstat/construct.xml index a350dab9b..7a36634a5 100644 --- a/reference/varnish/varnishstat/construct.xml +++ b/reference/varnish/varnishstat/construct.xml @@ -13,9 +13,9 @@ public VarnishStat::__construct arrayargs - + - +     @@ -24,12 +24,12 @@ args - + Configuration arguments. The possible keys are: - + @@ -37,9 +37,9 @@ VARNISH_CONFIG_IDENT - local varnish instance ident path &reftitle.returnvalues; - + - + diff --git a/reference/varnish/varnishstat/getsnapshot.xml b/reference/varnish/varnishstat/getsnapshot.xml index 34bd7028d..64be3e6b6 100644 --- a/reference/varnish/varnishstat/getsnapshot.xml +++ b/reference/varnish/varnishstat/getsnapshot.xml @@ -13,9 +13,9 @@ public arrayVarnishStat::getSnapshot - + - + @@ -25,10 +25,10 @@ &reftitle.returnvalues; - + Array with the varnish statistic snapshot. The array keys are identical to that in the varnishstat tool. - + diff --git a/reference/wddx/book.xml b/reference/wddx/book.xml index a28344adf..1fa988617 100644 --- a/reference/wddx/book.xml +++ b/reference/wddx/book.xml @@ -12,19 +12,19 @@ This extension is DEPRECATED and UNBUNDLED as of PHP 7.4.0. - + These functions are intended for work with WDDX. - + - + Do not pass untrusted user input to wddx_deserialize. Unserialization can result in code being loaded and executed due to object instantiation and autoloading, and a malicious user may be able to exploit this. Use a safe, standard data interchange format such as JSON (via json_decode and json_encode) if you need to pass serialized data to the user. - + diff --git a/reference/wddx/configure.xml b/reference/wddx/configure.xml index 8e8a0648f..1d91ce5c7 100644 --- a/reference/wddx/configure.xml +++ b/reference/wddx/configure.xml @@ -5,22 +5,22 @@
    PHP 7.4 - + &pecl.moved-ver;7.4.0 - - + + &pecl.info; &url.pecl.package;wddx. - +
    PHP < 7.4 - + After installing the required expat library, compile PHP with , and use for expat. - + &windows.builtin;
    diff --git a/reference/wddx/examples.xml b/reference/wddx/examples.xml index 8a595728a..5ce6836d3 100644 --- a/reference/wddx/examples.xml +++ b/reference/wddx/examples.xml @@ -5,14 +5,14 @@ &reftitle.examples;
    wddx examples - + All the functions that serialize variables use the first element of an array to determine whether the array is to be serialized into an array or structure. If the first element has string key, then it is serialized into a structure, otherwise, into an array. - - + + Serializing a single value with WDDX @@ -22,9 +22,9 @@ echo wddx_serialize_value("PHP to WDDX packet example", "PHP packet"); ?> ]]> - + This example will produce: - +
    @@ -51,9 +51,9 @@ echo $packet; ?> ]]> - + This example will produce: - +
    @@ -65,11 +65,11 @@ echo $packet; - + Strings should be encoded in UTF-8; to handle other encodings, convert the string first using mb_convert_encoding, UConverter::transcode, or iconv. - +
    diff --git a/reference/wddx/functions/wddx-add-vars.xml b/reference/wddx/functions/wddx-add-vars.xml index 6e935507b..cfc030f5d 100644 --- a/reference/wddx/functions/wddx-add-vars.xml +++ b/reference/wddx/functions/wddx-add-vars.xml @@ -5,7 +5,7 @@ wddx_add_vars Add variables to a WDDX packet with the specified ID - + &warn.removed.function-7-4-0; @@ -18,9 +18,9 @@ mixedvar_name mixedvar_names - + Serializes the passed variables and add the result to the given packet. - +     @@ -31,25 +31,25 @@ packet_id - + A WDDX packet, returned by wddx_packet_start. - + var_name - + Can be either a string naming a variable or an array containing strings naming the variables or another array, etc. - + var_names - - + + @@ -58,9 +58,9 @@ &reftitle.returnvalues; - + &return.success; - + diff --git a/reference/wddx/functions/wddx-deserialize.xml b/reference/wddx/functions/wddx-deserialize.xml index 79b516f4c..b15b18419 100644 --- a/reference/wddx/functions/wddx-deserialize.xml +++ b/reference/wddx/functions/wddx-deserialize.xml @@ -5,7 +5,7 @@ wddx_deserialize Unserializes a WDDX packet - + &warn.removed.function-7-4-0; @@ -16,18 +16,18 @@ mixedwddx_deserialize stringpacket - + Unserializes a WDDX packet. - + - + Do not pass untrusted user input to wddx_deserialize. Unserialization can result in code being loaded and executed due to object instantiation and autoloading, and a malicious user may be able to exploit this. Use a safe, standard data interchange format such as JSON (via json_decode and json_encode) if you need to pass serialized data to the user. - + @@ -38,9 +38,9 @@ packet - + A WDDX packet, as a string or stream. - + @@ -49,10 +49,10 @@ &reftitle.returnvalues; - + Returns the deserialized value which can be a string, a number or an array. Note that structures are deserialized into associative arrays. - + diff --git a/reference/wddx/functions/wddx-packet-end.xml b/reference/wddx/functions/wddx-packet-end.xml index 6b82bde96..d750175a1 100644 --- a/reference/wddx/functions/wddx-packet-end.xml +++ b/reference/wddx/functions/wddx-packet-end.xml @@ -5,7 +5,7 @@ wddx_packet_end Ends a WDDX packet with the specified ID - + &warn.removed.function-7-4-0; @@ -16,9 +16,9 @@ stringwddx_packet_end resourcepacket_id - + Ends and returns the given WDDX packet. - +     @@ -28,9 +28,9 @@ packet_id - + A WDDX packet, returned by wddx_packet_start. - + @@ -39,9 +39,9 @@ &reftitle.returnvalues; - + Returns the string containing the WDDX packet. - + diff --git a/reference/wddx/functions/wddx-packet-start.xml b/reference/wddx/functions/wddx-packet-start.xml index d79b2df42..01b2bed37 100644 --- a/reference/wddx/functions/wddx-packet-start.xml +++ b/reference/wddx/functions/wddx-packet-start.xml @@ -5,7 +5,7 @@ wddx_packet_start Starts a new WDDX packet with structure inside it - + &warn.removed.function-7-4-0; @@ -16,11 +16,11 @@ resourcewddx_packet_start stringcomment - + Start a new WDDX packet for incremental addition of variables. It automatically creates a structure definition inside the packet to contain the variables. - + @@ -30,9 +30,9 @@ comment - + An optional comment string. - + @@ -41,9 +41,9 @@ &reftitle.returnvalues; - + Returns a packet ID for use in later functions, or &false; on error. - + diff --git a/reference/wddx/functions/wddx-serialize-value.xml b/reference/wddx/functions/wddx-serialize-value.xml index 9162ef7f2..4a23f60c2 100644 --- a/reference/wddx/functions/wddx-serialize-value.xml +++ b/reference/wddx/functions/wddx-serialize-value.xml @@ -5,7 +5,7 @@ wddx_serialize_value Serialize a single value into a WDDX packet - + &warn.removed.function-7-4-0; @@ -17,9 +17,9 @@ mixedvar stringcomment - + Creates a WDDX packet from a single given value. - + @@ -29,17 +29,17 @@ var - + The value to be serialized - + comment - + An optional comment string that appears in the packet header. - + @@ -48,9 +48,9 @@ &reftitle.returnvalues; - + Returns the WDDX packet, or &false; on error. - + diff --git a/reference/wddx/functions/wddx-serialize-vars.xml b/reference/wddx/functions/wddx-serialize-vars.xml index fb5d2d90c..3f6c280b9 100644 --- a/reference/wddx/functions/wddx-serialize-vars.xml +++ b/reference/wddx/functions/wddx-serialize-vars.xml @@ -5,7 +5,7 @@ wddx_serialize_vars Serialize variables into a WDDX packet - + &warn.removed.function-7-4-0; @@ -17,10 +17,10 @@ mixedvar_name mixedvar_names - + Creates a WDDX packet with a structure that contains the serialized representation of the passed variables. - + @@ -31,17 +31,17 @@ var_name - + Can be either a string naming a variable or an array containing strings naming the variables or another array, etc. - + var_names - - + + @@ -50,9 +50,9 @@ &reftitle.returnvalues; - + Returns the WDDX packet, or &false; on error. - + diff --git a/reference/wddx/setup.xml b/reference/wddx/setup.xml index 1362f52ca..f43c7e45c 100644 --- a/reference/wddx/setup.xml +++ b/reference/wddx/setup.xml @@ -8,10 +8,10 @@
    &reftitle.required; &libxml.required; - + In order to use WDDX, you will need to install the expat library (which comes with Apache 1.3.7 or higher). - +
    @@ -22,10 +22,10 @@
    &reftitle.resources; - + This extension defines a WDDX packet identifier returned by wddx_packet_start. - +
    diff --git a/reference/win32service/book.xml b/reference/win32service/book.xml index 6037111ed..fddf94c33 100644 --- a/reference/win32service/book.xml +++ b/reference/win32service/book.xml @@ -1,22 +1,22 @@ - + win32service - + &reftitle.intro; - + The win32service extension is a Windows specific extension that allows PHP to communicate with the Service Control Manager to start, stop, register and unregister services, and even allows your PHP scripts to run as a service. - + - + &reference.win32service.setup; &reference.win32service.constants; &reference.win32service.win32serviceexception; diff --git a/reference/win32service/constants.xml b/reference/win32service/constants.xml index 7748b04af..57627f5f6 100644 --- a/reference/win32service/constants.xml +++ b/reference/win32service/constants.xml @@ -243,8 +243,8 @@ 0x00000020 The service is notified when the computer's hardware profile has changed. - This enables the system to send - WIN32_SERVICE_CONTROL_HARDWAREPROFILECHANGE + This enables the system to send + WIN32_SERVICE_CONTROL_HARDWAREPROFILECHANGE notifications to the service. @@ -252,12 +252,12 @@ WIN32_SERVICE_ACCEPT_NETBINDCHANGE 0x00000010 - The service is a network component that can accept changes in its + The service is a network component that can accept changes in its binding without being stopped and restarted. - This control code allows the service to receive - WIN32_SERVICE_CONTROL_NETBINDADD, - WIN32_SERVICE_CONTROL_NETBINDREMOVE, - WIN32_SERVICE_CONTROL_NETBINDENABLE, and + This control code allows the service to receive + WIN32_SERVICE_CONTROL_NETBINDADD, + WIN32_SERVICE_CONTROL_NETBINDREMOVE, + WIN32_SERVICE_CONTROL_NETBINDENABLE, and WIN32_SERVICE_CONTROL_NETBINDDISABLE notifications. @@ -266,7 +266,7 @@ 0x00000008 The service can reread its startup parameters without being stopped and restarted. - This control code allows the service to receive + This control code allows the service to receive WIN32_SERVICE_CONTROL_PARAMCHANGE notifications. @@ -284,8 +284,8 @@ 0x00000040 The service is notified when the computer's power status has changed. - This enables the system to send - WIN32_SERVICE_CONTROL_POWEREVENT notifications + This enables the system to send + WIN32_SERVICE_CONTROL_POWEREVENT notifications to the service. @@ -304,8 +304,8 @@ 0x00000080 The service is notified when the computer's session status has changed. - This enables the system to send - WIN32_SERVICE_CONTROL_SESSIONCHANGE notifications + This enables the system to send + WIN32_SERVICE_CONTROL_SESSIONCHANGE notifications to the service. Windows 2000: This value is not supported @@ -332,9 +332,9 @@ 0x00000200 The service is notified when the system time has changed. - This enables the system to send + This enables the system to send WIN32_SERVICE_CONTROL_TIMECHANGE notifications to the service. - Windows Server 2008, Windows Vista, Windows Server 2003, + Windows Server 2008, Windows Vista, Windows Server 2003, and Windows XP/2000: This control code is not supported. @@ -343,9 +343,9 @@ 0x00000400 The service is notified when an event for which the service has registered occurs. - This enables the system to send + This enables the system to send WIN32_SERVICE_CONTROL_TRIGGEREVENT notifications to the service. - Windows Server 2008, Windows Vista, Windows Server 2003, + Windows Server 2008, Windows Vista, Windows Server 2003, and Windows XP/2000: This control code is not supported. @@ -437,8 +437,8 @@ 0x00000002 The startup program logs the error in the event log. - If the last-known-good configuration is being started, the startup - operation continues. Otherwise, the system is restarted with the + If the last-known-good configuration is being started, the startup + operation continues. Otherwise, the system is restarted with the last-known-good configuration. @@ -447,8 +447,8 @@ 0x00000003 The startup program logs the error in the event log, if possible. - If the last-known-good configuration is being started, the startup - operation fails. Otherwise, the system is restarted with the + If the last-known-good configuration is being started, the startup + operation fails. Otherwise, the system is restarted with the last-known good configuration. @@ -479,9 +479,9 @@
    - + These constants are no longer in use as of Win32Service 1.0.0. - + Win32 Error Codes diff --git a/reference/win32service/functions/win32-add-right-access-service.xml b/reference/win32service/functions/win32-add-right-access-service.xml index e84d0afc7..3aa55e3f9 100644 --- a/reference/win32service/functions/win32-add-right-access-service.xml +++ b/reference/win32service/functions/win32-add-right-access-service.xml @@ -16,10 +16,10 @@ intrightstringmachine&null; - + Add the rights access for username on servicename service. Administrative privileges are required for this to succeed. - + @@ -29,35 +29,35 @@ servicename - + The service name to add rights access. - + username - + Read the rights access for username. - + right - + The rights allowed for username. The service rights constants can be used to define this value. - + machine - + The optional machine name on which you want to create a service. If omitted, it will use the local machine. - + @@ -66,24 +66,24 @@ &reftitle.returnvalues; - + Return a Win32Service\RightInfo object. - + &reftitle.errors; - - A ValueError is thrown if the + + A ValueError is thrown if the value of service parameter is empty. - - - A ValueError is thrown if the + + + A ValueError is thrown if the value of username parameter is empty. - - - A Win32ServiceException is thrown on error. - + + + A Win32ServiceException is thrown on error. + diff --git a/reference/win32service/functions/win32-add-service-env-var.xml b/reference/win32service/functions/win32-add-service-env-var.xml index 7e74e366a..be2157a24 100644 --- a/reference/win32service/functions/win32-add-service-env-var.xml +++ b/reference/win32service/functions/win32-add-service-env-var.xml @@ -15,10 +15,10 @@ stringvarname stringvalue - + Add a custom environment variables varname on servicename service. This function work only for the local computer. Administrative privileges are required for this to succeed. - + @@ -28,25 +28,25 @@ servicename - + The service name to add environment variable. - + varname - + The environment variable name. - + value - + The environment variable value. - + @@ -55,24 +55,24 @@ &reftitle.returnvalues; - + &return.void; - + &reftitle.errors; - - A ValueError is thrown if the + + A ValueError is thrown if the value of service parameter is empty. - - - A ValueError is thrown if the + + + A ValueError is thrown if the value of varname parameter is empty. - - - A Win32ServiceException is thrown on error. - + + + A Win32ServiceException is thrown on error. + diff --git a/reference/win32service/functions/win32-continue-service.xml b/reference/win32service/functions/win32-continue-service.xml index 1cbe70a50..0c25803a7 100644 --- a/reference/win32service/functions/win32-continue-service.xml +++ b/reference/win32service/functions/win32-continue-service.xml @@ -13,12 +13,12 @@ stringservicename stringmachine&null; - - - Resumes a paused, named service. Requires administrative privileges or + + + Resumes a paused, named service. Requires administrative privileges or an account with appropriate rights set in the service's ACL. - - + + &reftitle.parameters; @@ -27,42 +27,42 @@ servicename - + The short name of the service. - + machine - + Optional machine name. If omitted, the local machine is used. - + - + &reftitle.returnvalues; - + &return.void; - - + + Prior to version 1.0.0, &win32service.noerror.false.error; - + &reftitle.errors; - - A ValueError is thrown if the + + A ValueError is thrown if the value of servicename parameter is empty. - - - A Win32ServiceException is thrown on error. - + + + A Win32ServiceException is thrown on error. + @@ -80,15 +80,15 @@ PECL win32service 1.0.0 - Throws a ValueError on invalid data in parameters, + Throws a ValueError on invalid data in parameters, previously &false; was returned. PECL win32service 1.0.0 - Throws a Win32ServiceException on error, - previously a + Throws a Win32ServiceException on error, + previously a Win32 Error Code was returned. @@ -110,7 +110,7 @@ - + &reftitle.seealso; @@ -123,7 +123,7 @@ - + &reftitle.errors; - - A ValueError is thrown if the + + A ValueError is thrown if the value of servicename parameter is empty. - + - - A Win32ServiceException is thrown on error. - + + A Win32ServiceException is thrown on error. + @@ -82,15 +82,15 @@ PECL win32service 1.0.0 - Throws a ValueError on invalid data in parameters, + Throws a ValueError on invalid data in parameters, previously &false; was returned. PECL win32service 1.0.0 - Throws a Win32ServiceException on error, - previously a + Throws a Win32ServiceException on error, + previously a Win32 Error Code was returned. @@ -112,7 +112,7 @@ - + &reftitle.seealso; diff --git a/reference/win32service/functions/win32-query-service-status.xml b/reference/win32service/functions/win32-query-service-status.xml index 1a58ac640..4b6498e66 100644 --- a/reference/win32service/functions/win32-query-service-status.xml +++ b/reference/win32service/functions/win32-query-service-status.xml @@ -14,10 +14,10 @@ stringmachine&null; - + Queries the current status for a service, returning an array of information. - + @@ -27,17 +27,17 @@ servicename - + The short name of the service. - + machine - + The optional machine name. If omitted, the local machine will be used. - + @@ -46,46 +46,46 @@ &reftitle.returnvalues; - + Returns an array consisting of the following information on success - - + + Prior version 1.0.0&win32service.false.error; - + ServiceType - + The dwServiceType. See Win32Service Service Type Bitmasks. - + CurrentState - + The dwCurrentState. See Win32Service Service Status Constants. - + ControlsAccepted - + Which service controls are accepted by the service. See Win32Service Service Control Message Accepted Bitmasks. - + Win32ExitCode - If the service exited, the return code from the process. This value is equal to - WIN32_ERROR_SERVICE_SPECIFIC_ERROR + If the service exited, the return code from the process. This value is equal to + WIN32_ERROR_SERVICE_SPECIFIC_ERROR if the exit mode is not graceful. See - Win32Service error codes and + Win32Service error codes and win32_set_service_exit_mode @@ -93,48 +93,48 @@ ServiceSpecificExitCode - + If the service exited with an error condition, the service specific - code that is logged in the event log is visible here. This value is equal + code that is logged in the event log is visible here. This value is equal to the value defined by win32_set_service_exit_code - + CheckPoint - + If the service is shutting down, holds the current check point number. This is used by the SCM as a kind of heart-beat to detect a wedged service process. The value of the check point is best interpreted in conjunction with the WaitHint value. - + WaitHint - + If the service is shutting down it will set WaitHint to a checkpoint value that will indicate 100% completion. This can be used to implement a progress indicator. - + ProcessId - + The Windows process identifier. If 0, the process is not running. - + ServiceFlags - + The dwServiceFlags. See Win32Service Service Flag Constants. - + @@ -145,10 +145,10 @@ &reftitle.errors; - - A ValueError is thrown if the + + A ValueError is thrown if the value of servicename parameter is empty. - + @@ -166,15 +166,15 @@ PECL win32service 1.0.0 - Throws a ValueError on invalid data in parameters, + Throws a ValueError on invalid data in parameters, previously &false; was returned. PECL win32service 1.0.0 - Throws a Win32ServiceException on error, - previously a + Throws a Win32ServiceException on error, + previously a Win32 Error Code was returned. diff --git a/reference/win32service/functions/win32-read-all-rights-access-service.xml b/reference/win32service/functions/win32-read-all-rights-access-service.xml index 07681a7d3..6c11621ed 100644 --- a/reference/win32service/functions/win32-read-all-rights-access-service.xml +++ b/reference/win32service/functions/win32-read-all-rights-access-service.xml @@ -14,10 +14,10 @@ stringservicename stringmachine&null; - + Read all rights access on servicename service. Administrative privileges are required for this to succeed. - + @@ -27,18 +27,18 @@ servicename - + The service name to read rights access. - + machine - + The optional machine name on which you want to create a service. If omitted, it will use the local machine. - + @@ -47,20 +47,20 @@ &reftitle.returnvalues; - + Return an &array; of Win32Service\RightInfo - + &reftitle.errors; - - A ValueError is thrown if the + + A ValueError is thrown if the value of service parameter is empty. - - - A Win32ServiceException is thrown on error. - + + + A Win32ServiceException is thrown on error. + diff --git a/reference/win32service/functions/win32-read-right-access-service.xml b/reference/win32service/functions/win32-read-right-access-service.xml index 23da1a35d..fb380a5cb 100644 --- a/reference/win32service/functions/win32-read-right-access-service.xml +++ b/reference/win32service/functions/win32-read-right-access-service.xml @@ -15,10 +15,10 @@ stringusername stringmachine&null; - + Read the rights access for username on servicename service. Administrative privileges are required for this to succeed. - + @@ -28,26 +28,26 @@ servicename - + The service name to read rights access. - + username - + Read the rights access for username - + machine - + The optional machine name on which you want to create a service. If omitted, it will use the local machine. - + @@ -56,24 +56,24 @@ &reftitle.returnvalues; - + Return a Win32Service\RightInfo object. - + &reftitle.errors; - - A ValueError is thrown if the + + A ValueError is thrown if the value of service parameter is empty. - - - A ValueError is thrown if the + + + A ValueError is thrown if the value of username parameter is empty. - - - A Win32ServiceException is thrown on error. - + + + A Win32ServiceException is thrown on error. + diff --git a/reference/win32service/functions/win32-remove-right-access-service.xml b/reference/win32service/functions/win32-remove-right-access-service.xml index cf1fc520f..b435d9bd4 100644 --- a/reference/win32service/functions/win32-remove-right-access-service.xml +++ b/reference/win32service/functions/win32-remove-right-access-service.xml @@ -15,10 +15,10 @@ stringusername stringmachine&null; - + Remove the rights access for username on servicename service. Administrative privileges are required for this to succeed. - + @@ -28,26 +28,26 @@ servicename - + The service name to remove rights access. - + username - + Read the rights access for username. - + machine - + The optional machine name on which you want to create a service. If omitted, it will use the local machine. - + @@ -56,24 +56,24 @@ &reftitle.returnvalues; - + &return.void; - + &reftitle.errors; - - A ValueError is thrown if the + + A ValueError is thrown if the value of service parameter is empty. - - - A ValueError is thrown if the + + + A ValueError is thrown if the value of username parameter is empty. - - - A Win32ServiceException is thrown on error. - + + + A Win32ServiceException is thrown on error. + diff --git a/reference/win32service/functions/win32-remove-service-env-var.xml b/reference/win32service/functions/win32-remove-service-env-var.xml index 459feecd5..43b34d271 100644 --- a/reference/win32service/functions/win32-remove-service-env-var.xml +++ b/reference/win32service/functions/win32-remove-service-env-var.xml @@ -14,10 +14,10 @@ stringservicename stringvarname - + Remove a custom environment variables varname on servicename service. This function work only for the local computer. Administrative privileges are required for this to succeed. - + @@ -27,17 +27,17 @@ servicename - + The service name to remove environment variable. - + varname - + The environment variable name. - + @@ -46,24 +46,24 @@ &reftitle.returnvalues; - + &return.void; - + &reftitle.errors; - - A ValueError is thrown if the + + A ValueError is thrown if the value of service parameter is empty. - - - A ValueError is thrown if the + + + A ValueError is thrown if the value of varname parameter is empty. - - - A Win32ServiceException is thrown on error. - + + + A Win32ServiceException is thrown on error. + diff --git a/reference/win32service/functions/win32-send-custom-control.xml b/reference/win32service/functions/win32-send-custom-control.xml index c86677f54..309ce671d 100644 --- a/reference/win32service/functions/win32-send-custom-control.xml +++ b/reference/win32service/functions/win32-send-custom-control.xml @@ -15,11 +15,11 @@ intcontrol stringmachine&null; - - + + See Microsoft ControlService function for more details - - + + @@ -28,25 +28,25 @@ servicename - + The short name of the service. - + control - + The custom contole value between 128 and 255. - + machine - + Optional machine name. If omitted, the local machine is used. - + @@ -54,31 +54,31 @@ &reftitle.returnvalues; - + &return.void; - - + + Prior to version 1.0.0, &win32service.noerror.false.error; - + &reftitle.errors; - + Prior to version 1.0.0, if the control value is not between 128 and 255, this function emits an E_ERROR level error. - - - A ValueError is thrown if the + + + A ValueError is thrown if the value of servicename parameter is empty. - - - A ValueError is thrown if the + + + A ValueError is thrown if the value of control parameter is not between 128 and 255. - - - A Win32ServiceException is thrown on error. - + + + A Win32ServiceException is thrown on error. + @@ -96,15 +96,15 @@ PECL win32service 1.0.0 - Throws a ValueError on invalid data in parameters, + Throws a ValueError on invalid data in parameters, previously &false; was returned. PECL win32service 1.0.0 - Throws a Win32ServiceException on error, - previously a + Throws a Win32ServiceException on error, + previously a Win32 Error Code was returned. diff --git a/reference/win32service/functions/win32-set-service-exit-code.xml b/reference/win32service/functions/win32-set-service-exit-code.xml index 166be1209..21d0bf825 100644 --- a/reference/win32service/functions/win32-set-service-exit-code.xml +++ b/reference/win32service/functions/win32-set-service-exit-code.xml @@ -13,19 +13,19 @@ intwin32_set_service_exit_code intexitCode1 - - Change or return the exit code. The exit code is used only if the exit mode is not graceful. - If the value is not zero, the recovery configuration can be used after - service fail. See - Microsoft system error codes + + Change or return the exit code. The exit code is used only if the exit mode is not graceful. + If the value is not zero, the recovery configuration can be used after + service fail. See + Microsoft system error codes for more details - - + + - - This function work only in "cli" SAPI. On other SAPI + + This function work only in "cli" SAPI. On other SAPI this function is disabled. - + @@ -35,9 +35,9 @@ exitCode - + The return code used on exit. - + @@ -45,22 +45,22 @@ &reftitle.returnvalues; - + Return the current or old exit code. - + &reftitle.errors; - + Prior to version 1.0.0, if the SAPI is not "cli", this function emits an E_ERROR level error. - - - As of version 1.0.0, will throw a - Win32ServiceException if SAPI is not + + + As of version 1.0.0, will throw a + Win32ServiceException if SAPI is not "cli" - + @@ -78,15 +78,15 @@ PECL win32service 1.0.0 - Throws a ValueError on invalid data in parameters, + Throws a ValueError on invalid data in parameters, previously &false; was returned. PECL win32service 1.0.0 - Throws a Win32ServiceException on error, - previously a + Throws a Win32ServiceException on error, + previously a Win32 Error Code was returned. diff --git a/reference/win32service/functions/win32-set-service-exit-mode.xml b/reference/win32service/functions/win32-set-service-exit-mode.xml index 2618d713f..be4fffadd 100644 --- a/reference/win32service/functions/win32-set-service-exit-mode.xml +++ b/reference/win32service/functions/win32-set-service-exit-mode.xml @@ -14,16 +14,16 @@ boolgracefulModetrue - If gracefulMode parameter is provided, the exit mode + If gracefulMode parameter is provided, the exit mode is changed. When the exit mode is not graceful, the exit code used can be set with the win32_set_service_exit_code function. - + - - This function work only in "cli" SAPI. On other SAPI + + This function work only in "cli" SAPI. On other SAPI this function is disabled. - + @@ -33,9 +33,9 @@ with the win32_set_service_exit_code function. gracefulMode - + &true; for exit graceful. &false; for exit with error. - + @@ -43,23 +43,23 @@ with the win32_set_service_exit_code function. &reftitle.returnvalues; - + Return the current or old exit mode. - + &reftitle.errors; - + Prior to version 1.0.0, if the SAPI is not "cli", this function emits an E_ERROR level error. - + - - As of version 1.0.0, will throw a - Win32ServiceException if SAPI is not + + As of version 1.0.0, will throw a + Win32ServiceException if SAPI is not "cli" - + @@ -78,15 +78,15 @@ with the win32_set_service_exit_code function. PECL win32service 1.0.0 - Throws a ValueError on invalid data in parameters, + Throws a ValueError on invalid data in parameters, previously &false; was returned. PECL win32service 1.0.0 - Throws a Win32ServiceException on error, - previously a + Throws a Win32ServiceException on error, + previously a Win32 Error Code was returned. diff --git a/reference/win32service/functions/win32-set-service-pause-resume-state.xml b/reference/win32service/functions/win32-set-service-pause-resume-state.xml index 5d31e740c..2ef14941e 100644 --- a/reference/win32service/functions/win32-set-service-pause-resume-state.xml +++ b/reference/win32service/functions/win32-set-service-pause-resume-state.xml @@ -13,16 +13,16 @@ boolwin32_set_service_pause_resume_state boolstatetrue - + If state parameter is provided, the pause/resume capability is changed. - + - + This function work only in "cli" SAPI and in the Windows service running context. On other SAPI this function is disabled. - + @@ -32,9 +32,9 @@ is changed. state - + &true; for enable the service pause/resume capability. &false; for disable the service pause/resume capability. - + @@ -42,23 +42,23 @@ is changed. &reftitle.returnvalues; - + Return the current or old pause/resume capability state. - + &reftitle.errors; - + Prior to version 1.0.0, if the SAPI is not "cli", this function emits an E_ERROR level error. - + - + As of version 1.0.0, will throw a - Win32ServiceException if SAPI is not + Win32ServiceException if SAPI is not "cli" - + @@ -77,14 +77,14 @@ is changed. PECL win32service 1.0.0 - Throws a ValueError on invalid data in parameters, + Throws a ValueError on invalid data in parameters, previously &false; was returned. PECL win32service 1.0.0 - Throws a Win32ServiceException on error, + Throws a Win32ServiceException on error, previously a Win32 Error Code was returned. diff --git a/reference/win32service/functions/win32-set-service-status.xml b/reference/win32service/functions/win32-set-service-status.xml index 99b3151d1..1a575e8c6 100644 --- a/reference/win32service/functions/win32-set-service-status.xml +++ b/reference/win32service/functions/win32-set-service-status.xml @@ -13,16 +13,16 @@ intstatus intcheckpoint0 - + Informs the SCM of the current status of a running service. This call is only valid for a running service process. - - + + - - Since version 0.2.0, this function work only in "cli" SAPI. On other SAPI + + Since version 0.2.0, this function work only in "cli" SAPI. On other SAPI this function is disabled. - + @@ -33,7 +33,7 @@ status - + The service status code, one of WIN32_SERVICE_RUNNING, WIN32_SERVICE_STOPPED, @@ -42,26 +42,26 @@ WIN32_SERVICE_CONTINUE_PENDING, WIN32_SERVICE_PAUSE_PENDING, WIN32_SERVICE_PAUSED. - + checkpoint - + The checkpoint value the service increments periodically to report its progress during a lengthy start, stop, pause, or continue operation. For example, the service should increment this value as it completes each step of its initialization when it is starting up. - - + + The checkpoint is only valid when the status is one of WIN32_SERVICE_STOP_PENDING, WIN32_SERVICE_START_PENDING, WIN32_SERVICE_CONTINUE_PENDING or WIN32_SERVICE_PAUSE_PENDING. - + @@ -70,27 +70,27 @@ &reftitle.returnvalues; - + &return.void; - - + + Prior to version 1.0.0, &win32service.noerror.false.error; - + &reftitle.errors; - - Prior to version 1.0.0, if the SAPI is not "cli", this function emits an + + Prior to version 1.0.0, if the SAPI is not "cli", this function emits an E_ERROR level error. - - - As of version 1.0.0, will throw a - Win32ServiceException if SAPI is not + + + As of version 1.0.0, will throw a + Win32ServiceException if SAPI is not "cli" - + - + &reftitle.changelog; @@ -106,15 +106,15 @@ PECL win32service 1.0.0 - Throws a ValueError on invalid data in parameters, + Throws a ValueError on invalid data in parameters, previously &false; was returned. PECL win32service 1.0.0 - Throws a Win32ServiceException on error, - previously a + Throws a Win32ServiceException on error, + previously a Win32 Error Code was returned. diff --git a/reference/win32service/functions/win32-start-service-ctrl-dispatcher.xml b/reference/win32service/functions/win32-start-service-ctrl-dispatcher.xml index 8110a9ee1..7bed1e75b 100644 --- a/reference/win32service/functions/win32-start-service-ctrl-dispatcher.xml +++ b/reference/win32service/functions/win32-start-service-ctrl-dispatcher.xml @@ -14,14 +14,14 @@ boolgracefulModetrue - + When launched via the Service Control Manager, a service process is required to "check-in" with it to establish service monitoring and communication facilities. This function performs the check-in by spawning a thread to handle the lower-level communication with the service control manager. - - + + Once started, the service process should do 2 things. The first is to tell the Service Control Manager that the service is running. This is achieved by calling win32_set_service_status with the @@ -32,13 +32,13 @@ it can determine if it should terminate. This is achieved by periodically calling win32_get_last_control_message and handling the return code appropriately. - + - - Since version 0.2.0, this function work only in "cli" SAPI. On other SAPI + + Since version 0.2.0, this function work only in "cli" SAPI. On other SAPI this function is disabled. - + @@ -49,19 +49,19 @@ name - + The short-name of the service, as registered by win32_create_service. - + gracefulMode - - &true; for exit graceful. &false; for exit with error. See + + &true; for exit graceful. &false; for exit with error. See win32_set_service_exit_mode for more details. - + @@ -70,25 +70,25 @@ &reftitle.returnvalues; - + &return.void; - - + + Prior to version 1.0.0, &win32service.noerror.false.error; - + &reftitle.errors; - - Prior to version 1.0.0, if the SAPI is not "cli", this function emits an + + Prior to version 1.0.0, if the SAPI is not "cli", this function emits an E_ERROR level error. - - - As of version 1.0.0, will throw a - Win32ServiceException if SAPI is not + + + As of version 1.0.0, will throw a + Win32ServiceException if SAPI is not "cli" - + @@ -106,15 +106,15 @@ PECL win32service 1.0.0 - Throws a ValueError on invalid data in parameters, + Throws a ValueError on invalid data in parameters, previously &false; was returned. PECL win32service 1.0.0 - Throws a Win32ServiceException on error, - previously a + Throws a Win32ServiceException on error, + previously a Win32 Error Code was returned. @@ -148,9 +148,9 @@ A <function>win32_start_service_ctrl_dispatcher</function> example - + Check if the service is runnig under the SCM. - + - + &reftitle.seealso; diff --git a/reference/win32service/functions/win32-start-service.xml b/reference/win32service/functions/win32-start-service.xml index 74c9dabf1..a17c0b70e 100644 --- a/reference/win32service/functions/win32-start-service.xml +++ b/reference/win32service/functions/win32-start-service.xml @@ -14,10 +14,10 @@ stringmachine&null; - - Attempts to start the named service. Requires administrative privileges or + + Attempts to start the named service. Requires administrative privileges or an account with appropriate rights set in the service's ACL. - + @@ -27,17 +27,17 @@ servicename - + The short name of the service. - + machine - + Optional machine name. If omitted, the local machine is used. - + @@ -46,23 +46,23 @@ &reftitle.returnvalues; - + &return.void; - - + + Prior to version 1.0.0, &win32service.noerror.false.error; - + &reftitle.errors; - - A ValueError is thrown if the + + A ValueError is thrown if the value of servicename parameter is empty. - - - A Win32ServiceException is thrown on error. - + + + A Win32ServiceException is thrown on error. + @@ -80,15 +80,15 @@ PECL win32service 1.0.0 - Throws a ValueError on invalid data in parameters, + Throws a ValueError on invalid data in parameters, previously &false; was returned. PECL win32service 1.0.0 - Throws a Win32ServiceException on error, - previously a + Throws a Win32ServiceException on error, + previously a Win32 Error Code was returned. @@ -110,7 +110,7 @@ - + &reftitle.seealso; diff --git a/reference/win32service/functions/win32-stop-service.xml b/reference/win32service/functions/win32-stop-service.xml index 18b24139b..c6ac64eab 100644 --- a/reference/win32service/functions/win32-stop-service.xml +++ b/reference/win32service/functions/win32-stop-service.xml @@ -14,10 +14,10 @@ stringmachine&null; - + Stops a named service. Requires administrative privileges or an account with appropriate rights set in the service's ACL. - + @@ -27,17 +27,17 @@ servicename - + The short name of the service. - + machine - + Optional machine name. If omitted, the local machine is used. - + @@ -46,23 +46,23 @@ &reftitle.returnvalues; - + &return.void; - - + + Prior to version 1.0.0, &win32service.noerror.false.error; - + &reftitle.errors; - - A ValueError is thrown if the + + A ValueError is thrown if the value of servicename parameter is empty. - - - A Win32ServiceException is thrown on error. - + + + A Win32ServiceException is thrown on error. + @@ -80,15 +80,15 @@ PECL win32service 1.0.0 - Throws a ValueError on invalid data in parameters, + Throws a ValueError on invalid data in parameters, previously &false; was returned. PECL win32service 1.0.0 - Throws a Win32ServiceException on error, - previously a + Throws a Win32ServiceException on error, + previously a Win32 Error Code was returned. @@ -110,7 +110,7 @@ - + &reftitle.seealso; diff --git a/reference/win32service/rightinfo/construct.xml b/reference/win32service/rightinfo/construct.xml index 757a8b660..09352074e 100644 --- a/reference/win32service/rightinfo/construct.xml +++ b/reference/win32service/rightinfo/construct.xml @@ -13,10 +13,10 @@ final private Win32Service\RightInfo::__construct - + Win32Service\RightInfo objects are returned as the result of win32_read_right_access_service. - + diff --git a/reference/win32service/rightinfo/get-domain.xml b/reference/win32service/rightinfo/get-domain.xml index bb47f9fa0..174727d82 100644 --- a/reference/win32service/rightinfo/get-domain.xml +++ b/reference/win32service/rightinfo/get-domain.xml @@ -13,9 +13,9 @@ final public stringnull Win32Service\RightInfo::getDomain - + Return the user's domain. - + @@ -25,9 +25,9 @@ &reftitle.returnvalues; - + Return the domain name or &null; if no domain found (local account or user GUID resolve fail). - + diff --git a/reference/win32service/rightinfo/get-full-username.xml b/reference/win32service/rightinfo/get-full-username.xml index e52726372..cd39ea4e3 100644 --- a/reference/win32service/rightinfo/get-full-username.xml +++ b/reference/win32service/rightinfo/get-full-username.xml @@ -13,9 +13,9 @@ final public stringnull Win32Service\RightInfo::getFullUsername - + Return the domain and username separated by anti-slash \. - + diff --git a/reference/win32service/rightinfo/get-rights.xml b/reference/win32service/rightinfo/get-rights.xml index 61792f863..0fab5d4f2 100644 --- a/reference/win32service/rightinfo/get-rights.xml +++ b/reference/win32service/rightinfo/get-rights.xml @@ -13,9 +13,9 @@ final public array Win32Service\RightInfo::getRights - + Return the user's right list. - + @@ -25,15 +25,15 @@ &reftitle.returnvalues; - + Return the user's right list. - - + + The array index is the binary mask of right represented by the constants rights. - - + + The value is a string with the Windows constant name (without WIN32_ prefix). - + diff --git a/reference/win32service/rightinfo/get-username.xml b/reference/win32service/rightinfo/get-username.xml index ea60238f4..b840afd50 100644 --- a/reference/win32service/rightinfo/get-username.xml +++ b/reference/win32service/rightinfo/get-username.xml @@ -13,9 +13,9 @@ final public stringnull Win32Service\RightInfo::getUsername - + Return the username. - + @@ -25,9 +25,9 @@ &reftitle.returnvalues; - + Return the username name or GUID if resolve fail. - + diff --git a/reference/win32service/rightinfo/is-deny-access.xml b/reference/win32service/rightinfo/is-deny-access.xml index 1368f5fed..64566878b 100644 --- a/reference/win32service/rightinfo/is-deny-access.xml +++ b/reference/win32service/rightinfo/is-deny-access.xml @@ -13,9 +13,9 @@ final public bool Win32Service\RightInfo::isDenyAccess - + Return &true; if the RightInfo concerns deny access to the resource, otherwise, it is &false;. - + @@ -25,9 +25,9 @@ &reftitle.returnvalues; - + Return &true; if the RightInfo concerns deny access to the resource, otherwise, it is &false;. - + diff --git a/reference/win32service/rightinfo/is-grant-access.xml b/reference/win32service/rightinfo/is-grant-access.xml index b223967ea..c1e56ea00 100644 --- a/reference/win32service/rightinfo/is-grant-access.xml +++ b/reference/win32service/rightinfo/is-grant-access.xml @@ -13,9 +13,9 @@ final public bool Win32Service\RightInfo::isGrantAccess - + Return &true; if the RightInfo concern grants access to the resource, &false; otherwise. - + @@ -25,9 +25,9 @@ &reftitle.returnvalues; - + Return &true; if the RightInfo concern grants access to the resource, &false; otherwise. - + diff --git a/reference/win32service/setup.xml b/reference/win32service/setup.xml index c9b3325c9..df427fee8 100644 --- a/reference/win32service/setup.xml +++ b/reference/win32service/setup.xml @@ -7,19 +7,19 @@
    &reftitle.required; - + The versions of Windows supported are the same as the Visual C++ redistributable package used to build PHP. - +
    &reftitle.install; - + To install this extension, download the prebuild DLL from GitHub Release or use PIE. To install with PIE, see the Packagist Win32Service extension details. - + &pecl.moving.to.pie; @@ -30,7 +30,7 @@
    Security consideration - + This extension needs administrator privileges for some actions such as create, delete, @@ -40,22 +40,22 @@ continue. This requirement can cause an elevation of privileges if the service control is available from the web interface or remote control. - - + + The ACL on the service can be set after adding it into SCM to delegate the current administration tasks to a non administrator account or service account. - - + + As of Win32Service 1.1.0, service rights can be managed with PHP. The actual ACLs can be read with win32_read_all_rights_access_service, an access or deny right can be added with win32_add_right_access_service, or an access right can be removed with win32_remove_right_access_service. - - + + It is recommended to update to Win32Service 1.1.0. For further instructions to manage rights without the extension (or a version prior to 1.1.0), see the Microsoft Knowledge Base. - +
    diff --git a/reference/win32service/win32serviceexception.xml b/reference/win32service/win32serviceexception.xml index 57d56dd22..ae60dc4f0 100644 --- a/reference/win32service/win32serviceexception.xml +++ b/reference/win32service/win32serviceexception.xml @@ -14,12 +14,12 @@
    &reftitle.intro; - + The exception replaces the old mechanism where the error value needed to be compared to constants to detect which error was emitted. The Exception code is equal to the value of the error value and the exception message is based on the corresponding constant name. - +
    diff --git a/reference/win32service/win32servicerightinfo.xml b/reference/win32service/win32servicerightinfo.xml index ed34c6f63..74ac3d6cb 100644 --- a/reference/win32service/win32servicerightinfo.xml +++ b/reference/win32service/win32servicerightinfo.xml @@ -14,9 +14,9 @@
    &reftitle.intro; - + The Win32Service\RightInfo internal class encapsulates the result of win32_read_right_access_service. - +
    diff --git a/reference/wincache/book.xml b/reference/wincache/book.xml index 566614220..84d49b875 100644 --- a/reference/wincache/book.xml +++ b/reference/wincache/book.xml @@ -8,19 +8,19 @@ &reftitle.intro; - + Windows Cache Extension for PHP is a PHP accelerator that is used to increase the speed of PHP applications running on Windows and Windows Server. Once the Windows Cache Extension for PHP is enabled and loaded by the PHP engine, PHP applications can take advantage of the functionality without any code modifications. - - + + The Windows Cache Extension includes 5 different types of caches. The following describes the purpose of each cache type and the benefits it provides. - + - + PHP Opcode Cache - PHP is a script processing engine, which reads an input stream of data that contains text and/or PHP instructions and produces another stream of data, most commonly in the HTML format. This means that on a web server the @@ -29,25 +29,25 @@ web server's CPU and file system and thus affect the overall performance of a PHP web application. The PHP bytecode (opcode) cache is used to store the compiled script bytecode in shared memory so that it can be re-used by PHP engine for subsequent executions of the same script. - - + + Support for opcode caching was removed in Wincache 2.0.0, all users who wish to have an opcache should use the OPcache extension that is included with PHP. - + - + File Cache - Even with the PHP opcode cache enabled, the PHP engine has to accesses the script files on a file system. When PHP scripts are stored on a remote UNC file share, the file operations introduce a significant performance overhead. The Windows Cache Extension for PHP includes a file cache that is used to store the content of the PHP script files in shared memory, which reduces the amount of file system operations performed by PHP engine. - + - + Resolve File Path Cache - PHP scripts very often include or operate with files by using relative file paths. Every file path has to be normalized to an absolute file path by the PHP engine. When a PHP application uses many PHP files and @@ -56,22 +56,22 @@ provides a Resolve File Path cache, which is used to store the mappings between relative and absolute file paths, thereby reducing the number of path resolutions that the PHP engine has to perform. - + - + User Cache (available since version 1.1.0) - PHP scripts can take advantage of the shared memory cache by using the user cache API's. PHP objects and variables can be stored in the user cache and then re-used on subsequent requests. This can be used to improve performance of PHP scripts and to share the data across multiple PHP processes. - + - + Session Handler (available since version 1.1.0) - The WinCache session handler can be used to store the PHP session data in the shared memory cache. This avoids file system operations for reading and writing session data, which improves performance when large amount of data is stored in PHP session. - + diff --git a/reference/wincache/functions/wincache-fcache-fileinfo.xml b/reference/wincache/functions/wincache-fcache-fileinfo.xml index f5136b453..2c4bc97ef 100644 --- a/reference/wincache/functions/wincache-fcache-fileinfo.xml +++ b/reference/wincache/functions/wincache-fcache-fileinfo.xml @@ -13,9 +13,9 @@ arrayfalsewincache_fcache_fileinfo boolsummaryonly&false; - + Retrieves information about file cache content and its usage. - + &reftitle.parameters; @@ -24,10 +24,10 @@ summaryonly - - Controls whether the returned array will contain information about individual cache entries + + Controls whether the returned array will contain information about individual cache entries along with the file cache summary. - + @@ -35,9 +35,9 @@ &reftitle.returnvalues; - + Array of meta data about file cache &return.falseforfailure; - + The array returned by this function contains the following elements: diff --git a/reference/wincache/functions/wincache-fcache-meminfo.xml b/reference/wincache/functions/wincache-fcache-meminfo.xml index 3af238a71..2e93c695b 100644 --- a/reference/wincache/functions/wincache-fcache-meminfo.xml +++ b/reference/wincache/functions/wincache-fcache-meminfo.xml @@ -13,9 +13,9 @@ arrayfalsewincache_fcache_meminfo - + Retrieves information about memory usage by file cache. - + @@ -25,9 +25,9 @@ &reftitle.returnvalues; - + Array of meta data about file cache memory usage &return.falseforfailure; - + The array returned by this function contains the following elements: diff --git a/reference/wincache/functions/wincache-lock.xml b/reference/wincache/functions/wincache-lock.xml index 10fd60164..7f9ebc572 100644 --- a/reference/wincache/functions/wincache-lock.xml +++ b/reference/wincache/functions/wincache-lock.xml @@ -14,15 +14,15 @@ stringkey boolisglobal&false; - - Obtains an exclusive lock on a given key. The execution of the current script will be blocked until the - lock can be obtained. Once the lock is obtained, the other scripts that try to request the lock by using the same + + Obtains an exclusive lock on a given key. The execution of the current script will be blocked until the + lock can be obtained. Once the lock is obtained, the other scripts that try to request the lock by using the same key will be blocked, until the current script releases the lock by using wincache_unlock. - + - Using of the wincache_lock and wincache_unlock can cause deadlocks when - executing PHP scripts in a multi-process environment like FastCGI. Do not use these functions unless you are + Using of the wincache_lock and wincache_unlock can cause deadlocks when + executing PHP scripts in a multi-process environment like FastCGI. Do not use these functions unless you are absolutely sure you need to use them. For the majority of the operations on the user cache it is not necessary to use these functions. @@ -35,18 +35,18 @@ key - + Name of the key in the cache to get the lock on. - + isglobal - - Controls whether the scope of the lock is system-wide or local. Local locks are scoped to the application pool + + Controls whether the scope of the lock is system-wide or local. Local locks are scoped to the application pool in IIS FastCGI case or to all php processes that have the same parent process identifier. - + @@ -54,9 +54,9 @@ &reftitle.returnvalues; - + &return.success; - + &reftitle.examples; diff --git a/reference/wincache/functions/wincache-ocache-fileinfo.xml b/reference/wincache/functions/wincache-ocache-fileinfo.xml index 1dff02d61..9859cd890 100644 --- a/reference/wincache/functions/wincache-ocache-fileinfo.xml +++ b/reference/wincache/functions/wincache-ocache-fileinfo.xml @@ -13,9 +13,9 @@ arrayfalsewincache_ocache_fileinfo boolsummaryonly&false; - + Retrieves information about opcode cache content and its usage. - + &warn.removed.function-7-0-0; @@ -25,10 +25,10 @@ summaryonly - - Controls whether the returned array will contain information about individual cache entries + + Controls whether the returned array will contain information about individual cache entries along with the opcode cache summary. - + @@ -36,9 +36,9 @@ &reftitle.returnvalues; - + Array of meta data about opcode cache &return.falseforfailure; - + The array returned by this function contains the following elements: @@ -64,7 +64,7 @@ - is_local_cache - true is the cache metadata is for a local cache instance, + is_local_cache - true is the cache metadata is for a local cache instance, false if the metadata is for the global cache diff --git a/reference/wincache/functions/wincache-ocache-meminfo.xml b/reference/wincache/functions/wincache-ocache-meminfo.xml index 0406a32ba..ef9ccaa87 100644 --- a/reference/wincache/functions/wincache-ocache-meminfo.xml +++ b/reference/wincache/functions/wincache-ocache-meminfo.xml @@ -13,9 +13,9 @@ arrayfalsewincache_ocache_meminfo - + Retrieves information about memory usage by opcode cache. - + @@ -25,9 +25,9 @@ &reftitle.returnvalues; - + Array of meta data about opcode cache memory usage &return.falseforfailure; - + The array returned by this function contains the following elements: diff --git a/reference/wincache/functions/wincache-refresh-if-changed.xml b/reference/wincache/functions/wincache-refresh-if-changed.xml index a9151b4ce..ebeadde39 100644 --- a/reference/wincache/functions/wincache-refresh-if-changed.xml +++ b/reference/wincache/functions/wincache-refresh-if-changed.xml @@ -13,10 +13,10 @@ boolwincache_refresh_if_changed arrayfilesNULL - - Refreshes the cache entries for the files, whose names were passed in the input argument. + + Refreshes the cache entries for the files, whose names were passed in the input argument. If no argument is specified then refreshes all the entries in the cache. - + &reftitle.parameters; @@ -25,10 +25,10 @@ files - - An array of file names for files that need to be refreshed. + + An array of file names for files that need to be refreshed. An absolute or relative file paths can be used. - + @@ -36,28 +36,28 @@ &reftitle.returnvalues; - + &return.success; - + &reftitle.examples; - WinCache performs regular checks on the cached files to - ensure that if any file has changed then the corresponding entry in the cache is - updated. By default this check is performed every 30 seconds. If, for example, - a PHP script updates another PHP script where the application's - configuration settings are stored, then it may happen that after the - configuration settings have been saved to a file, the application is still using - old settings for some time until the cache is refreshed. In those cases it may be - preferrable to refresh the cache right after the file has been changed. The + WinCache performs regular checks on the cached files to + ensure that if any file has changed then the corresponding entry in the cache is + updated. By default this check is performed every 30 seconds. If, for example, + a PHP script updates another PHP script where the application's + configuration settings are stored, then it may happen that after the + configuration settings have been saved to a file, the application is still using + old settings for some time until the cache is refreshed. In those cases it may be + preferrable to refresh the cache right after the file has been changed. The following example shows how this can be done. A <function>wincache_refresh_if_changed</function> example - +
    &reftitle.intro; - + Converts an HTML input into various image formats - +
    @@ -34,7 +34,7 @@ Constructor - + &Methods; diff --git a/reference/wkhtmltox/wkhtmltox.pdf.converter.xml b/reference/wkhtmltox/wkhtmltox.pdf.converter.xml index 8fdf42f54..6698aedbc 100644 --- a/reference/wkhtmltox/wkhtmltox.pdf.converter.xml +++ b/reference/wkhtmltox/wkhtmltox.pdf.converter.xml @@ -11,9 +11,9 @@
    &reftitle.intro; - + Converts an HTML input, or set of HTML inputs, into PDF output - +
    diff --git a/reference/wkhtmltox/wkhtmltox.pdf.object.xml b/reference/wkhtmltox/wkhtmltox.pdf.object.xml index f27a30718..40fe2bf2c 100644 --- a/reference/wkhtmltox/wkhtmltox.pdf.object.xml +++ b/reference/wkhtmltox/wkhtmltox.pdf.object.xml @@ -11,9 +11,9 @@
    &reftitle.intro; - + Represents an HTML document, input to PDF converter - +
    @@ -34,7 +34,7 @@ Constructor - + diff --git a/reference/wkhtmltox/wkhtmltox/image/converter/convert.xml b/reference/wkhtmltox/wkhtmltox/image/converter/convert.xml index 9551b82f3..c6882c4a9 100644 --- a/reference/wkhtmltox/wkhtmltox/image/converter/convert.xml +++ b/reference/wkhtmltox/wkhtmltox/image/converter/convert.xml @@ -13,9 +13,9 @@ public stringnullwkhtmltox\Image\Converter::convert - + Performs conversion of the input buffer - +     @@ -26,9 +26,9 @@ &reftitle.returnvalues; - + Where the return value is used, it will be populated with the contents of the conversion buffer - + diff --git a/reference/wkhtmltox/wkhtmltox/image/converter/getversion.xml b/reference/wkhtmltox/wkhtmltox/image/converter/getversion.xml index 94f331a70..08da53086 100644 --- a/reference/wkhtmltox/wkhtmltox/image/converter/getversion.xml +++ b/reference/wkhtmltox/wkhtmltox/image/converter/getversion.xml @@ -13,9 +13,9 @@ public stringwkhtmltox\Image\Converter::getVersion - + Determines the version of Converter as reported by libwkhtmltox - +     @@ -25,13 +25,13 @@ &reftitle.returnvalues; - + Returns a version string - + - + This is not yet implemented by libwkhtmltox - + diff --git a/reference/wkhtmltox/wkhtmltox/pdf/converter/add.xml b/reference/wkhtmltox/wkhtmltox/pdf/converter/add.xml index 5b5df64f1..9ec2ce4cb 100644 --- a/reference/wkhtmltox/wkhtmltox/pdf/converter/add.xml +++ b/reference/wkhtmltox/wkhtmltox/pdf/converter/add.xml @@ -13,9 +13,9 @@ public voidwkhtmltox\PDF\Converter::add wkhtmltox\PDF\Objectobject - + Adds the given object to conversion - + @@ -24,9 +24,9 @@ object - + The object to add - + @@ -36,7 +36,7 @@ &reftitle.returnvalues; - + --> diff --git a/reference/wkhtmltox/wkhtmltox/pdf/converter/construct.xml b/reference/wkhtmltox/wkhtmltox/pdf/converter/construct.xml index 2c50157fe..07074f76d 100644 --- a/reference/wkhtmltox/wkhtmltox/pdf/converter/construct.xml +++ b/reference/wkhtmltox/wkhtmltox/pdf/converter/construct.xml @@ -13,9 +13,9 @@ public wkhtmltox\PDF\Converter::__construct arraysettings - + Creates a PDF converter, using optional configuration settings - + @@ -218,7 +218,7 @@ &reftitle.returnvalues; - + --> diff --git a/reference/wkhtmltox/wkhtmltox/pdf/converter/convert.xml b/reference/wkhtmltox/wkhtmltox/pdf/converter/convert.xml index 0b5d19436..c6d7e3d1a 100644 --- a/reference/wkhtmltox/wkhtmltox/pdf/converter/convert.xml +++ b/reference/wkhtmltox/wkhtmltox/pdf/converter/convert.xml @@ -13,9 +13,9 @@ public stringnullwkhtmltox\PDF\Converter::convert - + Performs conversion of all previously added Objects - + @@ -26,9 +26,9 @@ &reftitle.returnvalues; - + Where the return value is used, it will be populated with the contents of the conversion buffer - + diff --git a/reference/wkhtmltox/wkhtmltox/pdf/converter/getversion.xml b/reference/wkhtmltox/wkhtmltox/pdf/converter/getversion.xml index 34091e285..7b978f36a 100644 --- a/reference/wkhtmltox/wkhtmltox/pdf/converter/getversion.xml +++ b/reference/wkhtmltox/wkhtmltox/pdf/converter/getversion.xml @@ -13,9 +13,9 @@ public stringwkhtmltox\PDF\Converter::getVersion - + Determines the version of Converter as reported by libwkhtmltox - + @@ -25,9 +25,9 @@ &reftitle.returnvalues; - + Returns a version string - + diff --git a/reference/wkhtmltox/wkhtmltox/pdf/object/construct.xml b/reference/wkhtmltox/wkhtmltox/pdf/object/construct.xml index a2e01b4ae..f884acbc2 100644 --- a/reference/wkhtmltox/wkhtmltox/pdf/object/construct.xml +++ b/reference/wkhtmltox/wkhtmltox/pdf/object/construct.xml @@ -14,9 +14,9 @@ stringbuffer arraysettings - + Creates a new PDF Object from the given buffer and optional configuration settings - + @@ -26,9 +26,9 @@ buffer - + HTML - + @@ -394,7 +394,7 @@ &reftitle.returnvalues; - + --> diff --git a/reference/xattr/book.xml b/reference/xattr/book.xml index 90c90de50..98e0ea6d8 100644 --- a/reference/xattr/book.xml +++ b/reference/xattr/book.xml @@ -1,19 +1,19 @@ - + xattr - + &reftitle.intro; - + The xattr extension allows for the manipulation of extended attributes on a filesystem. - + - + &reference.xattr.setup; &reference.xattr.constants; &reference.xattr.reference; diff --git a/reference/xattr/configure.xml b/reference/xattr/configure.xml index bf732dff7..23f1400a5 100644 --- a/reference/xattr/configure.xml +++ b/reference/xattr/configure.xml @@ -2,13 +2,13 @@
    &reftitle.install; - + &pecl.info; &url.pecl.package;xattr. - - + + &pecl.windows.download; - +
    &reftitle.required; - + To use xattr, you will need libattr installed. It is available at &url.xattr;. - + - + These functions only work on filesystems that support extended attributes, and have them enabled at mount time. Some common filesystems that support extended attributes are ext2, ext3, reiserfs, jfs, and xfs. - +
    diff --git a/reference/xdiff/book.xml b/reference/xdiff/book.xml index f2e785bb0..04b0da8aa 100644 --- a/reference/xdiff/book.xml +++ b/reference/xdiff/book.xml @@ -1,39 +1,39 @@ - + xdiff - + &reftitle.intro; - + xdiff extension enables you to create and apply patch files containing differences between different revisions of files. - - + + This extension supports two modes of operation - on strings and on files, as well as two different patch formats - unified and binary. Unified patches are excellent for text files as they are human-readable and easy to review. For binary files like archives or images, binary patches will be adequate choice as they are binary safe and handle non-printable characters well. - - + + Starting from version 1.5.0 there are two different sets of functions for generating - binary patches. New functions - xdiff_string_rabdiff and + binary patches. New functions - xdiff_string_rabdiff and xdiff_file_rabdiff generate output compatible with older functions but are typically faster and generate smaller results. For more details about methods of - generating binary patches and differences between them, please check + generating binary patches and differences between them, please check libxdiff website. - - + + This extension uses libxdiff to implement these functions. Please see &url.xdiff; for more information. - + - + &reference.xdiff.setup; &reference.xdiff.constants; &reference.xdiff.reference; diff --git a/reference/xdiff/configure.xml b/reference/xdiff/configure.xml index d5460aa47..b4d9a53a0 100644 --- a/reference/xdiff/configure.xml +++ b/reference/xdiff/configure.xml @@ -2,13 +2,13 @@
    &reftitle.install; - + &pecl.info; &url.pecl.package;xdiff. - - + + &pecl.windows.download.avail; - +
    &reftitle.required; - + To use xdiff, you will need libxdiff installed, available on the libxdiff homepage &url.xdiff;. - + - + You'll need at least libxdiff 0.7 for these functions to be aware of memory_limit. - +
    diff --git a/reference/xhprof/book.xml b/reference/xhprof/book.xml index 3dd17a123..09bd6a94e 100644 --- a/reference/xhprof/book.xml +++ b/reference/xhprof/book.xml @@ -8,35 +8,35 @@ &reftitle.intro; - - XHProf is a light-weight hierarchical and instrumentation based profiler. + + XHProf is a light-weight hierarchical and instrumentation based profiler. During the data collection phase, it keeps track of call counts and inclusive metrics for arcs in the dynamic callgraph of a program. It computes exclusive metrics in the reporting/post processing phase, such as wall (elapsed) time, - CPU time and memory usage. A functions profile can be broken down by callers + CPU time and memory usage. A functions profile can be broken down by callers or callees. XHProf handles recursive functions by detecting cycles in the callgraph at data collection time itself and avoiding the cycles by giving unique depth qualified names for the recursive invocations. - - + + XHProf includes a simple HTML based user interface (written in PHP). The browser based UI for viewing profiler results makes it easy to view results or to share results with peers. A callgraph image view is also supported. - - + + XHProf reports can often be helpful in understanding the structure of the code being executed. The hierarchical nature of the reports can be used to determine, for example, what chain of calls led to a particular function getting called. - - + + XHProf supports ability to compare two runs (a.k.a. "diff" reports) or aggregate data from multiple runs. Diff and aggregate reports, much like single run reports, offer "flat" as well as "hierarchical" views of the profile. - - + + Additional documentation can be found via the facebook xhprof website. - + &reference.xhprof.setup; diff --git a/reference/xhprof/configure.xml b/reference/xhprof/configure.xml index 1702fc703..9abd05b4b 100644 --- a/reference/xhprof/configure.xml +++ b/reference/xhprof/configure.xml @@ -4,10 +4,10 @@
    &reftitle.install; - + &pecl.info; &url.pecl.package;xhprof - +
    diff --git a/reference/xhprof/examples.xml b/reference/xhprof/examples.xml index f00295e62..37e2358ce 100644 --- a/reference/xhprof/examples.xml +++ b/reference/xhprof/examples.xml @@ -5,12 +5,12 @@ &reftitle.examples; Xhprof example with the optional GUI - + This example starts and stops the profiler, then uses the bundled GUI interface to save and parse the results. In other words, the code from the extension itself ends at the call to xhprof_disable. - + arraynullxhprof_disable - + Stops the profiler, and returns xhprof data from the run. - + @@ -25,10 +25,10 @@ &reftitle.returnvalues; - + An array of xhprof data, from the run. Returns &null; if profiling is not enabled. - + diff --git a/reference/xhprof/functions/xhprof-enable.xml b/reference/xhprof/functions/xhprof-enable.xml index fea835695..4bac4d2b0 100644 --- a/reference/xhprof/functions/xhprof-enable.xml +++ b/reference/xhprof/functions/xhprof-enable.xml @@ -14,9 +14,9 @@ intflags0 arrayoptions - + Start xhprof profiling. - + @@ -26,22 +26,22 @@ flags - + Optional flags to add additional information to the profiling. See the XHprof constants for further information about these flags, e.g., XHPROF_FLAGS_MEMORY to enable memory profiling. - + options - + An array of optional options, namely, the 'ignored_functions' option to pass in functions to be ignored during profiling. - + @@ -50,9 +50,9 @@ &reftitle.returnvalues; - + &null; - + @@ -93,7 +93,7 @@ xhprof_enable( 0, array('ignored_functions' => array('call_user_func', 'call_user_func_array'))); - + // 3. elapsed time + memory profiling; ignore call_user_func* during profiling xhprof_enable( XHPROF_FLAGS_MEMORY, diff --git a/reference/xhprof/functions/xhprof-sample-disable.xml b/reference/xhprof/functions/xhprof-sample-disable.xml index f3de43188..c6a2ed2ca 100644 --- a/reference/xhprof/functions/xhprof-sample-disable.xml +++ b/reference/xhprof/functions/xhprof-sample-disable.xml @@ -13,9 +13,9 @@ arraynullxhprof_sample_disable - + Stops the sample mode xhprof profiler, and returns the profile info. - + @@ -26,10 +26,10 @@ &reftitle.returnvalues; - + An array of xhprof sample data, from the run. Returns &null; if profiling is not enabled. - + diff --git a/reference/xhprof/functions/xhprof-sample-enable.xml b/reference/xhprof/functions/xhprof-sample-enable.xml index 143eaef6a..d53af3f80 100644 --- a/reference/xhprof/functions/xhprof-sample-enable.xml +++ b/reference/xhprof/functions/xhprof-sample-enable.xml @@ -13,13 +13,13 @@ voidxhprof_sample_enable - + Starts profiling in sample mode, which is a lighter weight version of xhprof_enable. The sampling interval is 0.1 seconds, and samples record the full function call stack. The main use case is when lower overhead is required when doing performance monitoring and diagnostics. - + @@ -30,9 +30,9 @@ &reftitle.returnvalues; - + &null; - + diff --git a/reference/xhprof/ini.xml b/reference/xhprof/ini.xml index 544dbff18..2d2c94cc2 100644 --- a/reference/xhprof/ini.xml +++ b/reference/xhprof/ini.xml @@ -37,11 +37,11 @@ string - + Directory used by the default implementation of the iXHProfRuns interface (namely, the XHProfRuns_Default class) for storing - XHProf runs. - + XHProf runs. +     diff --git a/reference/xhprof/setup.xml b/reference/xhprof/setup.xml index 149f91441..a144001fe 100644 --- a/reference/xhprof/setup.xml +++ b/reference/xhprof/setup.xml @@ -6,16 +6,16 @@
    &reftitle.required; - + Although not required, xhprof includes an interface that's written in PHP. It's used to save and display the profiled data in a usable way, where viewing is done via a web browser. So, a PHP enabled web server will likely make the xhprof experience more useful. - - + + There's also a fork of the GUI interface at &url.xhprof.gui.fork1; - +
    &reference.xhprof.configure; diff --git a/reference/xlswriter/book.xml b/reference/xlswriter/book.xml index 2e110bb58..abb349b36 100644 --- a/reference/xlswriter/book.xml +++ b/reference/xlswriter/book.xml @@ -8,9 +8,9 @@ &reftitle.intro; - + An efficient and fast xlsx file export extension. - + diff --git a/reference/xlswriter/configure.xml b/reference/xlswriter/configure.xml index 8c5cf2b81..15e753570 100644 --- a/reference/xlswriter/configure.xml +++ b/reference/xlswriter/configure.xml @@ -3,11 +3,11 @@
    &reftitle.install; - + XML-RPC support in PHP is not enabled by default. You will need to use the configuration option when compiling PHP to enable XML-RPC support. - +
    &reftitle.intro; - + Create a cell format object - +
    @@ -146,112 +146,112 @@ Vtiful\Kernel\Format::FORMAT_ALIGN_LEFT - + Vtiful\Kernel\Format::FORMAT_ALIGN_CENTER - + Vtiful\Kernel\Format::FORMAT_ALIGN_RIGHT - + Vtiful\Kernel\Format::FORMAT_ALIGN_FILL - + Vtiful\Kernel\Format::FORMAT_ALIGN_JUSTIFY - + Vtiful\Kernel\Format::FORMAT_ALIGN_CENTER_ACROSS - + Vtiful\Kernel\Format::FORMAT_ALIGN_DISTRIBUTED - + Vtiful\Kernel\Format::FORMAT_ALIGN_VERTICAL_TOP - + Vtiful\Kernel\Format::FORMAT_ALIGN_VERTICAL_BOTTOM - + Vtiful\Kernel\Format::FORMAT_ALIGN_VERTICAL_CENTER - + Vtiful\Kernel\Format::FORMAT_ALIGN_VERTICAL_JUSTIFY - + Vtiful\Kernel\Format::FORMAT_ALIGN_VERTICAL_DISTRIBUTED - + Vtiful\Kernel\Format::UNDERLINE_SINGLE - + Vtiful\Kernel\Format::UNDERLINE_DOUBLE - + Vtiful\Kernel\Format::UNDERLINE_SINGLE_ACCOUNTING - + Vtiful\Kernel\Format::UNDERLINE_DOUBLE_ACCOUNTING - + diff --git a/reference/xlswriter/xlsx-format/align.xml b/reference/xlswriter/xlsx-format/align.xml index e8bcc69e9..a7d73c5f0 100644 --- a/reference/xlswriter/xlsx-format/align.xml +++ b/reference/xlswriter/xlsx-format/align.xml @@ -14,9 +14,9 @@ resourcehandle intstyle - + set cell align - + @@ -25,17 +25,17 @@ handle - + xlsx file handle - + style - + Vtiful\Kernel\Format constant - + @@ -43,9 +43,9 @@ &reftitle.returnvalues; - + Resource - + diff --git a/reference/xlswriter/xlsx-format/bold.xml b/reference/xlswriter/xlsx-format/bold.xml index de42ce604..7d37cde6f 100644 --- a/reference/xlswriter/xlsx-format/bold.xml +++ b/reference/xlswriter/xlsx-format/bold.xml @@ -13,9 +13,9 @@ public Vtiful\Kernel\Format::bold resourcehandle - + Vtiful\Kernel\Format bold format - + @@ -24,9 +24,9 @@ handle - + xlsx file handle - + @@ -34,9 +34,9 @@ &reftitle.returnvalues; - + Resource - + diff --git a/reference/xlswriter/xlsx-format/italic.xml b/reference/xlswriter/xlsx-format/italic.xml index 2d7dd07ca..d0c65489c 100644 --- a/reference/xlswriter/xlsx-format/italic.xml +++ b/reference/xlswriter/xlsx-format/italic.xml @@ -13,9 +13,9 @@ public Vtiful\Kernel\Format::italic resourcehandle - + Vtiful\Kernel\Format italic format - + @@ -24,9 +24,9 @@ handle - + xlsx file handle - + @@ -34,9 +34,9 @@ &reftitle.returnvalues; - + Resource - + diff --git a/reference/xlswriter/xlsx-format/underline.xml b/reference/xlswriter/xlsx-format/underline.xml index c2be0fa9d..6c6821c58 100644 --- a/reference/xlswriter/xlsx-format/underline.xml +++ b/reference/xlswriter/xlsx-format/underline.xml @@ -14,9 +14,9 @@ resourcehandle intstyle - + Vtiful\Kernel\Format underline format - + @@ -25,17 +25,17 @@ handle - + xlsx file handle - + style - + Vtiful\Kernel\Format constant - + @@ -43,9 +43,9 @@ &reftitle.returnvalues; - + Resource - + diff --git a/reference/xlswriter/xlsx-kernel.xml b/reference/xlswriter/xlsx-kernel.xml index 9f4851fe4..97cdad4af 100644 --- a/reference/xlswriter/xlsx-kernel.xml +++ b/reference/xlswriter/xlsx-kernel.xml @@ -11,9 +11,9 @@
    &reftitle.intro; - + Create xlsx files and set cells and output xlsx files - +
    diff --git a/reference/xlswriter/xlsx-kernel/add-sheet.xml b/reference/xlswriter/xlsx-kernel/add-sheet.xml index 014f0f94e..189a0dead 100644 --- a/reference/xlswriter/xlsx-kernel/add-sheet.xml +++ b/reference/xlswriter/xlsx-kernel/add-sheet.xml @@ -13,9 +13,9 @@ public Vtiful\Kernel\Excel::addSheet stringsheetName - + Create a new worksheet in the xlsx file. - +     @@ -24,9 +24,9 @@ sheetName - + Worksheet name - + @@ -34,9 +34,9 @@ &reftitle.returnvalues; - + Vtiful\Kernel\Excel instance - + diff --git a/reference/xlswriter/xlsx-kernel/auto-filter.xml b/reference/xlswriter/xlsx-kernel/auto-filter.xml index c41ed1d62..9ce51c14b 100644 --- a/reference/xlswriter/xlsx-kernel/auto-filter.xml +++ b/reference/xlswriter/xlsx-kernel/auto-filter.xml @@ -13,9 +13,9 @@ public Vtiful\Kernel\Excel::autoFilter stringscope - + Add autofilter to a worksheet. - + @@ -24,9 +24,9 @@ scope - + Cell start and end coordinate string. - + @@ -34,9 +34,9 @@ &reftitle.returnvalues; - + Vtiful\Kernel\Excel instance - + diff --git a/reference/xlswriter/xlsx-kernel/const-memory.xml b/reference/xlswriter/xlsx-kernel/const-memory.xml index 78fb9179d..2bb28830b 100644 --- a/reference/xlswriter/xlsx-kernel/const-memory.xml +++ b/reference/xlswriter/xlsx-kernel/const-memory.xml @@ -14,9 +14,9 @@ stringfileName stringsheetName - + Write a large file with constant memory usage. - + @@ -25,17 +25,17 @@ fileName - + XLSX file name - + sheetName - + Worksheet name - + @@ -43,9 +43,9 @@ &reftitle.returnvalues; - + Vtiful\Kernel\Excel instance - + diff --git a/reference/xlswriter/xlsx-kernel/construct.xml b/reference/xlswriter/xlsx-kernel/construct.xml index f0348d5d3..a700f9598 100644 --- a/reference/xlswriter/xlsx-kernel/construct.xml +++ b/reference/xlswriter/xlsx-kernel/construct.xml @@ -13,9 +13,9 @@ public Vtiful\Kernel\Excel::__construct arrayconfig - + Vtiful\Kernel\Excel constructor, create a class object. - + @@ -24,9 +24,9 @@ config - + XLSX file export configuration - + diff --git a/reference/xlswriter/xlsx-kernel/data.xml b/reference/xlswriter/xlsx-kernel/data.xml index c02eec397..c1a21c08c 100644 --- a/reference/xlswriter/xlsx-kernel/data.xml +++ b/reference/xlswriter/xlsx-kernel/data.xml @@ -13,9 +13,9 @@ public Vtiful\Kernel\Excel::data arraydata - + Write a data in the worksheet. - + @@ -24,9 +24,9 @@ data - + worksheet data - + @@ -34,9 +34,9 @@ &reftitle.returnvalues; - + Vtiful\Kernel\Excel instance - + diff --git a/reference/xlswriter/xlsx-kernel/file-name.xml b/reference/xlswriter/xlsx-kernel/file-name.xml index 9ab8497bd..0e910fec9 100644 --- a/reference/xlswriter/xlsx-kernel/file-name.xml +++ b/reference/xlswriter/xlsx-kernel/file-name.xml @@ -14,9 +14,9 @@ stringfileName stringsheetName - + Create a brand new xlsx file and create a worksheet. - + @@ -25,17 +25,17 @@ fileName - + XLSX file name - + sheetName - + Worksheet name - + @@ -43,9 +43,9 @@ &reftitle.returnvalues; - + Vtiful\Kernel\Excel instance - + diff --git a/reference/xlswriter/xlsx-kernel/get-handle.xml b/reference/xlswriter/xlsx-kernel/get-handle.xml index 7f4d6d10f..2f31268c0 100644 --- a/reference/xlswriter/xlsx-kernel/get-handle.xml +++ b/reference/xlswriter/xlsx-kernel/get-handle.xml @@ -13,9 +13,9 @@ public Vtiful\Kernel\Excel::getHandle - + Get the xlsx text resource handle. - + @@ -25,9 +25,9 @@ &reftitle.returnvalues; - + Resource - + diff --git a/reference/xlswriter/xlsx-kernel/header.xml b/reference/xlswriter/xlsx-kernel/header.xml index 6260f06fa..825bd80df 100644 --- a/reference/xlswriter/xlsx-kernel/header.xml +++ b/reference/xlswriter/xlsx-kernel/header.xml @@ -13,9 +13,9 @@ public Vtiful\Kernel\Excel::header arrayheaderData - + Write a header in the worksheet. - + @@ -24,9 +24,9 @@ headerData - + worksheet header data - + @@ -34,9 +34,9 @@ &reftitle.returnvalues; - + Vtiful\Kernel\Excel instance - + diff --git a/reference/xlswriter/xlsx-kernel/insert-formula.xml b/reference/xlswriter/xlsx-kernel/insert-formula.xml index a8f2aa2a4..d3ce682c0 100644 --- a/reference/xlswriter/xlsx-kernel/insert-formula.xml +++ b/reference/xlswriter/xlsx-kernel/insert-formula.xml @@ -15,9 +15,9 @@ intcolumn stringformula - + Insert calculation formula. - + @@ -26,25 +26,25 @@ row - + cell row - + column - + cell column - + formula - + formula string - + @@ -52,9 +52,9 @@ &reftitle.returnvalues; - + Vtiful\Kernel\Excel instance - + diff --git a/reference/xlswriter/xlsx-kernel/insert-image.xml b/reference/xlswriter/xlsx-kernel/insert-image.xml index 783b72f3b..39c9d9b1b 100644 --- a/reference/xlswriter/xlsx-kernel/insert-image.xml +++ b/reference/xlswriter/xlsx-kernel/insert-image.xml @@ -15,9 +15,9 @@ intcolumn stringlocalImagePath - + Insert a local image into the cell. - + @@ -26,25 +26,25 @@ row - + cell row - + column - + cell column - + localImagePath - + local image path - + @@ -52,9 +52,9 @@ &reftitle.returnvalues; - + Vtiful\Kernel\Excel instance - + diff --git a/reference/xlswriter/xlsx-kernel/insert-text.xml b/reference/xlswriter/xlsx-kernel/insert-text.xml index 3396c7b1a..dd90d7e08 100644 --- a/reference/xlswriter/xlsx-kernel/insert-text.xml +++ b/reference/xlswriter/xlsx-kernel/insert-text.xml @@ -16,9 +16,9 @@ intfloatstringdata stringformat - + Write text in a cell. - + @@ -27,33 +27,33 @@ row - + cell row - + column - + cell column - + data - + data to be written - + format - + String format - + @@ -61,9 +61,9 @@ &reftitle.returnvalues; - + Vtiful\Kernel\Excel instance - + diff --git a/reference/xlswriter/xlsx-kernel/merge-cells.xml b/reference/xlswriter/xlsx-kernel/merge-cells.xml index 5a60612f4..8d8ff32b4 100644 --- a/reference/xlswriter/xlsx-kernel/merge-cells.xml +++ b/reference/xlswriter/xlsx-kernel/merge-cells.xml @@ -14,9 +14,9 @@ stringscope stringdata - + Merge Cells. - + @@ -25,17 +25,17 @@ scope - + cell start and end coordinate strings - + data - + string data - + @@ -43,9 +43,9 @@ &reftitle.returnvalues; - + Vtiful\Kernel\Excel instance - + diff --git a/reference/xlswriter/xlsx-kernel/output.xml b/reference/xlswriter/xlsx-kernel/output.xml index 925ccee90..afcd8c211 100644 --- a/reference/xlswriter/xlsx-kernel/output.xml +++ b/reference/xlswriter/xlsx-kernel/output.xml @@ -13,9 +13,9 @@ public Vtiful\Kernel\Excel::output - + Output xlsx file to disk. - + @@ -25,9 +25,9 @@ &reftitle.returnvalues; - + XLSX file path; - + @@ -49,7 +49,7 @@ $file = $fileObject->fileName('tutorial.xlsx', 'sheet_one') ['viest', 23], ['wjx', 23], ]); - + $path = $file->output(); ?> ]]> diff --git a/reference/xlswriter/xlsx-kernel/set-column.xml b/reference/xlswriter/xlsx-kernel/set-column.xml index a870f8fd9..610df1511 100644 --- a/reference/xlswriter/xlsx-kernel/set-column.xml +++ b/reference/xlswriter/xlsx-kernel/set-column.xml @@ -15,9 +15,9 @@ floatwidth resourceformat - + Set the format of the column. - + @@ -26,25 +26,25 @@ range - + cell start and end coordinate strings - + width - + column width - + format - + cell format resource - + @@ -52,9 +52,9 @@ &reftitle.returnvalues; - + Vtiful\Kernel\Excel instance - + diff --git a/reference/xlswriter/xlsx-kernel/set-row.xml b/reference/xlswriter/xlsx-kernel/set-row.xml index 3c863f2a1..14a75f0eb 100644 --- a/reference/xlswriter/xlsx-kernel/set-row.xml +++ b/reference/xlswriter/xlsx-kernel/set-row.xml @@ -15,9 +15,9 @@ floatheight resourceformat - + Set the format of the row. - + @@ -26,25 +26,25 @@ range - + cell start and end coordinate strings - + height - + row height - + format - + cell format resource - + @@ -52,9 +52,9 @@ &reftitle.returnvalues; - + Vtiful\Kernel\Excel instance - + diff --git a/reference/xmldiff/book.xml b/reference/xmldiff/book.xml index e1419fb99..a4b631260 100644 --- a/reference/xmldiff/book.xml +++ b/reference/xmldiff/book.xml @@ -8,9 +8,9 @@ &reftitle.intro; - + The extension is able to produce diffs of two XML documents and then to apply the difference to the source document. The diff is a XML document containing copy/insert/delete instruction nodes in human readable format. DOMDocument objects, local files and strings in memory can be processed. - + &reference.xmldiff.setup; diff --git a/reference/xmldiff/configure.xml b/reference/xmldiff/configure.xml index 837d62d45..16bd2a59b 100644 --- a/reference/xmldiff/configure.xml +++ b/reference/xmldiff/configure.xml @@ -4,13 +4,13 @@
    &reftitle.install; - + Use when compiling PHP. - + - + Windows users should include php_xmldiff.dll into &php.ini; - +
    diff --git a/reference/xmldiff/setup.xml b/reference/xmldiff/setup.xml index a534b0c88..11cafc0d3 100644 --- a/reference/xmldiff/setup.xml +++ b/reference/xmldiff/setup.xml @@ -6,20 +6,20 @@
    &reftitle.required; - libdiffmark - version 0.10 is bundled with the extension. If diffmark is available from your system packages, its usage is strongly encouraged. - libxml extension - DOM extension + libdiffmark - version 0.10 is bundled with the extension. If diffmark is available from your system packages, its usage is strongly encouraged. + libxml extension + DOM extension
    &reftitle.install; - + &pecl.moved; - - + + &pecl.info; &url.pecl.package;xmldiff. - +
    &reftitle.intro; - + Base abstract class for all the comparsion classes in the extension. - +
    @@ -31,7 +31,7 @@ - + &Methods; diff --git a/reference/xmldiff/xmldiff.dom.xml b/reference/xmldiff/xmldiff.dom.xml index 4699a3e77..57a413320 100644 --- a/reference/xmldiff/xmldiff.dom.xml +++ b/reference/xmldiff/xmldiff.dom.xml @@ -11,9 +11,9 @@
    &reftitle.intro; - + - +
    @@ -29,17 +29,17 @@ XMLDiff\DOM - + extends XMLDiff\Base - + &Methods; - + &InheritedMethods; diff --git a/reference/xmldiff/xmldiff.exception.xml b/reference/xmldiff/xmldiff.exception.xml index bb0783cb7..0c42808ef 100644 --- a/reference/xmldiff/xmldiff.exception.xml +++ b/reference/xmldiff/xmldiff.exception.xml @@ -11,9 +11,9 @@
    &reftitle.intro; - + - +
    @@ -29,7 +29,7 @@ XMLDiff\Exception - + extends Exception @@ -39,7 +39,7 @@ &InheritedProperties; - + &InheritedMethods; diff --git a/reference/xmldiff/xmldiff.file.xml b/reference/xmldiff/xmldiff.file.xml index c456968e8..391487efc 100644 --- a/reference/xmldiff/xmldiff.file.xml +++ b/reference/xmldiff/xmldiff.file.xml @@ -11,9 +11,9 @@
    &reftitle.intro; - + - +
    @@ -29,17 +29,17 @@ XMLDiff\File - + extends XMLDiff\Base - + &Methods; - + &InheritedMethods; diff --git a/reference/xmldiff/xmldiff.memory.xml b/reference/xmldiff/xmldiff.memory.xml index dcfdbe028..0b2863b5c 100644 --- a/reference/xmldiff/xmldiff.memory.xml +++ b/reference/xmldiff/xmldiff.memory.xml @@ -11,9 +11,9 @@
    &reftitle.intro; - + - +
    @@ -29,17 +29,17 @@ XMLDiff\Memory - + extends XMLDiff\Base - + &Methods; - + &InheritedMethods; diff --git a/reference/xmlrpc/book.xml b/reference/xmlrpc/book.xml index 88a390115..971b05e6b 100644 --- a/reference/xmlrpc/book.xml +++ b/reference/xmlrpc/book.xml @@ -8,13 +8,13 @@ &reftitle.intro; - + These functions can be used to write XML-RPC servers and clients. You can find more information about XML-RPC at &url.xmlrpc;, and more documentation on this extension and its functions at &url.xmlrpc-epi;. - + &warn.experimental; diff --git a/reference/xmlrpc/configure.xml b/reference/xmlrpc/configure.xml index 34c79ef91..06b7cae0d 100644 --- a/reference/xmlrpc/configure.xml +++ b/reference/xmlrpc/configure.xml @@ -2,11 +2,11 @@
    &reftitle.install; - + XML-RPC support in PHP is not enabled by default. You will need to use the configuration option when compiling PHP to enable XML-RPC support. - +
    &reftitle.resources; - + This extension defines a XML-RPC server resource returned by xmlrpc_server_create. - +
    diff --git a/reference/yac/yac.xml b/reference/yac/yac.xml index fe96750dd..db28d8e6f 100644 --- a/reference/yac/yac.xml +++ b/reference/yac/yac.xml @@ -55,7 +55,7 @@ _prefix - + &Methods; @@ -64,7 +64,7 @@
    - +
    &reftitle.properties; diff --git a/reference/yaconf/configure.xml b/reference/yaconf/configure.xml index 956afad8e..c2068a63e 100644 --- a/reference/yaconf/configure.xml +++ b/reference/yaconf/configure.xml @@ -4,12 +4,12 @@
    &reftitle.install; - + &pecl.info; &url.pecl.package;yaconf - + + -
    diff --git a/reference/yaconf/setup.xml b/reference/yaconf/setup.xml index 9a9d5d6d8..5bc021b2a 100644 --- a/reference/yaconf/setup.xml +++ b/reference/yaconf/setup.xml @@ -6,9 +6,9 @@
    &reftitle.required; - + Yaconf requires PHP 7.0 and above. - +
    @@ -17,16 +17,16 @@ Yaconf can be installed in one of three ways: via PECL, via PIE, or by building it from source. - + &pecl.moved; - - + + &pecl.info; &url.pecl.package;yaconf. - - + + &pecl.windows.download.avail; - + Installing Yaconf with PECL @@ -71,9 +71,9 @@ make && make install
    &reftitle.resources; - + - +
    diff --git a/reference/yaconf/yaconf.xml b/reference/yaconf/yaconf.xml index 1192bed93..be7851d96 100644 --- a/reference/yaconf/yaconf.xml +++ b/reference/yaconf/yaconf.xml @@ -14,7 +14,7 @@ Yaconf is a configurations container, it parses INI files, stores the result in - PHP when PHP is started, the result lives + PHP when PHP is started, the result lives with the whole PHP lifecycle.
    @@ -34,7 +34,7 @@ - + &Methods; diff --git a/reference/yaf/appconfig.xml b/reference/yaf/appconfig.xml index 6ebd14dde..0365e472a 100644 --- a/reference/yaf/appconfig.xml +++ b/reference/yaf/appconfig.xml @@ -3,11 +3,11 @@ Application Configuration - + You should give an array of config or an ini config file(see Yaf_Config_Ini) path to - Yaf_Application::__construct. - + Yaf_Application::__construct. + Yaf will merge the application configurations and user configurations automatically. The application configurations have prefix "yaf." or @@ -186,10 +186,10 @@ $app = new Yaf_Application(Yaconf::get("application")); string - + The directory of the application, that is the folder which contains the "controllers", "views", "models", "plugins" folders. - + @@ -206,10 +206,10 @@ $app = new Yaf_Application(Yaconf::get("application")); string - + The file ext of the PHP script, used in class autoloading( Yaf_Loader). - + @@ -218,9 +218,9 @@ $app = new Yaf_Application(Yaconf::get("application")); string - + The file ext of the view template scripts. - + @@ -229,13 +229,13 @@ $app = new Yaf_Application(Yaconf::get("application")); string - + A comma-separated list of the registered modules, used in the route - process, especially while there are more than three segments in the PATH_INFO, - - + process, especially while there are more than three segments in the PATH_INFO, + + Yaf need a way to find out whether the first segment is a module name or not. - + @@ -244,14 +244,14 @@ $app = new Yaf_Application(Yaconf::get("application")); string - + The local library directory, see Yaf_Loader and yaf.library. - + After Yaf 2.1.6, this config entry can be an array. The library path - will try to use the items setted in application.library.directory @@ -263,11 +263,11 @@ $app = new Yaf_Application(Yaconf::get("application")); string - + Alias of application.library. Introduced in Yaf 2.1.6 - + @@ -276,12 +276,12 @@ $app = new Yaf_Application(Yaconf::get("application")); string - + A comma-separated prefix of local library namespace. - - + + Introduced in Yaf 2.1.6 - + @@ -290,9 +290,9 @@ $app = new Yaf_Application(Yaconf::get("application")); string - + A absolute path of the Bootstrap class script. - + @@ -301,16 +301,16 @@ $app = new Yaf_Application(Yaconf::get("application")); string - - Used to remove a fixed prefix of request uri in route process. + + Used to remove a fixed prefix of request uri in route process. Take a example, comes a request with request uri "/prefix/controller/action". if you set application.baseUri to "/prefix", then only "/controller/action" will take as the PATH_INFO in route process. - - - In generally, there is no need to set this value. - + + + In generally, there is no need to set this value. + @@ -319,10 +319,10 @@ $app = new Yaf_Application(Yaconf::get("application")); bool - + If it set to On, Yaf will throw an exception while some error occurring. See also Yaf_Dispatcher::throwException. - + @@ -331,11 +331,11 @@ $app = new Yaf_Application(Yaconf::get("application")); bool - + If it set to On, Yaf will forward to Error controller/Action while there is an unhandled exception. See also Yaf_Dispatcher::catchException. - + @@ -344,11 +344,11 @@ $app = new Yaf_Application(Yaconf::get("application")); string - + The default Route, if it is not specificed, Static route will be used as default. See: Yaf_Router::addRoute. - + @@ -357,10 +357,10 @@ $app = new Yaf_Application(Yaconf::get("application")); string - + The default module name, see also Yaf_Dispatcher::setDefaultModule. - + @@ -369,10 +369,10 @@ $app = new Yaf_Application(Yaconf::get("application")); string - + The default controller name, see also Yaf_Dispatcher::setDefaultController. - + @@ -381,10 +381,10 @@ $app = new Yaf_Application(Yaconf::get("application")); string - + The default action name, see also Yaf_Dispatcher::setDefaultAction. - + diff --git a/reference/yaf/book.xml b/reference/yaf/book.xml index 39a1e3af3..4161c0f9e 100644 --- a/reference/yaf/book.xml +++ b/reference/yaf/book.xml @@ -80,13 +80,13 @@ &reference.yaf.yaf-exception; &reference.yaf.yaf-exception-typeerror; &reference.yaf.yaf-exception-startuperror; - &reference.yaf.yaf-exception-dispatchfailed; + &reference.yaf.yaf-exception-dispatchfailed; &reference.yaf.yaf-exception-routerfailed; - &reference.yaf.yaf-exception-loadfailed; + &reference.yaf.yaf-exception-loadfailed; &reference.yaf.yaf-exception-loadfailed-module; &reference.yaf.yaf-exception-loadfailed-controller; - &reference.yaf.yaf-exception-loadfailed-action; - &reference.yaf.yaf-exception-loadfailed-view; + &reference.yaf.yaf-exception-loadfailed-action; + &reference.yaf.yaf-exception-loadfailed-view; diff --git a/reference/yaf/configure.xml b/reference/yaf/configure.xml index 031b9c7d4..61e84e13f 100644 --- a/reference/yaf/configure.xml +++ b/reference/yaf/configure.xml @@ -4,12 +4,12 @@
    &reftitle.install; - + &pecl.info; &url.pecl.package;yaf - + + -
    diff --git a/reference/yaf/setup.xml b/reference/yaf/setup.xml index d0ad3fbbe..757734db9 100644 --- a/reference/yaf/setup.xml +++ b/reference/yaf/setup.xml @@ -7,13 +7,13 @@
    &reftitle.install; - + &pecl.moved; - - + + &pecl.info; &url.pecl.package;yaf. - + Yaf has no external dependencies. Install it with: @@ -50,9 +50,9 @@ extension=yaf.so ]]> - + &pecl.windows.download.avail; - +
    diff --git a/reference/yaf/yaf-action-abstract.xml b/reference/yaf/yaf-action-abstract.xml index 32401e8bd..07067bb31 100644 --- a/reference/yaf/yaf-action-abstract.xml +++ b/reference/yaf/yaf-action-abstract.xml @@ -16,12 +16,12 @@ Yaf_Controller_Abstract). That is, an action method can also be a Yaf_Action_Abstract class. - - Since there should be a entry point which can be called by Yaf, + + Since there should be a entry point which can be called by Yaf, you must implement the abstract method Yaf_Action_Abstract::execute in your custom action class. - +
    @@ -37,7 +37,7 @@ Yaf_Action_Abstract - + extends Yaf_Controller_Abstract @@ -50,10 +50,10 @@ _controller - + &Methods; - + &InheritedMethods; @@ -62,7 +62,7 @@ - +
    &reftitle.properties; diff --git a/reference/yaf/yaf-bootstrap-abstract.xml b/reference/yaf/yaf-bootstrap-abstract.xml index 1c8fde97b..144f5899f 100644 --- a/reference/yaf/yaf-bootstrap-abstract.xml +++ b/reference/yaf/yaf-bootstrap-abstract.xml @@ -11,19 +11,19 @@
    &reftitle.intro; - + Bootstrap is a mechanism used to do some initial config before a Application run. - - + + User may define their own Bootstrap class by inheriting Yaf_Bootstrap_Abstract - - + + Any method declared in Bootstrap class with leading "_init", will be - called by Yaf_Application::bootstrap one by one - according to their defined order. - + called by Yaf_Application::bootstrap one by one + according to their defined order. +
    @@ -49,7 +49,7 @@ "directory" => dirname(__FILE__) . "/application/", ), ); - + $app = new Yaf_Application($config); $app->bootstrap(); ?> @@ -80,7 +80,7 @@ string(22) "Bootstrap::_initPlugin" &Properties; - + &Methods; diff --git a/reference/yaf/yaf-config-abstract.xml b/reference/yaf/yaf-config-abstract.xml index 291d66e50..5bd6eced2 100644 --- a/reference/yaf/yaf-config-abstract.xml +++ b/reference/yaf/yaf-config-abstract.xml @@ -49,7 +49,7 @@ _readonly - + &Methods; @@ -57,7 +57,7 @@
    - +
    &reftitle.properties; @@ -65,13 +65,13 @@ _config - + _readonly - + diff --git a/reference/yaf/yaf-config-ini.xml b/reference/yaf/yaf-config-ini.xml index 2a0a98dd8..ea8036ead 100644 --- a/reference/yaf/yaf-config-ini.xml +++ b/reference/yaf/yaf-config-ini.xml @@ -65,12 +65,12 @@ Yaf_Config_Ini - + extends Yaf_Config_Abstract - + Iterator @@ -86,11 +86,11 @@ &Properties; - + &Methods; - + &InheritedMethods; @@ -99,7 +99,7 @@
    - +
    &reftitle.properties; @@ -107,13 +107,13 @@ _config - + _readonly - + @@ -124,7 +124,7 @@ &reftitle.examples; <function>Yaf_Config_Ini</function>example - + This example illustrates a basic use of Yaf_Config_Ini for loading configuration data from an INI file. In this example there are configuration data for both a production system and for a staging system. @@ -135,7 +135,7 @@ section, though this may not be the case for more complex situations. Suppose, then, that the following configuration data are contained in /path/to/config.ini: - + database->params->host); + +var_dump($config->database->params->host); var_dump($config->database->params->dbname); var_dump($config->get("database.params.username")); ?> diff --git a/reference/yaf/yaf-config-simple.xml b/reference/yaf/yaf-config-simple.xml index 5f6f0d22f..75f098116 100644 --- a/reference/yaf/yaf-config-simple.xml +++ b/reference/yaf/yaf-config-simple.xml @@ -34,12 +34,12 @@ Yaf_Config_Simple - + extends Yaf_Config_Abstract - + Iterator @@ -59,11 +59,11 @@ _readonly - + &Methods; - + &InheritedMethods; @@ -72,7 +72,7 @@
    - +
    &reftitle.properties; @@ -80,13 +80,13 @@ _config - + _readonly - + diff --git a/reference/yaf/yaf-controller-abstract.xml b/reference/yaf/yaf-controller-abstract.xml index 8d7c89e99..e075fc110 100644 --- a/reference/yaf/yaf-controller-abstract.xml +++ b/reference/yaf/yaf-controller-abstract.xml @@ -11,15 +11,15 @@
    &reftitle.intro; - - Yaf_Controller_Abstract is the heart of Yaf's - system. MVC stands for Model-View-Controller and is a design pattern + + Yaf_Controller_Abstract is the heart of Yaf's + system. MVC stands for Model-View-Controller and is a design pattern targeted at separating application logic from display logic. - - + + Every custom controller shall inherit Yaf_Controller_Abstract. - + Since Yaf_Controller_Abstract::__construct is called by Yaf with no arguments, @@ -27,19 +27,19 @@ constructor-like hook: Yaf_Controller_Abstract::init. - + If you have defined a init() method in your custom controller, it will be called as long as the controller was instantiated. - + Action may have arguments, when a request coming, if there are the same name variable in the request parameters(see - Yaf_Request_Abstract::getParam) after routed, + Yaf_Request_Abstract::getParam) after routed, Yaf will pass them to the action method (see Yaf_Action_Abstract::execute). - These arguments are directly fetched without filtering, it should be + These arguments are directly fetched without filtering, it should be carefully processed before use them. @@ -92,7 +92,7 @@ _view - + &Methods; @@ -101,7 +101,7 @@
    - +
    &reftitle.properties; diff --git a/reference/yaf/yaf-dispatcher.xml b/reference/yaf/yaf-dispatcher.xml index 1106bdfe3..f2911377c 100644 --- a/reference/yaf/yaf-dispatcher.xml +++ b/reference/yaf/yaf-dispatcher.xml @@ -11,18 +11,18 @@
    &reftitle.intro; - - Yaf_Dispatcher purpose is to initialize + + Yaf_Dispatcher purpose is to initialize the request environment, route the incoming request, and then dispatch - any discovered actions; it aggregates any responses and returns them + any discovered actions; it aggregates any responses and returns them when the process is complete. - - - Yaf_Dispatcher also implements the Singleton pattern, + + + Yaf_Dispatcher also implements the Singleton pattern, meaning only a single instance of it may be available at any given time. This allows it to also act as a registry on which the other objects in the dispatch process may draw. - +
    @@ -96,7 +96,7 @@
    - +
    &reftitle.properties; diff --git a/reference/yaf/yaf-exception-dispatchfailed.xml b/reference/yaf/yaf-exception-dispatchfailed.xml index c6eecbdb8..272eff69b 100644 --- a/reference/yaf/yaf-exception-dispatchfailed.xml +++ b/reference/yaf/yaf-exception-dispatchfailed.xml @@ -31,7 +31,7 @@ Yaf_Exception_DispatchFailed - + extends Yaf_Exception @@ -39,9 +39,9 @@ &Properties; - + &Methods; - + &InheritedMethods; @@ -50,7 +50,7 @@
    - + diff --git a/reference/yaf/yaf-exception-loadfailed-action.xml b/reference/yaf/yaf-exception-loadfailed-action.xml index 46d6a9722..e07c9b97c 100644 --- a/reference/yaf/yaf-exception-loadfailed-action.xml +++ b/reference/yaf/yaf-exception-loadfailed-action.xml @@ -31,7 +31,7 @@ Yaf_Exception_LoadFailed_Action - + extends Yaf_Exception_LoadFailed @@ -40,9 +40,9 @@ &Properties; - + &Methods; - + &InheritedMethods; @@ -51,7 +51,7 @@
    - + diff --git a/reference/yaf/yaf-exception-loadfailed-controller.xml b/reference/yaf/yaf-exception-loadfailed-controller.xml index ec5e454d4..adb7d9674 100644 --- a/reference/yaf/yaf-exception-loadfailed-controller.xml +++ b/reference/yaf/yaf-exception-loadfailed-controller.xml @@ -31,7 +31,7 @@ Yaf_Exception_LoadFailed_Controller - + extends Yaf_Exception_LoadFailed @@ -39,9 +39,9 @@ &Properties; - + &Methods; - + &InheritedMethods; @@ -49,7 +49,7 @@ - + diff --git a/reference/yaf/yaf-exception-loadfailed-module.xml b/reference/yaf/yaf-exception-loadfailed-module.xml index 4fb6a37a8..c9b46486c 100644 --- a/reference/yaf/yaf-exception-loadfailed-module.xml +++ b/reference/yaf/yaf-exception-loadfailed-module.xml @@ -31,7 +31,7 @@ Yaf_Exception_LoadFailed_Module - + extends Yaf_Exception_LoadFailed @@ -40,9 +40,9 @@ &Properties; - + &Methods; - + &InheritedMethods; @@ -51,7 +51,7 @@ - + diff --git a/reference/yaf/yaf-exception-loadfailed-view.xml b/reference/yaf/yaf-exception-loadfailed-view.xml index d02fe0035..b1cec9114 100644 --- a/reference/yaf/yaf-exception-loadfailed-view.xml +++ b/reference/yaf/yaf-exception-loadfailed-view.xml @@ -31,7 +31,7 @@ Yaf_Exception_LoadFailed_View - + extends Yaf_Exception_LoadFailed @@ -40,9 +40,9 @@ &Properties; - + &Methods; - + &InheritedMethods; @@ -51,7 +51,7 @@ - + diff --git a/reference/yaf/yaf-exception-loadfailed.xml b/reference/yaf/yaf-exception-loadfailed.xml index dbe3eb762..64a7c0fc2 100644 --- a/reference/yaf/yaf-exception-loadfailed.xml +++ b/reference/yaf/yaf-exception-loadfailed.xml @@ -35,7 +35,7 @@ Yaf_Exception_LoadFailed - + extends Yaf_Exception @@ -45,7 +45,7 @@ &Properties; &Methods; - + &InheritedMethods; @@ -54,7 +54,7 @@ - + diff --git a/reference/yaf/yaf-exception-routerfailed.xml b/reference/yaf/yaf-exception-routerfailed.xml index 846c845b9..0c87da326 100644 --- a/reference/yaf/yaf-exception-routerfailed.xml +++ b/reference/yaf/yaf-exception-routerfailed.xml @@ -31,7 +31,7 @@ Yaf_Exception_RouterFailed - + extends Yaf_Exception @@ -40,9 +40,9 @@ &Properties; - + &Methods; - + &InheritedMethods; @@ -51,7 +51,7 @@ - + diff --git a/reference/yaf/yaf-exception-startuperror.xml b/reference/yaf/yaf-exception-startuperror.xml index a13ce6f6b..5b2a5fe3b 100644 --- a/reference/yaf/yaf-exception-startuperror.xml +++ b/reference/yaf/yaf-exception-startuperror.xml @@ -32,7 +32,7 @@ Yaf_Exception_StartupError - + extends Yaf_Exception @@ -41,9 +41,9 @@ &Properties; - + &Methods; - + &InheritedMethods; @@ -52,7 +52,7 @@ - + diff --git a/reference/yaf/yaf-exception-typeerror.xml b/reference/yaf/yaf-exception-typeerror.xml index e53f4382c..4ce538ca0 100644 --- a/reference/yaf/yaf-exception-typeerror.xml +++ b/reference/yaf/yaf-exception-typeerror.xml @@ -31,7 +31,7 @@ Yaf_Exception_TypeError - + extends Yaf_Exception @@ -40,9 +40,9 @@ &Properties; - + &Methods; - + &InheritedMethods; @@ -51,7 +51,7 @@ - + diff --git a/reference/yaf/yaf-exception.xml b/reference/yaf/yaf-exception.xml index 5c3a1fad0..e2a2928b6 100644 --- a/reference/yaf/yaf-exception.xml +++ b/reference/yaf/yaf-exception.xml @@ -36,7 +36,7 @@ Yaf_Exception - + extends RuntimeException @@ -45,11 +45,11 @@ &InheritedProperties; - + &Methods; - + &InheritedMethods; @@ -58,7 +58,7 @@ - + &reference.yaf.entities.yaf-exception; diff --git a/reference/yaf/yaf-loader.xml b/reference/yaf/yaf-loader.xml index a45d73818..4e6389a0f 100644 --- a/reference/yaf/yaf-loader.xml +++ b/reference/yaf/yaf-loader.xml @@ -11,24 +11,24 @@
    &reftitle.intro; - + Yaf_Loader introduces a comprehensive autoloading solution for Yaf. - - - The first time an instance of Yaf_Application is retrieved, + + + The first time an instance of Yaf_Application is retrieved, Yaf_Loader will instance a singleton, and registers itself with spl_autoload. You retrieve an instance using the Yaf_Loader::getInstance - + Yaf_Loader attempt to load a class only one shot, if failed, depend on yaf.use_spl_autoload, if this - config is On Yaf_Loader::autoload will return - &false;, thus give the chance to other autoload function. if it is Off - (by default), Yaf_Loader::autoload will return - &true;, and more important is that a very useful warning will be triggered - (very useful to find out why a class could not be loaded). + config is On Yaf_Loader::autoload will return + &false;, thus give the chance to other autoload function. if it is Off + (by default), Yaf_Loader::autoload will return + &true;, and more important is that a very useful warning will be triggered + (very useful to find out why a class could not be loaded). Please keep yaf.use_spl_autoload Off unless there is some library have @@ -36,21 +36,21 @@ - + By default, Yaf_Loader assume all library (class - defined script) store in the global library + defined script) store in the global library directory, which is defined in the php.ini(yaf.library). - + - + If you want Yaf_Loader search some classes(libraries) in the local class directory(which is defined in application.ini, and by default, it is application.directory . "/library"), + linkend="configuration.yaf.directory">application.directory . "/library"), you should register the class prefix using the Yaf_Loader::registerLocalNameSpace - + Let's see some examples(assuming APPLICATION_PATH is // APPLICATION_PATH/library/Foo/Bar/Test.php - + class GLO_Name => // /global_dir/Glo/Name.php - + class BarNon_Test // /global_dir/Barnon/Test.php ]]> @@ -111,14 +111,14 @@ class \Foo\Bar\Dummy => class \FooBar\Bar\Dummy => // /global_dir/FooBar/Bar/Dummy.php ]]> - + - + You may noticed that all the folder with the first letter capitalized, you can make them lowercase by set yaf.lowcase_path = On in php.ini - + Yaf_Loader is also designed to load the MVC classes, @@ -225,7 +225,7 @@ class A_B_TestModel => _instance - + &Methods; @@ -234,7 +234,7 @@ class A_B_TestModel =>
    - +
    &reftitle.properties; @@ -242,30 +242,30 @@ class A_B_TestModel => _local_ns - + _library - + By default, this value is application.directory . "/library", + linkend="configuration.yaf.directory">application.directory . "/library", you can change this either in the application.ini(application.library) or call to Yaf_Loader::setLibraryPath - + _global_library - + _instance - + @@ -274,7 +274,7 @@ class A_B_TestModel => - + &reference.yaf.entities.yaf-loader; diff --git a/reference/yaf/yaf-plugin-abstract.xml b/reference/yaf/yaf-plugin-abstract.xml index 75eb7a837..3e5f00b2b 100644 --- a/reference/yaf/yaf-plugin-abstract.xml +++ b/reference/yaf/yaf-plugin-abstract.xml @@ -48,12 +48,12 @@ /* plugin class should be placed under ./application/plugins/ */ class TestPlugin extends Yaf_Plugin_Abstract { public function routerStartup(Yaf_Request_Abstract $request, Yaf_Response_Abstract $response) { - /* before router + /* before router in this hook, user can do some url rewrite */ var_dump("routerStartup"); } public function routerShutdown(Yaf_Request_Abstract $request, Yaf_Response_Abstract $response) { - /* router complete + /* router complete in this hook, user can do login check */ var_dump("routerShutdown"); } @@ -84,7 +84,7 @@ "directory" => dirname(__FILE__) . "/application/", ), ); - + $app = new Yaf_Application($config); $app->bootstrap()->run(); ?> @@ -119,7 +119,7 @@ string(20) "dispatchLoopShutdown" - + &Methods; diff --git a/reference/yaf/yaf-registry.xml b/reference/yaf/yaf-registry.xml index b87b998f3..d30c97408 100644 --- a/reference/yaf/yaf-registry.xml +++ b/reference/yaf/yaf-registry.xml @@ -50,7 +50,7 @@ _entries - + &Methods; @@ -59,7 +59,7 @@
    - +
    &reftitle.properties; @@ -67,13 +67,13 @@ _instance - + _entries - + diff --git a/reference/yaf/yaf-request-abstract.xml b/reference/yaf/yaf-request-abstract.xml index 169fab2cc..e0aca391b 100644 --- a/reference/yaf/yaf-request-abstract.xml +++ b/reference/yaf/yaf-request-abstract.xml @@ -117,67 +117,67 @@ module - + controller - + action - + method - + params - + language - + _exception - + _base_uri - + uri - + dispatched - + routed - + @@ -193,14 +193,14 @@ Yaf_Request_Abstract::SCHEME_HTTP - + Yaf_Request_Abstract::SCHEME_HTTPS - + diff --git a/reference/yaf/yaf-request-http.xml b/reference/yaf/yaf-request-http.xml index 503619397..73618779f 100644 --- a/reference/yaf/yaf-request-http.xml +++ b/reference/yaf/yaf-request-http.xml @@ -14,14 +14,14 @@ Any request from client is initialized as a Yaf_Request_Http. - you can get the request information like, uri query and + you can get the request information like, uri query and post parameters via methods of this class. For security, $_GET/$_POST are readonly in Yaf, which means if you set a value to these global variables, you can not get it from Yaf_Request_Http::getQuery or - Yaf_Request_Http::getPost. + Yaf_Request_Http::getPost. But there do is some usage need such feature, like unit testing. thus @@ -49,7 +49,7 @@ Yaf_Request_Http - + extends Yaf_Request_Abstract @@ -58,7 +58,7 @@ &Properties; - + &Methods; @@ -70,7 +70,7 @@
    - +
    &reftitle.properties; @@ -78,67 +78,67 @@ module - + controller - + action - + method - + params - + language - + _exception - + _base_uri - + uri - + dispatched - + routed - + diff --git a/reference/yaf/yaf-request-simple.xml b/reference/yaf/yaf-request-simple.xml index ba7ebb97a..4ea07e43b 100644 --- a/reference/yaf/yaf-request-simple.xml +++ b/reference/yaf/yaf-request-simple.xml @@ -11,10 +11,10 @@
    &reftitle.intro; - + Yaf_Request_Simple is particularlly used for test puporse. ie. simulate some espacial request under CLI mode. - +
    @@ -73,67 +73,67 @@ module - + controller - + action - + method - + params - + language - + _exception - + _base_uri - + uri - + dispatched - + routed - + @@ -149,14 +149,14 @@ Yaf_Request_Simple::SCHEME_HTTP - + Yaf_Request_Simple::SCHEME_HTTPS - + diff --git a/reference/yaf/yaf-response-cli.xml b/reference/yaf/yaf-response-cli.xml index d7167dad3..0992a1c1c 100644 --- a/reference/yaf/yaf-response-cli.xml +++ b/reference/yaf/yaf-response-cli.xml @@ -32,7 +32,7 @@ Yaf_Response_Cli - + extends Yaf_Response_Abstract @@ -41,7 +41,7 @@ &Properties; - + &InheritedMethods; @@ -50,7 +50,7 @@
    - +
    &reftitle.properties; @@ -58,19 +58,19 @@ _header - + _body - + _sendheader - + diff --git a/reference/yaf/yaf-response-http.xml b/reference/yaf/yaf-response-http.xml index bbac5a396..954790df5 100644 --- a/reference/yaf/yaf-response-http.xml +++ b/reference/yaf/yaf-response-http.xml @@ -33,7 +33,7 @@ Yaf_Response_Http - + extends Yaf_Response_Abstract @@ -50,7 +50,7 @@ _response_code - + &InheritedMethods; @@ -59,7 +59,7 @@
    - +
    &reftitle.properties; @@ -67,25 +67,25 @@ _header - + _body - + _sendheader - + _response_code - + diff --git a/reference/yaf/yaf-route-interface.xml b/reference/yaf/yaf-route-interface.xml index 5ba5a83e0..c07db5ff3 100644 --- a/reference/yaf/yaf-route-interface.xml +++ b/reference/yaf/yaf-route-interface.xml @@ -47,7 +47,7 @@ - + &Methods; diff --git a/reference/yaf/yaf-route-map.xml b/reference/yaf/yaf-route-map.xml index e964c197f..3b64c924f 100644 --- a/reference/yaf/yaf-route-map.xml +++ b/reference/yaf/yaf-route-map.xml @@ -51,7 +51,7 @@ Yaf_Route_Map - + Yaf_Route_Interface @@ -67,7 +67,7 @@ _delimiter - + &Methods; @@ -76,7 +76,7 @@
    - +
    &reftitle.properties; @@ -84,13 +84,13 @@ _ctl_router - + _delimiter - + diff --git a/reference/yaf/yaf-route-regex.xml b/reference/yaf/yaf-route-regex.xml index 25a75bd59..ad1eaef2f 100644 --- a/reference/yaf/yaf-route-regex.xml +++ b/reference/yaf/yaf-route-regex.xml @@ -39,12 +39,12 @@ Yaf_Route_Regex - + extends Yaf_Route_Interface - + Yaf_Route_Interface @@ -68,11 +68,11 @@ _verify - + &Methods; - + &InheritedMethods; @@ -81,7 +81,7 @@
    - +
    &reftitle.properties; @@ -89,25 +89,25 @@ _route - + _default - + _maps - + _verify - + diff --git a/reference/yaf/yaf-route-rewrite.xml b/reference/yaf/yaf-route-rewrite.xml index 44abffb30..2582d7075 100644 --- a/reference/yaf/yaf-route-rewrite.xml +++ b/reference/yaf/yaf-route-rewrite.xml @@ -37,12 +37,12 @@ Yaf_Route_Rewrite - + extends Yaf_Route_Interface - + Yaf_Route_Interface @@ -62,11 +62,11 @@ _verify - + &Methods; - + &InheritedMethods; @@ -75,7 +75,7 @@
    - +
    &reftitle.properties; @@ -83,19 +83,19 @@ _route - + _default - + _verify - + diff --git a/reference/yaf/yaf-route-simple.xml b/reference/yaf/yaf-route-simple.xml index a2d2fe8a0..f9c501dea 100644 --- a/reference/yaf/yaf-route-simple.xml +++ b/reference/yaf/yaf-route-simple.xml @@ -40,7 +40,7 @@ Yaf_Route_Simple - + Yaf_Route_Interface @@ -60,7 +60,7 @@ action - + &Methods; @@ -69,7 +69,7 @@
    - +
    &reftitle.properties; @@ -77,19 +77,19 @@ controller - + module - + action - + diff --git a/reference/yaf/yaf-route-static.xml b/reference/yaf/yaf-route-static.xml index d3d336460..4f2c9404b 100644 --- a/reference/yaf/yaf-route-static.xml +++ b/reference/yaf/yaf-route-static.xml @@ -40,13 +40,13 @@ Yaf_Route_Static - + Yaf_Router - + &Methods; diff --git a/reference/yaf/yaf-route-supervar.xml b/reference/yaf/yaf-route-supervar.xml index 7110a258d..e9fc22878 100644 --- a/reference/yaf/yaf-route-supervar.xml +++ b/reference/yaf/yaf-route-supervar.xml @@ -35,7 +35,7 @@ Yaf_Route_Supervar - + Yaf_Route_Interface @@ -47,7 +47,7 @@ _var_name - + &Methods; @@ -56,7 +56,7 @@
    - +
    &reftitle.properties; @@ -64,7 +64,7 @@ _var_name - + diff --git a/reference/yaf/yaf-router.xml b/reference/yaf/yaf-router.xml index 4437fda41..6a0df901d 100644 --- a/reference/yaf/yaf-router.xml +++ b/reference/yaf/yaf-router.xml @@ -89,16 +89,16 @@ server { Default route Yaf_Router comes preconfigured with a default route - Yaf_Route_Static, which will match URIs in the shape of + Yaf_Route_Static, which will match URIs in the shape of controller/action. Additionally, a module name may be specified as the first - path element, allowing URIs of the form module/controller/action. Finally, - it will also match any additional parameters appended to the URI by default + path element, allowing URIs of the form module/controller/action. Finally, + it will also match any additional parameters appended to the URI by default - controller/action/var1/value1/var2/value2. Module name must be defined in config, considering application.module="Index,Foo,Bar", in this case, only index, foo and bar can be considered as a module name. - if doesn't config, there is only one module named "Index". + if doesn't config, there is only one module named "Index". @@ -121,22 +121,22 @@ http://example/news controller == news Action only(when defined yaf.action_prefer=1 in php.ini) action == news - + Invalid module maps to controller name: http://example/foo controller == foo - + Module + controller: http://example/blog/archive module == blog controller == archive - + Module + controller + action: http://example/blog/archive/list module == blog controller == archive action == list - + Module + controller + action + params: http://example/blog/archive/list/sort/alpha/date/desc module == blog @@ -175,7 +175,7 @@ http://example/blog/archive/list/sort/alpha/date/desc _current - + &Methods; @@ -184,7 +184,7 @@ http://example/blog/archive/list/sort/alpha/date/desc
    - +
    &reftitle.properties; @@ -192,21 +192,21 @@ http://example/blog/archive/list/sort/alpha/date/desc _routes - + registered routes stack - + _current - + after routing phase, this indicated the name of which route is used to route current request. you can get this name by Yaf_Router::getCurrentRoute. - + diff --git a/reference/yaf/yaf-session.xml b/reference/yaf/yaf-session.xml index 2f43b69af..c6cf660b0 100644 --- a/reference/yaf/yaf-session.xml +++ b/reference/yaf/yaf-session.xml @@ -42,7 +42,7 @@ Yaf_Session - + Iterator @@ -71,7 +71,7 @@ _started - + &Methods; @@ -80,7 +80,7 @@
    - +
    &reftitle.properties; @@ -88,19 +88,19 @@ _instance - + _session - + _started - + diff --git a/reference/yaf/yaf-view-interface.xml b/reference/yaf/yaf-view-interface.xml index 7874a365b..c31e305a0 100644 --- a/reference/yaf/yaf-view-interface.xml +++ b/reference/yaf/yaf-view-interface.xml @@ -11,12 +11,12 @@
    &reftitle.intro; - + Yaf provides a ability for developers to use custom view engine instead - of built-in engine which is Yaf_View_Simple. There + of built-in engine which is Yaf_View_Simple. There is a example to explain how to do this, please see Yaf_Dispatcher::setView. - +
    @@ -34,7 +34,7 @@ - + &Methods; diff --git a/reference/yaf/yaf-view-simple.xml b/reference/yaf/yaf-view-simple.xml index ca7bbf5be..80ce6640e 100644 --- a/reference/yaf/yaf-view-simple.xml +++ b/reference/yaf/yaf-view-simple.xml @@ -11,11 +11,11 @@
    &reftitle.intro; - + Yaf_View_Simple is the built-in template engine in Yaf, it is a simple but fast template engine, and only support PHP script template. - +
    @@ -31,7 +31,7 @@ Yaf_View_Simple - + Yaf_View_Interface @@ -47,7 +47,7 @@ _tpl_dir - + &Methods; @@ -56,7 +56,7 @@
    - +
    &reftitle.properties; @@ -64,13 +64,13 @@ _tpl_vars - + _tpl_dir - + diff --git a/reference/yaf/yaf_action_abstract/execute.xml b/reference/yaf/yaf_action_abstract/execute.xml index 3987f9a21..17bbaf55c 100644 --- a/reference/yaf/yaf_action_abstract/execute.xml +++ b/reference/yaf/yaf_action_abstract/execute.xml @@ -32,9 +32,9 @@ args - + - + @@ -55,7 +55,7 @@ + [_current:protected] => ) - [_view:protected] => + [_view:protected] => [_request:protected] => Yaf_Request_Http Object ( [method] => Cli @@ -80,7 +80,7 @@ Yaf_Dispatcher Object ) [_auto_render:protected] => 1 - [_return_response:protected] => + [_return_response:protected] => [_instantly_flush:protected] => 1 [_default_module:protected] => Index [_default_controller:protected] => Index diff --git a/reference/yaf/yaf_dispatcher/registerplugin.xml b/reference/yaf/yaf_dispatcher/registerplugin.xml index c7090cef1..cd01ef6f5 100644 --- a/reference/yaf/yaf_dispatcher/registerplugin.xml +++ b/reference/yaf/yaf_dispatcher/registerplugin.xml @@ -52,10 +52,10 @@ class Bootstrap extends Yaf_Bootstrap_Abstract { public function _initPlugin(Yaf_Dispatcher $dispatcher) { /** - * Yaf assumes plugin scripts under [application.directory] . "/plugins" + * Yaf assumes plugin scripts under [application.directory] . "/plugins" * for this case, it will be: * [application.directory] . "/plugins/" . "User" . [application.ext] - */ + */ $user = new UserPlugin(); $dispatcher->registerPlugin($user); } diff --git a/reference/yaf/yaf_dispatcher/setview.xml b/reference/yaf/yaf_dispatcher/setview.xml index e44932cbf..17e0c5198 100644 --- a/reference/yaf/yaf_dispatcher/setview.xml +++ b/reference/yaf/yaf_dispatcher/setview.xml @@ -13,10 +13,10 @@ public Yaf_DispatchernullYaf_Dispatcher::setView Yaf_View_Interfaceview - + This method provides a solution if you want use a custom view engine instead of Yaf_View_Simple - + @@ -26,9 +26,9 @@ view - + A Yaf_View_Interface instance - + @@ -58,7 +58,7 @@ class Smarty_Adapter implements Yaf_View_Interface * @var Smarty */ public $_smarty; - + /** * Constructor * @@ -68,16 +68,16 @@ class Smarty_Adapter implements Yaf_View_Interface */ public function __construct($tmplPath = null, $extraParams = array()) { $this->_smarty = new Smarty; - + if (null !== $tmplPath) { $this->setScriptPath($tmplPath); } - + foreach ($extraParams as $key => $value) { $this->_smarty->$key = $value; } } - + /** * Set the path to the templates * @@ -90,10 +90,10 @@ class Smarty_Adapter implements Yaf_View_Interface $this->_smarty->template_dir = $path; return; } - + throw new Exception('Invalid path provided'); } - + /** * Assign a variable to the template * @@ -105,7 +105,7 @@ class Smarty_Adapter implements Yaf_View_Interface { $this->_smarty->assign($key, $val); } - + /** * Allows testing with empty() and isset() to work * @@ -116,7 +116,7 @@ class Smarty_Adapter implements Yaf_View_Interface { return (null !== $this->_smarty->get_template_vars($key)); } - + /** * Allows unset() on object properties to work * @@ -127,7 +127,7 @@ class Smarty_Adapter implements Yaf_View_Interface { $this->_smarty->clear_assign($key); } - + /** * Assign variables to the template * @@ -146,10 +146,10 @@ class Smarty_Adapter implements Yaf_View_Interface $this->_smarty->assign($spec); return; } - + $this->_smarty->assign($spec, $value); } - + /** * Clear all assigned variables * @@ -162,7 +162,7 @@ class Smarty_Adapter implements Yaf_View_Interface public function clearVars() { $this->_smarty->clear_all_assign(); } - + /** * Processes a template and returns the output. * diff --git a/reference/yaf/yaf_request_abstract/setactionname.xml b/reference/yaf/yaf_request_abstract/setactionname.xml index 56979ebd9..8869b2e8f 100644 --- a/reference/yaf/yaf_request_abstract/setactionname.xml +++ b/reference/yaf/yaf_request_abstract/setactionname.xml @@ -26,18 +26,18 @@ action - - &string;, action name, it should in lower case style, like "index" or "foo_bar" - + + &string;, action name, it should in lower case style, like "index" or "foo_bar" + format_name - + this is introduced in Yaf 3.2.0, by default Yaf will format the name into lower case style, if this is set to &false; , Yaf will set the original name to request. - + diff --git a/reference/yaf/yaf_request_abstract/setbaseuri.xml b/reference/yaf/yaf_request_abstract/setbaseuri.xml index 5b89e96d0..827c60623 100644 --- a/reference/yaf/yaf_request_abstract/setbaseuri.xml +++ b/reference/yaf/yaf_request_abstract/setbaseuri.xml @@ -35,9 +35,9 @@ uir - + base URI - + diff --git a/reference/yaf/yaf_request_abstract/setcontrollername.xml b/reference/yaf/yaf_request_abstract/setcontrollername.xml index 2ec75e96d..8e5dddafa 100644 --- a/reference/yaf/yaf_request_abstract/setcontrollername.xml +++ b/reference/yaf/yaf_request_abstract/setcontrollername.xml @@ -14,9 +14,9 @@ stringcontroller boolformat_nametrue - + set controller name to request, this is usually used by custom router to set route result controller name. - + @@ -26,18 +26,18 @@ controller - - &string;, controller name, this should be in camel style, like "Index" or "Foo_Bar" - + + &string;, controller name, this should be in camel style, like "Index" or "Foo_Bar" + format_name - + this is introduced in Yaf 3.2.0, by default Yaf will format the name into camel mode, if this is set to &false; , Yaf will set the original name to request. - + diff --git a/reference/yaf/yaf_request_abstract/setmodulename.xml b/reference/yaf/yaf_request_abstract/setmodulename.xml index 17b5c6305..5265b1f40 100644 --- a/reference/yaf/yaf_request_abstract/setmodulename.xml +++ b/reference/yaf/yaf_request_abstract/setmodulename.xml @@ -14,9 +14,9 @@ stringmodule boolformat_nametrue - + set module name to request, this is usually used by custom router to set route result module name. - + @@ -26,18 +26,18 @@ module - - &string; module name, it should be in camel style, like "Index" or "Foo_Bar" - + + &string; module name, it should be in camel style, like "Index" or "Foo_Bar" + format_name - + this is introduced in Yaf 3.2.0, by default Yaf will format the name into camel mode, if this is set to &false; , Yaf will set the original name to request. - + diff --git a/reference/yaf/yaf_request_http/construct.xml b/reference/yaf/yaf_request_http/construct.xml index ea12844ed..c193efec2 100644 --- a/reference/yaf/yaf_request_http/construct.xml +++ b/reference/yaf/yaf_request_http/construct.xml @@ -14,9 +14,9 @@ stringrequest_uri stringbase_uri - + - + &warn.undocumented.func; @@ -29,9 +29,9 @@ &reftitle.returnvalues; - + - + diff --git a/reference/yaf/yaf_request_simple/construct.xml b/reference/yaf/yaf_request_simple/construct.xml index 9f5bad677..f18904a8b 100644 --- a/reference/yaf/yaf_request_simple/construct.xml +++ b/reference/yaf/yaf_request_simple/construct.xml @@ -17,8 +17,8 @@ stringaction arrayparams - - + + &warn.undocumented.func; @@ -31,9 +31,9 @@ &reftitle.returnvalues; - + - + diff --git a/reference/yaf/yaf_route_interface/assemble.xml b/reference/yaf/yaf_route_interface/assemble.xml index 182492026..55a182982 100644 --- a/reference/yaf/yaf_route_interface/assemble.xml +++ b/reference/yaf/yaf_route_interface/assemble.xml @@ -14,14 +14,14 @@ arrayinfo arrayquery - + this method returns a url according to the argument info, and append query strings to the url according to the argument query. - - + + a route should implement this method according to its own route rules, and do a reverse progress. - + @@ -30,18 +30,18 @@ info - - - + + + query - + - + @@ -49,9 +49,9 @@ &reftitle.returnvalues; - + - + diff --git a/reference/yaf/yaf_route_interface/route.xml b/reference/yaf/yaf_route_interface/route.xml index cc11950a5..7fc5b29e0 100644 --- a/reference/yaf/yaf_route_interface/route.xml +++ b/reference/yaf/yaf_route_interface/route.xml @@ -23,24 +23,24 @@ - + if this method return &true;, then the route process will be end. otherwise, Yaf_Router will call next route in the route stack to route request. - + - + This method would set the route result to the parameter request, by calling Yaf_Request_Abstract::setControllerName, Yaf_Request_Abstract::setActionName and Yaf_Request_Abstract::setModuleName. - + - + This method should also call Yaf_Request_Abstract::setRouted to make the request routed at last. - + @@ -50,9 +50,9 @@ request - + A Yaf_Request_Abstract instance. - + @@ -60,9 +60,9 @@ &reftitle.returnvalues; - + - + diff --git a/reference/yaf/yaf_route_map/assemble.xml b/reference/yaf/yaf_route_map/assemble.xml index 835a69d14..afae26e09 100644 --- a/reference/yaf/yaf_route_map/assemble.xml +++ b/reference/yaf/yaf_route_map/assemble.xml @@ -14,9 +14,9 @@ arrayinfo arrayquery - + Assemble a url. - + @@ -25,17 +25,17 @@ info - - - + + + query - - - + + + @@ -43,16 +43,16 @@ &reftitle.returnvalues; - + Returns &string; on success or &null; on failure. - + &reftitle.errors; - - May throw Yaf_Exception_TypeError. - + + May throw Yaf_Exception_TypeError. + diff --git a/reference/yaf/yaf_route_regex/assemble.xml b/reference/yaf/yaf_route_regex/assemble.xml index 367b48995..303b63f65 100644 --- a/reference/yaf/yaf_route_regex/assemble.xml +++ b/reference/yaf/yaf_route_regex/assemble.xml @@ -14,9 +14,9 @@ arrayinfo arrayquery - + Assemble a url. - + @@ -25,17 +25,17 @@ info - - - + + + query - - - + + + @@ -43,9 +43,9 @@ &reftitle.returnvalues; - + Returns &string; on success or &null; on failure. - + diff --git a/reference/yaf/yaf_route_regex/construct.xml b/reference/yaf/yaf_route_regex/construct.xml index 64a7c68d0..febb22611 100644 --- a/reference/yaf/yaf_route_regex/construct.xml +++ b/reference/yaf/yaf_route_regex/construct.xml @@ -220,8 +220,8 @@ Yaf_Dispatcher::getInstance()->getRouter()->addConfig( Yaf_Route_Simple Yaf_Route_Rewrite Yaf_Route_Map - - + + diff --git a/reference/yaf/yaf_route_rewrite/assemble.xml b/reference/yaf/yaf_route_rewrite/assemble.xml index 3e4c6f491..567ac623e 100644 --- a/reference/yaf/yaf_route_rewrite/assemble.xml +++ b/reference/yaf/yaf_route_rewrite/assemble.xml @@ -14,9 +14,9 @@ arrayinfo arrayquery - + Assemble a url. - + @@ -25,17 +25,17 @@ info - - - + + + query - - - + + + @@ -43,9 +43,9 @@ &reftitle.returnvalues; - + Returns &string;. - + diff --git a/reference/yaf/yaf_route_rewrite/construct.xml b/reference/yaf/yaf_route_rewrite/construct.xml index ce2725f85..e704ea935 100644 --- a/reference/yaf/yaf_route_rewrite/construct.xml +++ b/reference/yaf/yaf_route_rewrite/construct.xml @@ -15,9 +15,9 @@ arrayroute arrayverify - + - + @@ -26,37 +26,37 @@ match - + A pattern, will be used to match a request uri, if it doesn't match, Yaf_Route_Rewrite will return &false;. - - + + You can use :name style to name segments matched, and use * to match the rest of the URL segments. - + route - + When the match pattern matches the request uri, Yaf_Route_Rewrite will use this to decide which module/controller/action is the destination. - - + + Either of module/controller/action in this array is optional, if you don't assign a specific value, it will be routed to default. - + verify - - - + + + @@ -64,9 +64,9 @@ &reftitle.returnvalues; - + - + @@ -167,7 +167,7 @@ array( */ $config = array( "name" => array( - "type" => "rewrite", + "type" => "rewrite", "match" => "/user-list/:a/:id", //match only /user-list/* "route" => array( 'controller' => "user", //route to user controller, @@ -213,8 +213,8 @@ array( Yaf_Route_Simple Yaf_Route_Regex Yaf_Route_Map - - + + diff --git a/reference/yaf/yaf_route_simple/assemble.xml b/reference/yaf/yaf_route_simple/assemble.xml index 6d9c973a6..bab89702e 100644 --- a/reference/yaf/yaf_route_simple/assemble.xml +++ b/reference/yaf/yaf_route_simple/assemble.xml @@ -14,9 +14,9 @@ arrayinfo arrayquery - + Assemble a url. - + @@ -25,17 +25,17 @@ info - - - + + + query - - - + + + @@ -43,17 +43,17 @@ &reftitle.returnvalues; - + Returns a &string;. - + &reftitle.errors; - - Throws Yaf_Exception_TypeError if info + + Throws Yaf_Exception_TypeError if info keys ':c' or ':a' are not set. - + diff --git a/reference/yaf/yaf_route_static/assemble.xml b/reference/yaf/yaf_route_static/assemble.xml index 93d8572ad..ae089200e 100644 --- a/reference/yaf/yaf_route_static/assemble.xml +++ b/reference/yaf/yaf_route_static/assemble.xml @@ -14,9 +14,9 @@ arrayinfo arrayquery - + Assemble a url. - + @@ -25,17 +25,17 @@ info - - - + + + query - - - + + + @@ -43,17 +43,17 @@ &reftitle.returnvalues; - + Returns a &string;. - + &reftitle.errors; - - Throws Yaf_Exception_TypeError if info + + Throws Yaf_Exception_TypeError if info keys ':c' and ':a' are not set. - + diff --git a/reference/yaf/yaf_route_supervar/assemble.xml b/reference/yaf/yaf_route_supervar/assemble.xml index 696c1b375..4ba214e46 100644 --- a/reference/yaf/yaf_route_supervar/assemble.xml +++ b/reference/yaf/yaf_route_supervar/assemble.xml @@ -14,9 +14,9 @@ arrayinfo arrayquery - + Assemble a url. - + @@ -25,17 +25,17 @@ info - - - + + + query - - - + + + @@ -43,17 +43,17 @@ &reftitle.returnvalues; - + Returns a &string;. - + &reftitle.errors; - - Throws Yaf_Exception_TypeError if info + + Throws Yaf_Exception_TypeError if info keys ':c' and ':a' are not set. - + diff --git a/reference/yaf/yaf_router/addconfig.xml b/reference/yaf/yaf_router/addconfig.xml index e3706d8fb..4d9e4ec1f 100644 --- a/reference/yaf/yaf_router/addconfig.xml +++ b/reference/yaf/yaf_router/addconfig.xml @@ -13,10 +13,10 @@ public boolYaf_Router::addConfig Yaf_Config_Abstractconfig - + Add routes defined by configs into Yaf_Router's route stack - + @@ -26,10 +26,10 @@ &reftitle.returnvalues; - + An Yaf_Config_Abstract instance, which should contains one or more valid route configs - + @@ -106,8 +106,8 @@ class Bootstrap extends Yaf_Bootstrap_Abstract{ Yaf_Route_Regex Yaf_Route_Rewrite Yaf_Route_Map - - + + diff --git a/reference/yaf/yaf_router/addroute.xml b/reference/yaf/yaf_router/addroute.xml index c89e23f4f..d4bb63136 100644 --- a/reference/yaf/yaf_router/addroute.xml +++ b/reference/yaf/yaf_router/addroute.xml @@ -14,15 +14,15 @@ stringname Yaf_Route_Abstractroute - + defaultly, Yaf_Router using a Yaf_Route_Static as its defualt route. you can add new routes into router's route stack by calling this method. - - + + the newer route will be called before the older(route stack), and if the newer router return &true;, the router process will be end. otherwise, the older one will be called. - + @@ -32,9 +32,9 @@ &reftitle.returnvalues; - - - + + + @@ -57,11 +57,11 @@ class Bootstrap extends Yaf_Bootstrap_Abstract{ */ $router->addConfig(Yaf_Registry::get("config")->routes); /** - * add a Rewrite route, then for a request uri: + * add a Rewrite route, then for a request uri: * http://example.com/product/list/22/foo * will be matched by this route, and result: * - * [module] => + * [module] => * [controller] => product * [action] => info * [method] => GET @@ -70,7 +70,7 @@ class Bootstrap extends Yaf_Bootstrap_Abstract{ * [id] => 22 * [name] => foo * ) - * + * */ $route = new Yaf_Route_Rewrite( "/product/list/:id/:name", @@ -78,8 +78,8 @@ class Bootstrap extends Yaf_Bootstrap_Abstract{ "controller" => "product", "action" => "info", ) - ); - + ); + $router->addRoute('dummy', $route); } } @@ -99,8 +99,8 @@ class Bootstrap extends Yaf_Bootstrap_Abstract{ Yaf_Route_Regex Yaf_Route_Rewrite Yaf_Route_Map - - + + diff --git a/reference/yaf/yaf_router/construct.xml b/reference/yaf/yaf_router/construct.xml index 7b3dbecb3..3cf699749 100644 --- a/reference/yaf/yaf_router/construct.xml +++ b/reference/yaf/yaf_router/construct.xml @@ -13,9 +13,9 @@ public Yaf_Router::__construct - + - + @@ -25,9 +25,9 @@ &reftitle.returnvalues; - + - + diff --git a/reference/yaf/yaf_router/getcurrentroute.xml b/reference/yaf/yaf_router/getcurrentroute.xml index 2d6a3adf5..f6e0383f0 100644 --- a/reference/yaf/yaf_router/getcurrentroute.xml +++ b/reference/yaf/yaf_router/getcurrentroute.xml @@ -31,9 +31,9 @@ &reftitle.returnvalues; - + String, the name of the effective route. - + @@ -57,7 +57,7 @@ class Bootstrap extends Yaf_Bootstrap_Abstract{ "controller" => "product", "action" => "list", ) - ); + ); $regex_route = new Yaf_Route_Rewrite( "#^/product/info/(\d+)", @@ -65,13 +65,13 @@ class Bootstrap extends Yaf_Bootstrap_Abstract{ "controller" => "product", "action" => "info", ) - ); - + ); + $router->addRoute('rewrite', $rewrite_route)->addRoute('regex', $regex_route); - } + } /** - * register plugin + * register plugin */ public function __initPlugins(Yaf_Dispatcher $dispatcher) { $dispatcher->registerPlugin(new DummyPlugin()); @@ -123,8 +123,8 @@ string(8) "_default" Yaf_Bootstrap_Abstract Yaf_Plugin_Abstract Yaf_Router::addRoute - - + + diff --git a/reference/yaf/yaf_router/getroute.xml b/reference/yaf/yaf_router/getroute.xml index 1207bf4c9..a581af4cb 100644 --- a/reference/yaf/yaf_router/getroute.xml +++ b/reference/yaf/yaf_router/getroute.xml @@ -13,10 +13,10 @@ public Yaf_Route_InterfaceYaf_Router::getRoute stringname - + Retrieve a route by name, see also Yaf_Router::getCurrentRoute - + @@ -26,9 +26,9 @@ &reftitle.returnvalues; - + - + @@ -78,8 +78,8 @@ NULL Yaf_Plugin_Abstract Yaf_Router::addRoute Yaf_Router::getCurrentRoute - - + + diff --git a/reference/yaf/yaf_router/getroutes.xml b/reference/yaf/yaf_router/getroutes.xml index d90808895..6196848e1 100644 --- a/reference/yaf/yaf_router/getroutes.xml +++ b/reference/yaf/yaf_router/getroutes.xml @@ -13,9 +13,9 @@ public mixedYaf_Router::getRoutes - + Retrieve registered routes - + @@ -25,9 +25,9 @@ &reftitle.returnvalues; - + - + diff --git a/reference/yaml/book.xml b/reference/yaml/book.xml index da77f301f..64cecb93c 100644 --- a/reference/yaml/book.xml +++ b/reference/yaml/book.xml @@ -9,12 +9,12 @@ &reftitle.intro; - + This extension implements the YAML Ain't Markup Language (YAML) data serialization standard. Parsing and emiting are handled by the LibYAML library. - + diff --git a/reference/yaml/callbacks.xml b/reference/yaml/callbacks.xml index 17dc0ffbf..d6c04ad05 100644 --- a/reference/yaml/callbacks.xml +++ b/reference/yaml/callbacks.xml @@ -1,19 +1,19 @@ - + Callbacks
    Parse callbacks - + Parse callables are invoked by yaml_parse, yaml_parse_file or yaml_parse_url functions when a registered YAML tag is encountered. The callback is passed the tagged entity's value, the tag, and flags indicating the scalar entity style. The callback must return the data that the YAML parser should emit for this entity. - + Parse callback example @@ -65,7 +65,7 @@ array(1) {
    Emit callbacks - + Emit callbacks are invoked when an instance of a registered class is emitted by yaml_emit or yaml_emit_file. The callback is passed the object to @@ -75,7 +75,7 @@ array(1) { be a string to be used as the YAML tag in the output. The value associated with the "data" key will be encoded as YAML and emitted in place of the intercepted object. - + Emit callback example diff --git a/reference/yaml/constants.xml b/reference/yaml/constants.xml index 9d48769cd..4844254ef 100644 --- a/reference/yaml/constants.xml +++ b/reference/yaml/constants.xml @@ -4,8 +4,8 @@ &reftitle.constants; &extension.constants; - - + + Scalar entity styles usable by <function>yaml_parse</function> diff --git a/reference/yaml/functions/yaml-emit-file.xml b/reference/yaml/functions/yaml-emit-file.xml index 84cab8c84..f55d7e04a 100644 --- a/reference/yaml/functions/yaml-emit-file.xml +++ b/reference/yaml/functions/yaml-emit-file.xml @@ -17,10 +17,10 @@ <methodparam choice="opt"><type>int</type><parameter>linebreak</parameter><initializer>YAML_ANY_BREAK</initializer></methodparam> <methodparam choice="opt"><type>array</type><parameter>callbacks</parameter><initializer>&null;</initializer></methodparam> </methodsynopsis> - <para> + <simpara> Generate a YAML representation of the provided <parameter>data</parameter> in the <parameter>filename</parameter>. - </para> + </simpara> </refsect1> <refsect1 role="parameters"> @@ -30,53 +30,53 @@ <varlistentry> <term><parameter>filename</parameter></term> <listitem> - <para> + <simpara> Path to the file. - </para> + </simpara> </listitem> </varlistentry> <varlistentry> <term><parameter>data</parameter></term> <listitem> - <para> + <simpara> The <parameter>data</parameter> being encoded. Can be any type except a <type>resource</type>. - </para> + </simpara> </listitem> </varlistentry> <varlistentry> <term><parameter>encoding</parameter></term> <listitem> - <para> + <simpara> Output character encoding chosen from <constant>YAML_ANY_ENCODING</constant>, <constant>YAML_UTF8_ENCODING</constant>, <constant>YAML_UTF16LE_ENCODING</constant>, <constant>YAML_UTF16BE_ENCODING</constant>. - </para> + </simpara> </listitem> </varlistentry> <varlistentry> <term><parameter>linebreak</parameter></term> <listitem> - <para> + <simpara> Output linebreak style chosen from <constant>YAML_ANY_BREAK</constant>, <constant>YAML_CR_BREAK</constant>, <constant>YAML_LN_BREAK</constant>, <constant>YAML_CRLN_BREAK</constant>. - </para> + </simpara> </listitem> </varlistentry> <varlistentry> <term><parameter>callbacks</parameter></term> <listitem> - <para> + <simpara> Content handlers for emitting YAML nodes. Associative <type>array</type> of classname => <type>callable</type> mappings. See <link linkend="yaml.callbacks.emit">emit callbacks</link> for more details. - </para> + </simpara> </listitem> </varlistentry> </variablelist> @@ -85,9 +85,9 @@ <refsect1 role="returnvalues"> &reftitle.returnvalues; - <para> + <simpara> Returns &true; on success. - </para> + </simpara> </refsect1> <refsect1 role="changelog"> diff --git a/reference/yaml/functions/yaml-emit.xml b/reference/yaml/functions/yaml-emit.xml index eef9a03e8..4db457c81 100644 --- a/reference/yaml/functions/yaml-emit.xml +++ b/reference/yaml/functions/yaml-emit.xml @@ -16,9 +16,9 @@ <methodparam choice="opt"><type>int</type><parameter>linebreak</parameter><initializer>YAML_ANY_BREAK</initializer></methodparam> <methodparam choice="opt"><type>array</type><parameter>callbacks</parameter><initializer>&null;</initializer></methodparam> </methodsynopsis> - <para> + <simpara> Generate a YAML representation of the provided <parameter>data</parameter>. - </para> + </simpara> </refsect1> <refsect1 role="parameters"> @@ -28,45 +28,45 @@ <varlistentry> <term><parameter>data</parameter></term> <listitem> - <para> + <simpara> The <parameter>data</parameter> being encoded. Can be any type except a <type>resource</type>. - </para> + </simpara> </listitem> </varlistentry> <varlistentry> <term><parameter>encoding</parameter></term> <listitem> - <para> + <simpara> Output character encoding chosen from <constant>YAML_ANY_ENCODING</constant>, <constant>YAML_UTF8_ENCODING</constant>, <constant>YAML_UTF16LE_ENCODING</constant>, <constant>YAML_UTF16BE_ENCODING</constant>. - </para> + </simpara> </listitem> </varlistentry> <varlistentry> <term><parameter>linebreak</parameter></term> <listitem> - <para> + <simpara> Output linebreak style chosen from <constant>YAML_ANY_BREAK</constant>, <constant>YAML_CR_BREAK</constant>, <constant>YAML_LN_BREAK</constant>, <constant>YAML_CRLN_BREAK</constant>. - </para> + </simpara> </listitem> </varlistentry> <varlistentry> <term><parameter>callbacks</parameter></term> <listitem> - <para> + <simpara> Content handlers for emitting YAML nodes. Associative <type>array</type> of classname => <type>callable</type> mappings. See <link linkend="yaml.callbacks.emit">emit callbacks</link> for more details. - </para> + </simpara> </listitem> </varlistentry> </variablelist> @@ -75,9 +75,9 @@ <refsect1 role="returnvalues"> &reftitle.returnvalues; - <para> + <simpara> Returns a YAML encoded <type>string</type> on success. - </para> + </simpara> </refsect1> <refsect1 role="changelog"> diff --git a/reference/yaml/functions/yaml-parse-file.xml b/reference/yaml/functions/yaml-parse-file.xml index a4897ac8e..6a3a864b7 100644 --- a/reference/yaml/functions/yaml-parse-file.xml +++ b/reference/yaml/functions/yaml-parse-file.xml @@ -16,9 +16,9 @@ <methodparam choice="opt"><type>int</type><parameter role="reference">ndocs</parameter></methodparam> <methodparam choice="opt"><type>array</type><parameter>callbacks</parameter><initializer>&null;</initializer></methodparam> </methodsynopsis> - <para> + <simpara> Convert all or part of a YAML document stream read from a file to a PHP variable. - </para> + </simpara> </refsect1> <refsect1 role="parameters"> @@ -28,38 +28,38 @@ <varlistentry> <term><parameter>filename</parameter></term> <listitem> - <para> + <simpara> Path to the file. - </para> + </simpara> </listitem> </varlistentry> <varlistentry> <term><parameter>pos</parameter></term> <listitem> - <para> + <simpara> Document to extract from stream (<literal>-1</literal> for all documents, <literal>0</literal> for first document, ...). - </para> + </simpara> </listitem> </varlistentry> <varlistentry> <term><parameter>ndocs</parameter></term> <listitem> - <para> + <simpara> If <parameter>ndocs</parameter> is provided, then it is filled with the number of documents found in stream. - </para> + </simpara> </listitem> </varlistentry> <varlistentry> <term><parameter>callbacks</parameter></term> <listitem> - <para> + <simpara> Content handlers for YAML nodes. Associative <type>array</type> of YAML tag => <type>callable</type> mappings. See <link linkend="yaml.callbacks.parse">parse callbacks</link> for more details. - </para> + </simpara> </listitem> </varlistentry> </variablelist> @@ -84,12 +84,12 @@ <refsect1 role="notes"> &reftitle.notes; <warning> - <para> + <simpara> Processing untrusted user input with <function>yaml_parse_file</function> is dangerous if the use of <function>unserialize</function> is enabled for nodes using the <literal>!php/object</literal> tag. This behavior can be disabled by using the <literal>yaml.decode_php</literal> ini setting. - </para> + </simpara> </warning> </refsect1> diff --git a/reference/yaml/functions/yaml-parse-url.xml b/reference/yaml/functions/yaml-parse-url.xml index 1d05f9f73..13fe5f482 100644 --- a/reference/yaml/functions/yaml-parse-url.xml +++ b/reference/yaml/functions/yaml-parse-url.xml @@ -16,9 +16,9 @@ <methodparam choice="opt"><type>int</type><parameter role="reference">ndocs</parameter></methodparam> <methodparam choice="opt"><type>array</type><parameter>callbacks</parameter><initializer>&null;</initializer></methodparam> </methodsynopsis> - <para> + <simpara> Convert all or part of a YAML document stream read from a URL to a PHP variable. - </para> + </simpara> </refsect1> <refsect1 role="parameters"> @@ -28,41 +28,41 @@ <varlistentry> <term><parameter>url</parameter></term> <listitem> - <para> + <simpara> <parameter>url</parameter> should be of the form "scheme://...". PHP will search for a protocol handler (also known as a wrapper) for that scheme. If no wrappers for that protocol are registered, PHP will emit a notice to help you track potential problems in your script and then continue as though filename specifies a regular file. - </para> + </simpara> </listitem> </varlistentry> <varlistentry> <term><parameter>pos</parameter></term> <listitem> - <para> + <simpara> Document to extract from stream (<literal>-1</literal> for all documents, <literal>0</literal> for first document, ...). - </para> + </simpara> </listitem> </varlistentry> <varlistentry> <term><parameter>ndocs</parameter></term> <listitem> - <para> + <simpara> If <parameter>ndocs</parameter> is provided, then it is filled with the number of documents found in stream. - </para> + </simpara> </listitem> </varlistentry> <varlistentry> <term><parameter>callbacks</parameter></term> <listitem> - <para> + <simpara> Content handlers for YAML nodes. Associative <type>array</type> of YAML tag => <type>callable</type> mappings. See <link linkend="yaml.callbacks.parse">parse callbacks</link> for more details. - </para> + </simpara> </listitem> </varlistentry> </variablelist> @@ -71,23 +71,23 @@ <refsect1 role="returnvalues"> &reftitle.returnvalues; - <para> + <simpara> Returns the value encoded in <parameter>url</parameter> in appropriate PHP type&return.falseforfailure;. If <parameter>pos</parameter> is <literal>-1</literal> an <type>array</type> will be returned with one entry for each document found in the stream. - </para> + </simpara> </refsect1> <refsect1 role="notes"> &reftitle.notes; <warning> - <para> + <simpara> Processing untrusted user input with <function>yaml_parse_url</function> is dangerous if the use of <function>unserialize</function> is enabled for nodes using the <literal>!php/object</literal> tag. This behavior can be disabled by using the <literal>yaml.decode_php</literal> ini setting. - </para> + </simpara> </warning> </refsect1> diff --git a/reference/yaml/functions/yaml-parse.xml b/reference/yaml/functions/yaml-parse.xml index 2b50be4c6..0aabb6740 100644 --- a/reference/yaml/functions/yaml-parse.xml +++ b/reference/yaml/functions/yaml-parse.xml @@ -16,9 +16,9 @@ <methodparam choice="opt"><type>int</type><parameter role="reference">ndocs</parameter></methodparam> <methodparam choice="opt"><type>array</type><parameter>callbacks</parameter><initializer>&null;</initializer></methodparam> </methodsynopsis> - <para> + <simpara> Convert all or part of a YAML document stream to a PHP variable. - </para> + </simpara> </refsect1> <refsect1 role="parameters"> @@ -28,38 +28,38 @@ <varlistentry> <term><parameter>input</parameter></term> <listitem> - <para> + <simpara> The <type>string</type> to parse as a YAML document stream. - </para> + </simpara> </listitem> </varlistentry> <varlistentry> <term><parameter>pos</parameter></term> <listitem> - <para> + <simpara> Document to extract from stream (<literal>-1</literal> for all documents, <literal>0</literal> for first document, ...). - </para> + </simpara> </listitem> </varlistentry> <varlistentry> <term><parameter>ndocs</parameter></term> <listitem> - <para> + <simpara> If <parameter>ndocs</parameter> is provided, then it is filled with the number of documents found in stream. - </para> + </simpara> </listitem> </varlistentry> <varlistentry> <term><parameter>callbacks</parameter></term> <listitem> - <para> + <simpara> Content handlers for YAML nodes. Associative <type>array</type> of YAML tag => <type>callable</type> mappings. See <link linkend="yaml.callbacks.parse">parse callbacks</link> for more details. - </para> + </simpara> </listitem> </varlistentry> </variablelist> @@ -68,12 +68,12 @@ <refsect1 role="returnvalues"> &reftitle.returnvalues; - <para> + <simpara> Returns the value encoded in <parameter>input</parameter> in appropriate PHP type&return.falseforfailure;. If <parameter>pos</parameter> is <literal>-1</literal> an <type>array</type> will be returned with one entry for each document found in the stream. - </para> + </simpara> </refsect1> <refsect1 role="examples"> @@ -206,12 +206,12 @@ array(8) { <refsect1 role="notes"> &reftitle.notes; <warning> - <para> + <simpara> Processing untrusted user input with <function>yaml_parse</function> is dangerous if the use of <function>unserialize</function> is enabled for nodes using the <literal>!php/object</literal> tag. This behavior can be disabled by using the <literal>yaml.decode_php</literal> ini setting. - </para> + </simpara> </warning> </refsect1> diff --git a/reference/yaml/ini.xml b/reference/yaml/ini.xml index f9ee5172b..601052f78 100644 --- a/reference/yaml/ini.xml +++ b/reference/yaml/ini.xml @@ -68,9 +68,9 @@ <type>bool</type> </term> <listitem> - <para> + <simpara> Off by default, but can be set to on to cause base64 binary encoded entities which have the explicit tag "tag:yaml.org,2002:binary" to be decoded. - </para> + </simpara> </listitem> </varlistentry> <varlistentry xml:id="ini.yaml.decode-php"> @@ -79,9 +79,9 @@ <type>bool</type> </term> <listitem> - <para> + <simpara> Off by default, but can be set to on to cause serialized php objects which have the explicit tag "!php/object" to be unserialized. - </para> + </simpara> </listitem> </varlistentry> <varlistentry xml:id="ini.yaml.decode-timestamp"> @@ -90,9 +90,9 @@ <type>int</type> </term> <listitem> - <para> + <simpara> Controls the decoding of both implicit and explicit "tag:yaml.org,2002:timestamp" scalars in the YAML document stream. The default setting of <literal>0</literal> will not apply any decoding. A setting of <literal>1</literal> will use <function>strtotime</function> to parse the timestamp value as a Unix timestamp. A setting of <literal>2</literal> will use <function>date_create</function> to parse the timestamp value as <type>DateTime</type> object. - </para> + </simpara> </listitem> </varlistentry> <varlistentry xml:id="ini.yaml.output-canonical"> @@ -101,9 +101,9 @@ <type>bool</type> </term> <listitem> - <para> + <simpara> Off by default, but can be set to on to cause canonical form output. - </para> + </simpara> </listitem> </varlistentry> <varlistentry xml:id="ini.yaml.output-indent"> @@ -112,10 +112,10 @@ <type>int</type> </term> <listitem> - <para> + <simpara> Number of spaces to indent sections. Value should be between <literal>1</literal> and <literal>10</literal>. - </para> + </simpara> </listitem> </varlistentry> <varlistentry xml:id="ini.yaml.output-width"> @@ -124,9 +124,9 @@ <type>int</type> </term> <listitem> - <para> + <simpara> Set the preferred line width. <literal>-1</literal> means unlimited. - </para> + </simpara> </listitem> </varlistentry> </variablelist> diff --git a/reference/yaml/setup.xml b/reference/yaml/setup.xml index 00400ab30..0216ee678 100644 --- a/reference/yaml/setup.xml +++ b/reference/yaml/setup.xml @@ -6,21 +6,21 @@ <section xml:id="yaml.requirements"> &reftitle.required; - <para> + <simpara> This extension requires the <link xlink:href="&url.yaml.libyaml;">LibYAML C library</link> version 0.1.0 or higher to be installed. - </para> + </simpara> </section> <section xml:id="yaml.installation"> &reftitle.install; - <para> + <simpara> &pecl.moved; - </para> - <para> + </simpara> + <simpara> &pecl.info; <link xlink:href="&url.pecl.package;yaml">&url.pecl.package;yaml</link>. - </para> + </simpara> </section> <!-- {{{ Configuration --> diff --git a/reference/yaz/book.xml b/reference/yaz/book.xml index 0df63a7f0..cd3903d10 100644 --- a/reference/yaz/book.xml +++ b/reference/yaz/book.xml @@ -8,32 +8,32 @@ <!-- {{{ preface --> <preface xml:id="intro.yaz"> &reftitle.intro; - <para> + <simpara> This extension offers a PHP interface to the <productname>YAZ</productname> toolkit that implements the <link xlink:href="&url.yaz-loc;">Z39.50 Protocol for Information Retrieval</link>. With this extension you can easily implement a Z39.50 origin (client) that searches or scans Z39.50 targets (servers) in parallel. - </para> - <para> + </simpara> + <simpara> The module hides most of the complexity of Z39.50 so it should be fairly easy to use. It supports persistent stateless connections very similar to those offered by the various RDB APIs that are available for PHP. This means that sessions are stateless but shared among users, thus saving the connect and initialize phase steps in most cases. - </para> - <para> + </simpara> + <simpara> <productname>YAZ</productname> is available at <link xlink:href="&url.yaz;">&url.yaz;</link>. You can find news information, example scripts, etc. for this extension at <link xlink:href="&url.yaz-phpyaz;">&url.yaz-phpyaz;</link>. - </para> + </simpara> <note> - <para> + <simpara> &pecl.moved-ver;5.0.0. - </para> + </simpara> </note> </preface> <!-- }}} --> diff --git a/reference/yaz/configure.xml b/reference/yaz/configure.xml index d400cd6c3..c2b0190b3 100644 --- a/reference/yaz/configure.xml +++ b/reference/yaz/configure.xml @@ -2,26 +2,26 @@ <!-- $Revision$ --> <section xml:id="yaz.installation" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> &reftitle.install; - <para> + <simpara> &pecl.info; <link xlink:href="&url.pecl.package;yaz">&url.pecl.package;yaz</link> - </para> - <para> + </simpara> + <simpara> &pecl.windows.download; - </para> + </simpara> <note> <title>Information specific to Windows users - - php_yaz.dll depends on + + php_yaz.dll depends on yaz.dll. The yaz.dll - is part of the Win32 ZIP from the PHP site. It is also part + is part of the Win32 ZIP from the PHP site. It is also part of the Windows YAZ install available from the YAZ WIN32 area. - - + + On windows, don't forget to add the PHP directory to the PATH, so that the yaz.dll file can be found by the system. - + &warn.imaprecodeyaz; diff --git a/reference/yaz/examples.xml b/reference/yaz/examples.xml index dd1d52e7b..1ff8b6ece 100644 --- a/reference/yaz/examples.xml +++ b/reference/yaz/examples.xml @@ -3,17 +3,17 @@ &reftitle.examples; - + PHP/YAZ keeps track of connections with targets (Z-Associations). A resource represents a connection to a target. - - + + The script below demonstrates the parallel searching feature of the API. When invoked with no arguments it prints a query form; else (arguments are supplied) it searches the targets as given in array host. - + Parallel searching using Yaz @@ -39,7 +39,7 @@ if (empty($query) || count($host) == 0) { - '; + '; } else { echo 'You searched for ' . htmlspecialchars($query) . '
    '; for ($i = 0; $i < $num_hosts; $i++) { diff --git a/reference/yaz/functions/yaz-addinfo.xml b/reference/yaz/functions/yaz-addinfo.xml index 9cacab957..cf5098f0a 100644 --- a/reference/yaz/functions/yaz-addinfo.xml +++ b/reference/yaz/functions/yaz-addinfo.xml @@ -11,13 +11,13 @@ stringyaz_addinfo resourceid - + Returns additional error information for the last request on the server. - - - With some servers, this function may return the same string as + + + With some servers, this function may return the same string as yaz_error. - + &reftitle.parameters; @@ -26,9 +26,9 @@ id - + The connection resource returned by yaz_connect. - +     @@ -36,11 +36,11 @@ &reftitle.returnvalues; - + A string containing additional error information or an empty string if the last operation was successful or if no additional information was provided by the server. - + &reftitle.seealso; diff --git a/reference/yaz/functions/yaz-ccl-conf.xml b/reference/yaz/functions/yaz-ccl-conf.xml index 38f7caf34..efcaaa2d5 100644 --- a/reference/yaz/functions/yaz-ccl-conf.xml +++ b/reference/yaz/functions/yaz-ccl-conf.xml @@ -12,14 +12,14 @@ resourceid arrayconfig - - This function configures the CCL query parser for a server with + + This function configures the CCL query parser for a server with definitions of access points (CCL qualifiers) and their mapping to RPN. - - - To map a specific CCL query to RPN afterwards call the + + + To map a specific CCL query to RPN afterwards call the yaz_ccl_parse function. - + &reftitle.parameters; @@ -28,28 +28,28 @@ id - + The connection resource returned by yaz_connect. - + config - + An array of configuration. Each key of the array is the name of a CCL - field and the corresponding value holds a string that specifies a + field and the corresponding value holds a string that specifies a mapping to RPN. - - - The mapping is a sequence of attribute-type, attribute-value pairs. - Attribute-type and attribute-value is separated by an equal sign + + + The mapping is a sequence of attribute-type, attribute-value pairs. + Attribute-type and attribute-value is separated by an equal sign (=). Each pair is separated by white space. - - - Additional information can be found on the + + Additional information can be found on the CCL page. - + @@ -57,18 +57,18 @@ &reftitle.returnvalues; - + &return.void; - + &reftitle.examples; - + In the example below, the CCL parser is configured to support three CCL fields: ti, au and isbn. Each field is mapped to their BIB-1 equivalent. It is assumed that variable $id is the connection ID. - + CCL configuration diff --git a/reference/yaz/functions/yaz-ccl-parse.xml b/reference/yaz/functions/yaz-ccl-parse.xml index b6b0350cf..1da0eb305 100644 --- a/reference/yaz/functions/yaz-ccl-parse.xml +++ b/reference/yaz/functions/yaz-ccl-parse.xml @@ -13,15 +13,15 @@ stringquery arrayresult - + This function invokes a CCL parser. It converts a given CCL FIND query to - an RPN query which may be passed to the yaz_search + an RPN query which may be passed to the yaz_search function to perform a search. - - - To define a set of valid CCL fields call yaz_ccl_conf + + + To define a set of valid CCL fields call yaz_ccl_conf prior to this function. - + &reftitle.parameters; @@ -30,46 +30,46 @@ id - + The connection resource returned by yaz_connect. - + query - + The CCL FIND query. - + result - - If the function was executed successfully, this will be an array + + If the function was executed successfully, this will be an array containing the valid RPN query under the key rpn. - + Upon failure, three indexes are set in this array to indicate the cause - of failure: + of failure: - + errorcode - the CCL error code (integer) - - + + - + errorstring - the CCL error string - - + + - + errorpos - approximate position in query of failure (integer is character position) - - + + @@ -79,18 +79,18 @@ &reftitle.returnvalues; - + &return.success; - + &reftitle.examples; CCL Parsing - - We will try to search using CCL. In the example below, - $ccl is a CCL query. - + + We will try to search using CCL. In the example below, + $ccl is a CCL query. + boolyaz_close resourceid - + Closes the connection given by parameter id. - + - + This function will only close a non-persistent connection opened by setting the persistent option to &false; with yaz_connect. - + @@ -29,9 +29,9 @@ id - + The connection resource returned by yaz_connect. - + @@ -39,9 +39,9 @@ &reftitle.returnvalues; - + &return.success; - + &reftitle.seealso; diff --git a/reference/yaz/functions/yaz-connect.xml b/reference/yaz/functions/yaz-connect.xml index cbae972fb..285e6239d 100644 --- a/reference/yaz/functions/yaz-connect.xml +++ b/reference/yaz/functions/yaz-connect.xml @@ -14,22 +14,22 @@ stringzurl mixedoptions - + This function returns a connection resource on success, zero on failure. - - + + yaz_connect prepares for a connection to a - Z39.50 server. + Z39.50 server. This function is non-blocking and does not attempt to establish a connection - it merely prepares a connect to be performed later when yaz_wait is called. - + - + The YAZ proxy is a freely available Z39.50 proxy. - + @@ -39,123 +39,123 @@ zurl - + A string that takes the form host[:port][/database]. - If port is omitted, port 210 is used. If database is omitted + If port is omitted, port 210 is used. If database is omitted Default is used. - + options - - If given as a string, it is treated as the Z39.50 V2 authentication + + If given as a string, it is treated as the Z39.50 V2 authentication string (OpenAuth). - + If given as an array, the contents of the array serves as options. user - + Username for authentication. - + group - + Group for authentication. - + password - + Password for authentication. - + cookie - + Cookie for session (YAZ proxy). - + proxy - + Proxy for connection (YAZ proxy). - + persistent - + A boolean. If &true; the connection is persistent; If &false; the connection is not persistent. By default connections are persistent. - + - - If you open a persistent connection, you won't be able to close + + If you open a persistent connection, you won't be able to close it later with yaz_close. - + piggyback - + A boolean. If &true; piggyback is enabled for searches; If &false; piggyback is disabled. By default piggyback is enabled. - - - Enabling piggyback is more efficient and usually saves a - network-round-trip for first time fetches of records. However, a + + + Enabling piggyback is more efficient and usually saves a + network-round-trip for first time fetches of records. However, a few Z39.50 servers do not support piggyback or they ignore element set names. For those, piggyback should be disabled. - + charset - - A string that specifies character set to be used in Z39.50 + + A string that specifies character set to be used in Z39.50 language and character set negotiation. Use strings such as: - ISO-8859-1, UTF-8, + ISO-8859-1, UTF-8, UTF-16. - - + + Most Z39.50 servers do not support this feature (and thus, this is ignored). Many servers use the ISO-8859-1 encoding for queries and messages. MARC21/USMARC records are not affected by this setting. - + preferredMessageSize - + An integer that specifies the maximum byte size of all records to be returned by a target during retrieval. See the Z39.50 standard for more information. - + - + This option is supported in PECL YAZ 1.0.5 or later. - + @@ -163,16 +163,16 @@ maximumRecordSize - + An integer that specifies the maximum byte size of a single record to be returned by a target during retrieval. This entity is referred to as Exceptional-record-size in the Z39.50 standard. - + - + This option is supported in PECL YAZ 1.0.5 or later. - + @@ -186,9 +186,9 @@ &reftitle.returnvalues; - + A connection resource on success, &false; on error. - + &reftitle.seealso; diff --git a/reference/yaz/functions/yaz-database.xml b/reference/yaz/functions/yaz-database.xml index 6b240dc20..2631529dc 100644 --- a/reference/yaz/functions/yaz-database.xml +++ b/reference/yaz/functions/yaz-database.xml @@ -14,12 +14,12 @@ resourceid stringdatabases - - This function allows you to change databases within a session by + + This function allows you to change databases within a session by specifying one or more databases to be used in search, retrieval, etc. - - overriding databases specified in call to + - overriding databases specified in call to yaz_connect. - + &reftitle.parameters; @@ -28,18 +28,18 @@ id - + The connection resource returned by yaz_connect. - + databases - - A string containing one or more databases. Multiple databases are + + A string containing one or more databases. Multiple databases are separated by a plus sign +. - + @@ -47,9 +47,9 @@ &reftitle.returnvalues; - + &return.success; - + diff --git a/reference/yaz/functions/yaz-element.xml b/reference/yaz/functions/yaz-element.xml index bf5e40264..c1deefd7a 100644 --- a/reference/yaz/functions/yaz-element.xml +++ b/reference/yaz/functions/yaz-element.xml @@ -14,20 +14,20 @@ resourceid stringelementset - + This function sets the element set name for retrieval. - - + + Call this function before yaz_search or yaz_present to specify the element set name for records to be retrieved. - + - - If this function appears to have no effect, see the description of the - piggybacking option in + + If this function appears to have no effect, see the description of the + piggybacking option in yaz_connect. - + @@ -37,18 +37,18 @@ id - + The connection resource returned by yaz_connect. - + elementset - + Most servers support F (for full records) and B (for brief records). - + @@ -56,9 +56,9 @@ &reftitle.returnvalues; - + &return.success; - + diff --git a/reference/yaz/functions/yaz-errno.xml b/reference/yaz/functions/yaz-errno.xml index 7d2cd74c0..3aedfd827 100644 --- a/reference/yaz/functions/yaz-errno.xml +++ b/reference/yaz/functions/yaz-errno.xml @@ -11,15 +11,15 @@ intyaz_errno resourceid - + Returns an error number for the server (last request) identified by id. - - + + yaz_errno should be called after network activity for each server - (after yaz_wait returns) to determine the success or failure of the last operation (e.g. search). - + &reftitle.parameters; @@ -28,9 +28,9 @@ id - + The connection resource returned by yaz_connect. - + @@ -38,12 +38,12 @@ &reftitle.returnvalues; - + Returns an error code. The error code is either a Z39.50 diagnostic code - (usually a Bib-1 diagnostic) or a client side error code which is - generated by PHP/YAZ itself, such as "Connect failed", "Init Rejected", - etc. - + (usually a Bib-1 diagnostic) or a client side error code which is + generated by PHP/YAZ itself, such as "Connect failed", "Init Rejected", + etc. + &reftitle.seealso; diff --git a/reference/yaz/functions/yaz-error.xml b/reference/yaz/functions/yaz-error.xml index 2def601a9..5d998132b 100644 --- a/reference/yaz/functions/yaz-error.xml +++ b/reference/yaz/functions/yaz-error.xml @@ -11,11 +11,11 @@ stringyaz_error resourceid - + yaz_error returns an English text message corresponding to the last error number as returned by yaz_errno. - + &reftitle.parameters; @@ -24,9 +24,9 @@ id - + The connection resource returned by yaz_connect. - + @@ -34,11 +34,11 @@ &reftitle.returnvalues; - + Returns an error text message for server (last request), identified by parameter id. An empty string is returned if the last operation was successful. - + &reftitle.seealso; diff --git a/reference/yaz/functions/yaz-es-result.xml b/reference/yaz/functions/yaz-es-result.xml index 8acb4fdc7..8b28522d7 100644 --- a/reference/yaz/functions/yaz-es-result.xml +++ b/reference/yaz/functions/yaz-es-result.xml @@ -14,12 +14,12 @@ resourceid - + This function inspects the last returned Extended Service result from a server. An Extended Service is initiated by either yaz_item_order or yaz_es. - + @@ -29,9 +29,9 @@ id - + The connection resource returned by yaz_connect. - + @@ -40,11 +40,11 @@ &reftitle.returnvalues; - + Returns array with element targetReference for the reference for the extended service operation (generated and returned from the server). - + diff --git a/reference/yaz/functions/yaz-es.xml b/reference/yaz/functions/yaz-es.xml index bd2a9f491..228bd8356 100644 --- a/reference/yaz/functions/yaz-es.xml +++ b/reference/yaz/functions/yaz-es.xml @@ -27,18 +27,18 @@ as Record Update, Item Order, Database administration etc. - + Many Z39.50 Servers do not support Extended Services. - + - + The yaz_es creates an Extended Service Request packages and puts it into a queue of operations. Use yaz_wait to send the request(s) to the server. After completion of yaz_wait the result of the Extended Service operation should be expected with a call to yaz_es_result. - + &reftitle.parameters; @@ -47,16 +47,16 @@ id - + The connection resource returned by yaz_connect. - + type - - A string which represents the type of the Extended Service: + + A string which represents the type of the Extended Service: itemorder (Item Order), create (Create Database), drop (Drop Database), @@ -64,19 +64,19 @@ update (Update Record), xmlupdate (XML Update). Each type is specified in the following section. - + args - + An array with extended service options plus package specific options. The options are identical to those offered in the C API of ZOOM C. Refer to the ZOOM Extended Services. - + @@ -86,9 +86,9 @@ &reftitle.returnvalues; - + &return.void; - + diff --git a/reference/yaz/functions/yaz-get-option.xml b/reference/yaz/functions/yaz-get-option.xml index 36f0b7f60..38dea1705 100644 --- a/reference/yaz/functions/yaz-get-option.xml +++ b/reference/yaz/functions/yaz-get-option.xml @@ -12,9 +12,9 @@ resourceid stringname - + Returns the value of the option specified with name. - + &reftitle.parameters; @@ -23,17 +23,17 @@ id - + The connection resource returned by yaz_connect. - + name - + The option name. - + @@ -41,17 +41,17 @@ &reftitle.returnvalues; - + Returns the value of the specified option or an empty string if the option wasn't set. - + &reftitle.seealso; - The description of yaz_set_option for available + The description of yaz_set_option for available options diff --git a/reference/yaz/functions/yaz-hits.xml b/reference/yaz/functions/yaz-hits.xml index e2b4212a7..7469d7dab 100644 --- a/reference/yaz/functions/yaz-hits.xml +++ b/reference/yaz/functions/yaz-hits.xml @@ -12,10 +12,10 @@ resourceid arraysearchresult - + yaz_hits returns the number of hits for the last - search. - + search. + &reftitle.parameters; @@ -24,17 +24,17 @@ id - + The connection resource returned by yaz_connect. - + searchresult - + Result array for detailed search result information. - + @@ -42,11 +42,11 @@ &reftitle.returnvalues; - - Returns the number of hits for the last search or 0 if no search was + + Returns the number of hits for the last search or 0 if no search was performed. - - + + The search result array (if supplied) holds information that is returned by a Z39.50 server in the SearchResult-1 format part of a search response. @@ -55,7 +55,7 @@ In particular, it is possible to obtain hit counts for the individual search terms in a query. Information for first subquery is in $array[0], second subquery in $array[1], and so forth. - +
    searchresult members @@ -90,17 +90,17 @@ -
    + - + The SearchResult facility requires PECL YAZ 1.0.5 or later and YAZ 2.1.9 or later. - + - + Very few Z39.50 implementations support the SearchResult facility. - + diff --git a/reference/yaz/functions/yaz-itemorder.xml b/reference/yaz/functions/yaz-itemorder.xml index 507dad05d..393ec1cb1 100644 --- a/reference/yaz/functions/yaz-itemorder.xml +++ b/reference/yaz/functions/yaz-itemorder.xml @@ -14,12 +14,12 @@ resourceid arrayargs - + This function prepares for an Extended Services request using the Profile for the Use of Z39.50 Item Order Extended Service to Transport ILL (Profile/1). See this and the specification. - + &reftitle.parameters; @@ -28,23 +28,23 @@ id - + The connection resource returned by yaz_connect. - + args - - Must be an associative array with information about the Item Order - request to be sent. The key of the hash is the name of the + + Must be an associative array with information about the Item Order + request to be sent. The key of the hash is the name of the corresponding ASN.1 tag path. For example, the ISBN below the Item-ID - has the key item-id,ISBN. - - + has the key item-id,ISBN. + + The ILL-Request parameters are: - + protocol-version-num transaction-id,initial-requester-id,person-or-institution-symbol,person @@ -128,10 +128,10 @@ forward-flag requester-note forward-note - + There are also a few parameters that are part of the Extended Services Request package and the ItemOrder package: - + package-name user-id @@ -147,9 +147,9 @@ itemorder-item &reftitle.returnvalues; - + &return.void; - + diff --git a/reference/yaz/functions/yaz-present.xml b/reference/yaz/functions/yaz-present.xml index f4d6e18ee..a3f68a6c4 100644 --- a/reference/yaz/functions/yaz-present.xml +++ b/reference/yaz/functions/yaz-present.xml @@ -13,13 +13,13 @@ boolyaz_present resourceid - + This function prepares for retrieval of records after a successful search. - - + + The yaz_range function should be called prior to this - function to specify the range of records to be retrieved. - + function to specify the range of records to be retrieved. + &reftitle.parameters; @@ -28,9 +28,9 @@ id - + The connection resource returned by yaz_connect. - + @@ -38,9 +38,9 @@ &reftitle.returnvalues; - + &return.success; - + diff --git a/reference/yaz/functions/yaz-range.xml b/reference/yaz/functions/yaz-range.xml index 1b05e7324..a17e200d6 100644 --- a/reference/yaz/functions/yaz-range.xml +++ b/reference/yaz/functions/yaz-range.xml @@ -15,13 +15,13 @@ intstart intnumber - + Specifies a range of records to retrieve. - - - This function should be called before yaz_search or + + + This function should be called before yaz_search or yaz_present. - + &reftitle.parameters; @@ -30,26 +30,26 @@ id - + The connection resource returned by yaz_connect. - + start - - Specifies the position of the first record to be retrieved. The + + Specifies the position of the first record to be retrieved. The records numbers goes from 1 to yaz_hits. - + number - + Specifies the number of records to be retrieved. - + @@ -57,9 +57,9 @@ &reftitle.returnvalues; - + &return.void; - + diff --git a/reference/yaz/functions/yaz-record.xml b/reference/yaz/functions/yaz-record.xml index 9b4c7767a..454f11a08 100644 --- a/reference/yaz/functions/yaz-record.xml +++ b/reference/yaz/functions/yaz-record.xml @@ -13,11 +13,11 @@ intpos stringtype - + The yaz_record function inspects a record in the current result set at the position specified by parameter - pos. - + pos. + &reftitle.parameters; @@ -26,36 +26,36 @@ id - + The connection resource returned by yaz_connect. - + pos - + The record position. Records positions in a result set are numbered 1, 2, ... $hits where $hits is the count returned by yaz_hits. - + type - + The type specifies the form of the returned record. - + - + It is the application which is responsible for actually ensuring that the records are returned from the Z39.50/SRW server in the proper format. The type given only specifies a conversion to take place on the client side (in PHP/YAZ). - + - + Besides conversion of the transfer record to a string/array, PHP/YAZ it is also possible to perform a character set conversion of the record. Especially for USMARC/MARC21 that is recommended since @@ -63,108 +63,108 @@ not supported by browsers, etc. To specify a conversion, add ; charset=from, to where - from is the original character set + from is the original character set of the record and to is the resulting character set (as seen by PHP). - + string - + The record is returned as a string for simple display. In this mode, all MARC records are converted to a line-by-line format since ISO2709 is hardly readable. XML records and SUTRS are returned in their original format. GRS-1 are returned in a (ugly) line-by-line format. - - + + This format is suitable if records are to be displayed in a quick way - for debugging - or because it is not feasible to perform proper display. - + xml - + The record is returned as an XML string if possible. - In this mode, all MARC records are converted to + In this mode, all MARC records are converted to MARCXML. XML records and SUTRS are returned in their original format. GRS-1 is not supported. - - + + This format is similar to string except that MARC records are converted to MARCXML - - + + This format is suitable if records are processed by an XML parser or XSLT processor afterwards. - + raw - + The record is returned as a string in its original form. This type is suitable for MARC, XML and SUTRS. It does not work for GRS-1. - - + + MARC records are returned as a ISO2709 string. XML and SUTRS are returned as strings. - + syntax - + The syntax of the record is returned as a string, i.e. USmarc, GRS-1, XML, etc. - + database - + The name of database associated with record at the position is returned as a string. - + array - + The record is returned as an array that reflects the GRS-1 structure. This type is suitable for MARC and GRS-1. XML, SUTRS are not supported and if the actual record is XML or SUTRS an empty string will be returned. - - + + The array returned consists of a list corresponding to each leaf/internal node of GRS-1. Each list item consists a sub list with first element path and data (if data is available). - - + + The path which is a string holds a list of each tree component (of the structured GRS-1 record) from root to leaf. Each component is a tag type, tag value pair of the form (type, value - - + + String tags normally has a corresponding tag type 3. MARC can also be returned as an array (they are converted to GRS-1 internally). - + @@ -175,14 +175,14 @@ &reftitle.returnvalues; - + Returns the record at position pos or an empty string if no record exists at the given position. - - - If no database record exists at the given position an empty string is + + + If no database record exists at the given position an empty string is returned. - + &reftitle.examples; @@ -199,7 +199,7 @@ ]]> This record has two nodes at root level. First element at root level is - (4,52) [tag type 4, tag value 52], and has data Robert M. + (4,52) [tag type 4, tag value 52], and has data Robert M. Pirsig. Second element at root level (4,70) has a subtree with a single element (4,90). (4,90) has yet another sub tree (2,7) with data Transworld Publishers, ltd.. @@ -239,7 +239,7 @@ Array [0] => (4,70)(4,90)(2,7) [1] => Transworld Publishers, ltd. ) -) +) ]]> @@ -247,7 +247,7 @@ Array Working with MARCXML - The following PHP snippet returns a MARC21/USMARC record as MARCXML. + The following PHP snippet returns a MARC21/USMARC record as MARCXML. The original record is returned in marc-8 (unknown to most XML parsers), so we convert it to UTF-8 (which all XML parsers must support). @@ -258,13 +258,13 @@ $rec = yaz_record($id, $p, "xml; charset=marc-8,utf-8"); ]]> - - The record $rec can be processed with the + + The record $rec can be processed with the Sablotron XSLT processor as follows: - + -resourceid arrayresult - + yaz_scan_result returns terms and associated information as received from the server in the last performed yaz_scan. - + &reftitle.parameters; @@ -25,38 +25,38 @@ id - + The connection resource returned by yaz_connect. - + result - If given, this array will be modified to hold additional information + If given, this array will be modified to hold additional information taken from the Scan Response: - + number - Number of entries returned - - + + - + stepsize - Step size - - + + - + position - Position of term - - + + - + status - Scan status - - + + @@ -66,11 +66,11 @@ &reftitle.returnvalues; - - Returns an array (0..n-1) where n is the number of terms returned. Each - value is a pair where the first item is the term, and the second item is + + Returns an array (0..n-1) where n is the number of terms returned. Each + value is a pair where the first item is the term, and the second item is the result-count. - + diff --git a/reference/yaz/functions/yaz-scan.xml b/reference/yaz/functions/yaz-scan.xml index d2006b3be..945277580 100644 --- a/reference/yaz/functions/yaz-scan.xml +++ b/reference/yaz/functions/yaz-scan.xml @@ -14,17 +14,17 @@ stringstartterm arrayflags - - This function prepares for a Z39.50 Scan Request on the specified + + This function prepares for a Z39.50 Scan Request on the specified connection. - - + + To actually transfer the Scan Request to the server and receive the Scan Response, yaz_wait must be called. Upon completion of yaz_wait call yaz_error and yaz_scan_result to handle the response. - + &reftitle.parameters; @@ -33,48 +33,48 @@ id - + The connection resource returned by yaz_connect. - + type - + Currently only type rpn is supported. - + startterm - + Starting term point for the scan. - - + + The form in which the starting term is specified is given by parameter type. - - + + The syntax this parameter is similar to the RPN query as described in - yaz_search. It consists of zero or more - @attr-operator specifications, then followed by + yaz_search. It consists of zero or more + @attr-operator specifications, then followed by exactly one token. - + flags - - This optional parameter specifies additional information to control - the behaviour of the scan request. Three indexes are currently read + + This optional parameter specifies additional information to control + the behaviour of the scan request. Three indexes are currently read from the flags array: number (number of terms requested), position (preferred position of term) and stepSize (preferred step size). - + @@ -82,9 +82,9 @@ &reftitle.returnvalues; - + &return.void; - + &reftitle.examples; @@ -94,7 +94,7 @@ resourceid stringschema - + yaz_schema specifies the schema for retrieval. - - - This function should be called before + + + This function should be called before yaz_search or yaz_present. - + &reftitle.parameters; @@ -29,20 +29,20 @@ id - + The connection resource returned by yaz_connect. - + schema - - Must be specified as an OID (Object Identifier) in a raw dot-notation - (like 1.2.840.10003.13.4) or as one of the known - registered schemas: GILS-schema, + + Must be specified as an OID (Object Identifier) in a raw dot-notation + (like 1.2.840.10003.13.4) or as one of the known + registered schemas: GILS-schema, Holdings, Zthes, ... - + @@ -50,9 +50,9 @@ &reftitle.returnvalues; - + &return.void; - + diff --git a/reference/yaz/functions/yaz-search.xml b/reference/yaz/functions/yaz-search.xml index 8b972d52a..9390dc9ed 100644 --- a/reference/yaz/functions/yaz-search.xml +++ b/reference/yaz/functions/yaz-search.xml @@ -13,15 +13,15 @@ stringtype stringquery - - yaz_search prepares for a search on the given + + yaz_search prepares for a search on the given connection. - - + + Like yaz_connect this function is non-blocking and - only prepares for a search to be executed later when + only prepares for a search to be executed later when yaz_wait is called. - + &reftitle.parameters; @@ -30,25 +30,25 @@ id - + The connection resource returned by yaz_connect. - + type - + This parameter represents the query type - only "rpn" - is supported now in which case the third argument specifies a Type-1 - query in prefix query notation. - + is supported now in which case the third argument specifies a Type-1 + query in prefix query notation. + query - + The RPN query is a textual representation of the Type-1 query as defined by the Z39.50 standard. However, in the text representation as used by YAZ a prefix notation is used, that is the operator @@ -56,7 +56,7 @@ white space is ignored unless surrounded by double quotes. Tokens beginning with an at-character (@) are considered operators, otherwise they are treated as search terms. - + RPN Operators @@ -95,25 +95,25 @@ @attr [set] type=value query - applies attribute to query. The type and value are integers - specifying the attribute-type and attribute-value respectively. + applies attribute to query. The type and value are integers + specifying the attribute-type and attribute-value respectively. The set, if given, specifies the attribute-set. -
    - - You can find information about attributes at the + + + You can find information about attributes at the Z39.50 Maintenance Agency site. - + - + If you would like to use a more friendly notation, - use the CCL parser - functions yaz_ccl_conf and + use the CCL parser - functions yaz_ccl_conf and yaz_ccl_parse. - +     @@ -122,9 +122,9 @@     &reftitle.returnvalues; - + &return.success; - + &reftitle.examples; @@ -137,11 +137,11 @@ computer ]]> - which matches documents where "computer" occur. No attributes are + which matches documents where "computer" occur. No attributes are specified. - The query + The query - would in infix notation look like (a or b) and ((c or d) not + would in infix notation look like (a or b) and ((c or d) not e). diff --git a/reference/yaz/functions/yaz-set-option.xml b/reference/yaz/functions/yaz-set-option.xml index ab399d3c1..a3f578872 100644 --- a/reference/yaz/functions/yaz-set-option.xml +++ b/reference/yaz/functions/yaz-set-option.xml @@ -18,9 +18,9 @@ resourceid arrayoptions - + Sets one or more options on the given connection. - + &reftitle.parameters; @@ -29,25 +29,25 @@ id - + The connection resource returned by yaz_connect. - + name or options - + May be either a string or an array. - - + + If given as a string, this will be the name of the option to set. You'll need to give it's value. - - - If given as an array, this will be an associative array (option name + + + If given as an array, this will be an associative array (option name => option value). - + PHP/YAZ Connection Options @@ -76,7 +76,7 @@ schema schema for retrieval. By default, no schema is used. Setting this - option is equivalent to using function + option is equivalent to using function yaz_schema @@ -84,14 +84,14 @@ preferredRecordSyntax record syntax for retrieval. By default, no syntax is used. Setting - this option is equivalent to using function + this option is equivalent to using function yaz_syntax start - offset for first record to be retrieved via + offset for first record to be retrieved via yaz_search or yaz_present. First record is numbered has a start value of 0. Second record has start value 1. @@ -121,10 +121,10 @@ value - + The new value of the option. Use this only if the previous argument is a string. - + @@ -132,9 +132,9 @@ &reftitle.returnvalues; - + &return.void; - + diff --git a/reference/yaz/functions/yaz-sort.xml b/reference/yaz/functions/yaz-sort.xml index 6c5e7a3bb..15405606e 100644 --- a/reference/yaz/functions/yaz-sort.xml +++ b/reference/yaz/functions/yaz-sort.xml @@ -12,16 +12,16 @@ resourceid stringcriteria - + This function sets sorting criteria and enables Z39.50 Sort. - - + + Call this function before yaz_search. Using this function alone does not have any effect. When used in conjunction with yaz_search, a Z39.50 Sort will be sent after a search response has been received and before any records are retrieved with - Z39.50 Present (yaz_present. - + Z39.50 Present (yaz_present. + &reftitle.parameters; @@ -30,59 +30,59 @@ id - + The connection resource returned by yaz_connect. - + criteria - - A string that takes the form field1 flags1 field2 + + A string that takes the form field1 flags1 field2 flags2 where field1 specifies the primary attributes for - sort, field2 seconds, etc.. - - + sort, field2 seconds, etc.. + + The field specifies either a numerical attribute combinations consisting of type=value pairs separated by comma (e.g. 1=4,2=1) - ; or the field may specify a plain string criteria (e.g. - title. The flags is a sequence of the following + ; or the field may specify a plain string criteria (e.g. + title. The flags is a sequence of the following characters which may not be separated by any white space. - + Sort Flags a - + Sort ascending - + d - + Sort descending - + i - + Case insensitive sorting - + s - + Case sensitive sorting - + @@ -94,9 +94,9 @@ &reftitle.returnvalues; - + &return.void; - + &reftitle.examples; @@ -112,7 +112,7 @@ - If the secondary sorting criteria should be author, case sensitive and + If the secondary sorting criteria should be author, case sensitive and ascending you would use: resourceid stringsyntax - + yaz_syntax specifies the preferred record syntax for retrieval - - - This function should be called before yaz_search or + + + This function should be called before yaz_search or yaz_present. - + &reftitle.parameters; @@ -30,19 +30,19 @@ id - + The connection resource returned by yaz_connect. - + syntax - + The syntax must be specified as an OID (Object Identifier) in a raw dot-notation (like 1.2.840.10003.5.10) or as one of - the known registered record syntaxes (sutrs, usmarc, grs1, xml, etc.). - + the known registered record syntaxes (sutrs, usmarc, grs1, xml, etc.). + @@ -50,9 +50,9 @@ &reftitle.returnvalues; - + &return.void; - + diff --git a/reference/yaz/functions/yaz-wait.xml b/reference/yaz/functions/yaz-wait.xml index 3fb05130d..8cfa8be2c 100644 --- a/reference/yaz/functions/yaz-wait.xml +++ b/reference/yaz/functions/yaz-wait.xml @@ -11,17 +11,17 @@ mixedyaz_wait arrayoptions - + This function carries out networked (blocked) activity for outstanding - requests which have been prepared by the functions - yaz_connect, yaz_search, - yaz_present, yaz_scan and + requests which have been prepared by the functions + yaz_connect, yaz_search, + yaz_present, yaz_scan and yaz_itemorder. - - + + yaz_wait returns when all servers have either completed all requests or aborted (in case of errors). - + &reftitle.parameters; @@ -36,19 +36,19 @@ timeout - + Sets timeout in seconds. If a server has not responded within the timeout it is considered dead and yaz_wait returns. The default value for timeout is 15 seconds. - + event - + A boolean. - + @@ -60,10 +60,10 @@ &reftitle.returnvalues; - + &return.success; In event mode, returns resource &return.falseforfailure;. - + diff --git a/reference/yaz/setup.xml b/reference/yaz/setup.xml index 1794435d2..0aff5fe65 100644 --- a/reference/yaz/setup.xml +++ b/reference/yaz/setup.xml @@ -7,13 +7,13 @@
    &reftitle.required; - + Obtain YAZ (ANSI/NISO Z39.50 support) and install it. YAZ can be fetched in source or in various prebuilt packages from the YAZ archive. Systems such as Debian GNU/Linux, Suse Linux, FreeBSD also has YAZ as part of their distribution. - +
    diff --git a/reference/zmq/book.xml b/reference/zmq/book.xml index bc7d18d23..68432dd0d 100644 --- a/reference/zmq/book.xml +++ b/reference/zmq/book.xml @@ -13,9 +13,9 @@ &warn.experimental; "ØMQ is a software library that lets you quickly design and implement a fast message-based application." --0MQ Website - + For more information about 0MQ, see &url.zeromq;. - + &reference.zmq.setup; diff --git a/reference/zmq/setup.xml b/reference/zmq/setup.xml index fca5c22d7..c98397ef7 100644 --- a/reference/zmq/setup.xml +++ b/reference/zmq/setup.xml @@ -6,21 +6,21 @@
    &reftitle.required; - + ZMQ extension requires 0MQ version 2.0.7 or higher. 0MQ can be acquired from &url.zeromq;area:download. - +
    &reftitle.install; - + &pecl.info.dead; &url.pecl.package;zmq - - + + &pecl.windows.download.avail; - +
    diff --git a/reference/zmq/zmq.xml b/reference/zmq/zmq.xml index f4cc7482a..cfb08eac8 100644 --- a/reference/zmq/zmq.xml +++ b/reference/zmq/zmq.xml @@ -11,9 +11,9 @@
    &reftitle.intro; - + - +
    @@ -335,416 +335,416 @@ ZMQ::SOCKET_PAIR - Exclusive pair pattern + Exclusive pair pattern ZMQ::SOCKET_PUB - Publisher socket + Publisher socket ZMQ::SOCKET_SUB - Subscriber socket + Subscriber socket ZMQ::SOCKET_REQ - Request socket + Request socket ZMQ::SOCKET_REP - Reply socket + Reply socket ZMQ::SOCKET_XREQ - Alias for SOCKET_DEALER + Alias for SOCKET_DEALER ZMQ::SOCKET_XREP - Alias for SOCKET_ROUTER + Alias for SOCKET_ROUTER ZMQ::SOCKET_PUSH - Pipeline upstream push socket + Pipeline upstream push socket ZMQ::SOCKET_PULL - Pipeline downstream pull socket + Pipeline downstream pull socket ZMQ::SOCKET_ROUTER - Extended REP socket that can route replies to requesters + Extended REP socket that can route replies to requesters ZMQ::SOCKET_DEALER - Extended REQ socket that load balances to all connected peers + Extended REQ socket that load balances to all connected peers ZMQ::SOCKET_XPUB - Similar to SOCKET_PUB, except you can receive subscriptions as messages. - The subscription message is 0 (unsubscribe) or 1 (subscribe) followed by the topic. + Similar to SOCKET_PUB, except you can receive subscriptions as messages. + The subscription message is 0 (unsubscribe) or 1 (subscribe) followed by the topic. ZMQ::SOCKET_XSUB - Similar to SOCKET_SUB, except you can send subscriptions as messages. See SOCKET_XPUB for format. + Similar to SOCKET_SUB, except you can send subscriptions as messages. See SOCKET_XPUB for format. ZMQ::SOCKET_STREAM - Used to send and receive TCP data from a non-ØMQ peer. Available if compiled against ZeroMQ 4.x or higher (Value: &integer;). + Used to send and receive TCP data from a non-ØMQ peer. Available if compiled against ZeroMQ 4.x or higher (Value: &integer;). ZMQ::SOCKOPT_HWM - The high water mark for inbound and outbound messages is a hard limit on the maximum number of outstanding messages ØMQ shall queue in memory for any single peer that the specified socket is communicating with. Setting this option on a socket will only affect connections made after the option has been set. On ZeroMQ 3.x this is a wrapper for setting both SNDHWM and RCVHWM. (Value: &integer;). + The high water mark for inbound and outbound messages is a hard limit on the maximum number of outstanding messages ØMQ shall queue in memory for any single peer that the specified socket is communicating with. Setting this option on a socket will only affect connections made after the option has been set. On ZeroMQ 3.x this is a wrapper for setting both SNDHWM and RCVHWM. (Value: &integer;). ZMQ::SOCKOPT_SNDHWM - The ZMQ_SNDHWM option shall set the high water mark for outbound messages on the specified socket. Available if compiled against ZeroMQ 3.x or higher (Value: &integer;). + The ZMQ_SNDHWM option shall set the high water mark for outbound messages on the specified socket. Available if compiled against ZeroMQ 3.x or higher (Value: &integer;). ZMQ::SOCKOPT_RCVHWM - The SOCKOPT_RCVHWM option shall set the high water mark for inbound messages on the specified socket. Available if compiled against ZeroMQ 3.x or higher (Value: &integer;). + The SOCKOPT_RCVHWM option shall set the high water mark for inbound messages on the specified socket. Available if compiled against ZeroMQ 3.x or higher (Value: &integer;). ZMQ::SOCKOPT_AFFINITY - Set I/O thread affinity (Value: &integer;) + Set I/O thread affinity (Value: &integer;) ZMQ::SOCKOPT_IDENTITY - Set socket identity (Value: &string;) + Set socket identity (Value: &string;) ZMQ::SOCKOPT_SUBSCRIBE - Establish message filter. Valid for subscriber socket (Value: &string;) + Establish message filter. Valid for subscriber socket (Value: &string;) ZMQ::SOCKOPT_UNSUBSCRIBE - Remove message filter. Valid for subscriber socket (Value: &string;) + Remove message filter. Valid for subscriber socket (Value: &string;) ZMQ::SOCKOPT_RATE - Set rate for multicast sockets (pgm) (Value: &integer; >= 0) + Set rate for multicast sockets (pgm) (Value: &integer; >= 0) ZMQ::SOCKOPT_RECOVERY_IVL - Set multicast recovery interval (Value: &integer; >= 0) + Set multicast recovery interval (Value: &integer; >= 0) ZMQ::SOCKOPT_RECONNECT_IVL - Set the initial reconnection interval (Value: &integer; >= 0) + Set the initial reconnection interval (Value: &integer; >= 0) ZMQ::SOCKOPT_RECONNECT_IVL_MAX - Set the max reconnection interval (Value: &integer; >= 0) + Set the max reconnection interval (Value: &integer; >= 0) ZMQ::SOCKOPT_MCAST_LOOP - Control multicast loopback (Value: &integer; >= 0) + Control multicast loopback (Value: &integer; >= 0) ZMQ::SOCKOPT_SNDBUF - Set kernel transmit buffer size (Value: &integer; >= 0) + Set kernel transmit buffer size (Value: &integer; >= 0) ZMQ::SOCKOPT_RCVBUF - Set kernel receive buffer size (Value: &integer; >= 0) + Set kernel receive buffer size (Value: &integer; >= 0) ZMQ::SOCKOPT_RCVMORE - Receive multi-part messages (Value: &integer;) + Receive multi-part messages (Value: &integer;) ZMQ::SOCKOPT_TYPE - Get the socket type. Valid for getSockOpt (Value: &integer;) + Get the socket type. Valid for getSockOpt (Value: &integer;) ZMQ::SOCKOPT_LINGER - The linger value of the socket. Specifies how long the socket blocks - trying flush messages after it has been closed (Value: &integer;) + The linger value of the socket. Specifies how long the socket blocks + trying flush messages after it has been closed (Value: &integer;) ZMQ::SOCKOPT_BACKLOG - The SOCKOPT_BACKLOG option shall set the maximum length of the queue of outstanding peer connections for the specified socket; this only applies to connection-oriented transports. (Value: &integer;) + The SOCKOPT_BACKLOG option shall set the maximum length of the queue of outstanding peer connections for the specified socket; this only applies to connection-oriented transports. (Value: &integer;) ZMQ::SOCKOPT_MAXMSGSIZE - Limits the maximum size of the inbound message. Value -1 means no limit. Available if compiled against ZeroMQ 3.x or higher (Value: &integer;) + Limits the maximum size of the inbound message. Value -1 means no limit. Available if compiled against ZeroMQ 3.x or higher (Value: &integer;) ZMQ::SOCKOPT_SNDTIMEO - Sets the timeout for send operation on the socket. Value -1 means no limit. Available if compiled against ZeroMQ 3.x or higher (Value: &integer;) + Sets the timeout for send operation on the socket. Value -1 means no limit. Available if compiled against ZeroMQ 3.x or higher (Value: &integer;) ZMQ::SOCKOPT_RCVTIMEO - Sets the timeout for receive operation on the socket. Value -1 means no limit. Available if compiled against ZeroMQ 3.x or higher (Value: &integer;) + Sets the timeout for receive operation on the socket. Value -1 means no limit. Available if compiled against ZeroMQ 3.x or higher (Value: &integer;) ZMQ::SOCKOPT_IPV4ONLY - Disable IPV6 support if 1. Available if compiled against ZeroMQ 3.x (Value: &integer;) + Disable IPV6 support if 1. Available if compiled against ZeroMQ 3.x (Value: &integer;) ZMQ::SOCKOPT_LAST_ENDPOINT - Retrieve the last connected endpoint - for use with * wildcard ports. Available if compiled against ZeroMQ 3.x or higher (Value: &string;) + Retrieve the last connected endpoint - for use with * wildcard ports. Available if compiled against ZeroMQ 3.x or higher (Value: &string;) ZMQ::SOCKOPT_TCP_KEEPALIVE_IDLE - Idle time for TCP keepalive. Available if compiled against ZeroMQ 3.x or higher (Value: &integer;) + Idle time for TCP keepalive. Available if compiled against ZeroMQ 3.x or higher (Value: &integer;) ZMQ::SOCKOPT_TCP_KEEPALIVE_CNT - Count time for TCP keepalive. Available if compiled against ZeroMQ 3.x or higher (Value: &integer;) + Count time for TCP keepalive. Available if compiled against ZeroMQ 3.x or higher (Value: &integer;) ZMQ::SOCKOPT_TCP_KEEPALIVE_INTVL - Interval for TCP keepalive. Available if compiled against ZeroMQ 3.x or higher (Value: &integer;) + Interval for TCP keepalive. Available if compiled against ZeroMQ 3.x or higher (Value: &integer;) ZMQ::SOCKOPT_DELAY_ATTACH_ON_CONNECT - Set a CIDR string to match against incoming TCP connections. Available if compiled against ZeroMQ 3.x or higher (Value: &string;) + Set a CIDR string to match against incoming TCP connections. Available if compiled against ZeroMQ 3.x or higher (Value: &string;) ZMQ::SOCKOPT_TCP_ACCEPT_FILTER - Set a CIDR string to match against incoming TCP connections. Available if compiled against ZeroMQ 3.x or higher (Value: &string;) + Set a CIDR string to match against incoming TCP connections. Available if compiled against ZeroMQ 3.x or higher (Value: &string;) ZMQ::SOCKOPT_XPUB_VERBOSE - Set the XPUB to receive an application message on each instance of a subscription. Available if compiled against ZeroMQ 3.x or higher (Value: &string;) + Set the XPUB to receive an application message on each instance of a subscription. Available if compiled against ZeroMQ 3.x or higher (Value: &string;) ZMQ::SOCKOPT_ROUTER_RAW - Sets the raw mode on the ROUTER, when set to 1. In raw mode when using tcp:// transport the socket will read and write without ZeroMQ framing. - Available if compiled against ZeroMQ 4.0 or higher (Value: &string;) + Sets the raw mode on the ROUTER, when set to 1. In raw mode when using tcp:// transport the socket will read and write without ZeroMQ framing. + Available if compiled against ZeroMQ 4.0 or higher (Value: &string;) ZMQ::SOCKOPT_IPV6 - Enable IPV6. Available if compiled against ZeroMQ 4.0 or higher (Value: &string;) + Enable IPV6. Available if compiled against ZeroMQ 4.0 or higher (Value: &string;) ZMQ::CTXOPT_MAX_SOCKETS - The socket limit for this context. Available if compiled against ZeroMQ 3.x or higher (Value: &integer;) + The socket limit for this context. Available if compiled against ZeroMQ 3.x or higher (Value: &integer;) ZMQ::POLL_IN - Poll for incoming data + Poll for incoming data ZMQ::POLL_OUT - Poll for outgoing data + Poll for outgoing data ZMQ::MODE_NOBLOCK - Non-blocking operation. Deprecated, use ZMQ::MODE_DONTWAIT instead + Non-blocking operation. Deprecated, use ZMQ::MODE_DONTWAIT instead ZMQ::MODE_DONTWAIT - Non-blocking operation + Non-blocking operation ZMQ::MODE_SNDMORE - Send multi-part message + Send multi-part message ZMQ::DEVICE_FORWARDER - Forwarder device + Forwarder device ZMQ::DEVICE_QUEUE - Queue device + Queue device ZMQ::DEVICE_STREAMER - Streamer device + Streamer device ZMQ::ERR_INTERNAL - ZMQ extension internal error + ZMQ extension internal error ZMQ::ERR_EAGAIN - Implies that the operation would block when ZMQ::MODE_DONTWAIT is used + Implies that the operation would block when ZMQ::MODE_DONTWAIT is used ZMQ::ERR_ENOTSUP - The operation is not supported by the socket type + The operation is not supported by the socket type ZMQ::ERR_EFSM - The operation can not be executed because the socket is not in correct state + The operation can not be executed because the socket is not in correct state ZMQ::ERR_ETERM - The context has been terminated + The context has been terminated diff --git a/reference/zmq/zmq/construct.xml b/reference/zmq/zmq/construct.xml index b1e0db4ec..18a794f33 100644 --- a/reference/zmq/zmq/construct.xml +++ b/reference/zmq/zmq/construct.xml @@ -13,9 +13,9 @@ private ZMQ::__construct - + Private constructor to prevent direct initialization. This class holds the constants for ZMQ extension. - + @@ -25,8 +25,8 @@ &reftitle.returnvalues; - - + + diff --git a/reference/zmq/zmqcontext.xml b/reference/zmq/zmqcontext.xml index 708619fe4..b447b28c1 100644 --- a/reference/zmq/zmqcontext.xml +++ b/reference/zmq/zmqcontext.xml @@ -11,9 +11,9 @@
    &reftitle.intro; - + - +
    @@ -31,7 +31,7 @@ - + &Methods; diff --git a/reference/zmq/zmqcontext/construct.xml b/reference/zmq/zmqcontext/construct.xml index 1fe671965..86dab2ecc 100644 --- a/reference/zmq/zmqcontext/construct.xml +++ b/reference/zmq/zmqcontext/construct.xml @@ -14,10 +14,10 @@ intio_threads1 boolis_persistent&true; - - Constructs a new ZMQ context. The context is used to initialize sockets. A persistent context is required - to initialize persistent sockets. - + + Constructs a new ZMQ context. The context is used to initialize sockets. A persistent context is required + to initialize persistent sockets. +     @@ -27,18 +27,18 @@ io_threads - + Number of io-threads in the context. - + is_persistent - + Whether the context is persistent. Persistent context is stored over multiple requests and is a requirement for persistent sockets. - + @@ -47,9 +47,9 @@ &reftitle.errors; - - Throws ZMQContextException if context initialization fails. - + + Throws ZMQContextException if context initialization fails. + @@ -57,9 +57,9 @@ A <function>ZMQContext</function> example - + Construct a new context and allocate request socket from it - + public mixedZMQContext::getOpt stringkey - - Returns the value of a context option. - + + Returns the value of a context option. + @@ -25,10 +25,10 @@ key - + An integer representing the option. See the ZMQ::CTXOPT_* constants. - + @@ -37,10 +37,10 @@ &reftitle.returnvalues; - + Returns either a &string; or an &integer; depending on key. Throws - ZMQContextException on error. - + ZMQContextException on error. + diff --git a/reference/zmq/zmqcontext/getsocket.xml b/reference/zmq/zmqcontext/getsocket.xml index 1aa6e0dab..ad349711a 100644 --- a/reference/zmq/zmqcontext/getsocket.xml +++ b/reference/zmq/zmqcontext/getsocket.xml @@ -15,11 +15,11 @@ stringpersistent_id&null; callableon_new_socket&null; - - Shortcut for creating new sockets from the context. If the context is not persistent the persistent_id + + Shortcut for creating new sockets from the context. If the context is not persistent the persistent_id parameter is ignored and the socket falls back to being non-persistent. The on_new_socket is called only when a new underlying socket structure is created. - + @@ -29,26 +29,26 @@ type - + ZMQ::SOCKET_* constant to specify socket type. - + persistent_id - + If persistent_id is specified the socket will be persisted over multiple requests. - + on_new_socket - + Callback function, which is executed when a new socket structure is created. This function does not get invoked if the underlying persistent connection is re-used. The callback takes ZMQSocket and persistent_id as two arguments. - + @@ -57,16 +57,16 @@ &reftitle.returnvalues; - + Returns a ZMQSocket object. - + &reftitle.errors; - - Throws ZMQSocketException on error. - + + Throws ZMQSocketException on error. + @@ -74,9 +74,9 @@ A <function>ZMQContext</function> example - + Basic usage - + public boolZMQContext::isPersistent - + Whether the context is persistent. Persistent context is needed for persistent connections as each socket is allocated from a context. - + @@ -26,9 +26,9 @@ &reftitle.returnvalues; - + Returns &true; if the context is persistent and &false; if the context is non-persistent. - + diff --git a/reference/zmq/zmqcontext/setopt.xml b/reference/zmq/zmqcontext/setopt.xml index 15a42ccb8..22ffef86d 100644 --- a/reference/zmq/zmqcontext/setopt.xml +++ b/reference/zmq/zmqcontext/setopt.xml @@ -14,10 +14,10 @@ intkey mixedvalue - + Sets a ZMQ context option. The type of the value depends on the key. See ZMQ Constant Types for more information. - + @@ -27,17 +27,17 @@ key - + One of the ZMQ::CTXOPT_* constants. - + value - + The value of the parameter. - + @@ -46,9 +46,9 @@ &reftitle.returnvalues; - + Returns the current object. Throws ZMQContextException on error. - + diff --git a/reference/zmq/zmqcontextexception.xml b/reference/zmq/zmqcontextexception.xml index 8e744abec..b44af1c99 100644 --- a/reference/zmq/zmqcontextexception.xml +++ b/reference/zmq/zmqcontextexception.xml @@ -11,9 +11,9 @@
    &reftitle.intro; - + - +
    @@ -55,25 +55,25 @@ message - + code - + file - + line - + diff --git a/reference/zmq/zmqdevice.xml b/reference/zmq/zmqdevice.xml index 0f3c0da36..0fe50ab11 100644 --- a/reference/zmq/zmqdevice.xml +++ b/reference/zmq/zmqdevice.xml @@ -11,9 +11,9 @@
    &reftitle.intro; - + - +
    @@ -31,7 +31,7 @@ - + &Methods; diff --git a/reference/zmq/zmqdevice/construct.xml b/reference/zmq/zmqdevice/construct.xml index 98d6c044d..d79758a3b 100644 --- a/reference/zmq/zmqdevice/construct.xml +++ b/reference/zmq/zmqdevice/construct.xml @@ -15,9 +15,9 @@ ZMQSocketbackend ZMQSocketlistener - + "ØMQ devices can do intermediation of addresses, services, queues, or any other abstraction you care to define above the message and socket layers." -- zguide - +     @@ -26,28 +26,28 @@ frontend - + Frontend parameter for the devices. Usually where there messages are coming. - + backend - + Backend parameter for the devices. Usually where there messages going to. - + listener - + Listener socket, which receives a copy of all messages going both directions. The type of this socket should be SUB, PULL or DEALER. - + @@ -55,11 +55,11 @@ &reftitle.returnvalues; - + Call to this method will prepare the device. Usually devices are very long running processes so running this method from interactive script is not recommended. This method throw ZMQDeviceException if the device cannot be started. - + diff --git a/reference/zmq/zmqdevice/getidletimeout.xml b/reference/zmq/zmqdevice/getidletimeout.xml index 90d70b05f..0454cb78d 100644 --- a/reference/zmq/zmqdevice/getidletimeout.xml +++ b/reference/zmq/zmqdevice/getidletimeout.xml @@ -13,9 +13,9 @@ public ZMQDeviceZMQDevice::getIdleTimeout - + Gets the idle callback timeout value. Added in ZMQ extension version 1.1.0. - + @@ -25,9 +25,9 @@ &reftitle.returnvalues; - + This method returns the idle callback timeout value. - + diff --git a/reference/zmq/zmqdevice/gettimertimeout.xml b/reference/zmq/zmqdevice/gettimertimeout.xml index 535b19739..b9c69ffc3 100644 --- a/reference/zmq/zmqdevice/gettimertimeout.xml +++ b/reference/zmq/zmqdevice/gettimertimeout.xml @@ -13,9 +13,9 @@ public ZMQDeviceZMQDevice::getTimerTimeout - + Gets the timer callback timeout value. Added in ZMQ extension version 1.1.0. - + @@ -25,9 +25,9 @@ &reftitle.returnvalues; - + This method returns the timer timeout value. - + diff --git a/reference/zmq/zmqdevice/run.xml b/reference/zmq/zmqdevice/run.xml index 06ff8c2f9..00a2621f6 100644 --- a/reference/zmq/zmqdevice/run.xml +++ b/reference/zmq/zmqdevice/run.xml @@ -13,9 +13,9 @@ public voidZMQDevice::run - + Runs the device. - + @@ -25,11 +25,11 @@ &reftitle.returnvalues; - + Call to this method will block until the device is running. It is not recommended that devices are used from interactive scripts. On failure this method will throw ZMQDeviceException. - + diff --git a/reference/zmq/zmqdevice/setidlecallback.xml b/reference/zmq/zmqdevice/setidlecallback.xml index 0ea5342bb..e350f89d1 100644 --- a/reference/zmq/zmqdevice/setidlecallback.xml +++ b/reference/zmq/zmqdevice/setidlecallback.xml @@ -15,13 +15,13 @@ inttimeout mixeduser_data - + Sets the idle callback function. If idle timeout is defined the idle callback function shall be called if the internal poll loop times out without events. If the callback function returns false or a value that evaluates to false the device is stopped. The callback function signature is callback (mixed $user_data). - + @@ -30,30 +30,30 @@ cb_func - + Callback function to invoke when the device is idle. Returning false - or a value that evaluates to false from this function will cause the + or a value that evaluates to false from this function will cause the device to stop. - + timeout - + How often to invoke the idle callback in milliseconds. The idle callback is invoked periodically when there is no activity on the device. The timeout value guarantees that there is at least this amount of milliseconds between invocations of the callback function. - + user_data - + Additional data to pass to the callback function. - + @@ -61,9 +61,9 @@ &reftitle.returnvalues; - + On success this method returns the current object. - + diff --git a/reference/zmq/zmqdevice/setidletimeout.xml b/reference/zmq/zmqdevice/setidletimeout.xml index 2f046330c..09c590998 100644 --- a/reference/zmq/zmqdevice/setidletimeout.xml +++ b/reference/zmq/zmqdevice/setidletimeout.xml @@ -13,10 +13,10 @@ public ZMQDeviceZMQDevice::setIdleTimeout inttimeout - + Sets the idle callback timeout value. The idle callback is invoked periodically when the device is idle. - + @@ -25,9 +25,9 @@ timeout - + The idle callback timeout value. - + @@ -35,9 +35,9 @@ &reftitle.returnvalues; - + On success this method returns the current object. - + diff --git a/reference/zmq/zmqdevice/settimercallback.xml b/reference/zmq/zmqdevice/settimercallback.xml index ee7179107..8ddf49452 100644 --- a/reference/zmq/zmqdevice/settimercallback.xml +++ b/reference/zmq/zmqdevice/settimercallback.xml @@ -15,13 +15,13 @@ inttimeout mixeduser_data - + Sets the timer callback function. The timer callback will be invoked after timeout has passed. The difference between idle and timer callbacks are that idle callback is invoked only when the device is idle. The callback function signature is callback (mixed $user_data). Added in ZMQ extension version 1.1.0. - + @@ -32,7 +32,7 @@ Callback function to invoke when the timer fires. Returning false - or a value that evaluates to false from this function will cause the + or a value that evaluates to false from this function will cause the device to stop. @@ -51,9 +51,9 @@ user_data - + Additional data to pass to the callback function. - + @@ -61,9 +61,9 @@ &reftitle.returnvalues; - + On success this method returns the current object. - + diff --git a/reference/zmq/zmqdevice/settimertimeout.xml b/reference/zmq/zmqdevice/settimertimeout.xml index 269d0e8e0..1325eb5f6 100644 --- a/reference/zmq/zmqdevice/settimertimeout.xml +++ b/reference/zmq/zmqdevice/settimertimeout.xml @@ -13,10 +13,10 @@ public ZMQDeviceZMQDevice::setTimerTimeout inttimeout - + Sets the timer callback timeout value. The timer callback is invoked periodically if it's set. Added in ZMQ extension version 1.1.0. - + @@ -25,9 +25,9 @@ timeout - + The timer callback timeout value. - + @@ -35,9 +35,9 @@ &reftitle.returnvalues; - + On success this method returns the current object. - + diff --git a/reference/zmq/zmqdeviceexception.xml b/reference/zmq/zmqdeviceexception.xml index e95f91086..6e0d31529 100644 --- a/reference/zmq/zmqdeviceexception.xml +++ b/reference/zmq/zmqdeviceexception.xml @@ -11,9 +11,9 @@
    &reftitle.intro; - + - +
    @@ -55,25 +55,25 @@ message - + code - + file - + line - + diff --git a/reference/zmq/zmqexception.xml b/reference/zmq/zmqexception.xml index 3e13057ef..71d88c575 100644 --- a/reference/zmq/zmqexception.xml +++ b/reference/zmq/zmqexception.xml @@ -11,9 +11,9 @@
    &reftitle.intro; - + - +
    @@ -55,25 +55,25 @@ message - + code - + file - + line - + diff --git a/reference/zmq/zmqpoll.xml b/reference/zmq/zmqpoll.xml index 512c0e41c..a35cf27e7 100644 --- a/reference/zmq/zmqpoll.xml +++ b/reference/zmq/zmqpoll.xml @@ -11,9 +11,9 @@
    &reftitle.intro; - + - +
    @@ -31,7 +31,7 @@ - + &Methods; diff --git a/reference/zmq/zmqpoll/add.xml b/reference/zmq/zmqpoll/add.xml index d75662f7c..d99131f60 100644 --- a/reference/zmq/zmqpoll/add.xml +++ b/reference/zmq/zmqpoll/add.xml @@ -14,10 +14,10 @@ mixedentry inttype - + Adds a new item to the poll set and returns the internal id of the added item. The item can be removed from the poll set using the returned string id. - +     @@ -27,18 +27,18 @@ entry - + ZMQSocket object or a PHP stream resource - + type - - Defines what activity the socket is polled for. + + Defines what activity the socket is polled for. See ZMQ::POLL_IN and ZMQ::POLL_OUT constants. - + @@ -47,10 +47,10 @@ &reftitle.returnvalues; - - Returns a string id of the added item which can be later used to remove the item. + + Returns a string id of the added item which can be later used to remove the item. Throws ZMQPollException on error. - + diff --git a/reference/zmq/zmqpoll/clear.xml b/reference/zmq/zmqpoll/clear.xml index 8e78a4939..f0ba2a97e 100644 --- a/reference/zmq/zmqpoll/clear.xml +++ b/reference/zmq/zmqpoll/clear.xml @@ -13,9 +13,9 @@ public ZMQPollZMQPoll::clear - + Clears all elements from the poll set. - + @@ -25,9 +25,9 @@ &reftitle.returnvalues; - + Returns the current object. - + diff --git a/reference/zmq/zmqpoll/count.xml b/reference/zmq/zmqpoll/count.xml index 2bc78c0aa..7326d082e 100644 --- a/reference/zmq/zmqpoll/count.xml +++ b/reference/zmq/zmqpoll/count.xml @@ -13,9 +13,9 @@ public intZMQPoll::count - + Count the items in the poll set. - + @@ -25,9 +25,9 @@ &reftitle.returnvalues; - + Returns an &integer; representing the amount of items in the poll set. - + diff --git a/reference/zmq/zmqpoll/getlasterrors.xml b/reference/zmq/zmqpoll/getlasterrors.xml index fa2dbc1e6..1e0d92945 100644 --- a/reference/zmq/zmqpoll/getlasterrors.xml +++ b/reference/zmq/zmqpoll/getlasterrors.xml @@ -13,9 +13,9 @@ public arrayZMQPoll::getLastErrors - + Returns the ids of the objects that had errors in the last poll. - + @@ -25,10 +25,10 @@ &reftitle.returnvalues; - - Returns an array containing ids for the items that had errors in the last poll. Empty array is + + Returns an array containing ids for the items that had errors in the last poll. Empty array is returned if there were no errors. - + diff --git a/reference/zmq/zmqpoll/poll.xml b/reference/zmq/zmqpoll/poll.xml index 58325577d..9ef58cf53 100644 --- a/reference/zmq/zmqpoll/poll.xml +++ b/reference/zmq/zmqpoll/poll.xml @@ -15,11 +15,11 @@ arraywritable inttimeout-1 - - Polls the items in the current poll set. The readable and writable items are returned in the - readable and writable parameters. + + Polls the items in the current poll set. The readable and writable items are returned in the + readable and writable parameters. ZMQPoll::getLastErrors can be used to check if there were errors. - + @@ -29,30 +29,30 @@ readable - + Array where readable ZMQSockets/PHP streams are returned. The array will be cleared at the beginning of the operation. - + writable - + Array where writable ZMQSockets/PHP streams are returned. The array will be cleared at the beginning of the operation. - + timeout - + Timeout for the operation. -1 means that poll waits until - at least one item has activity. Please note that starting from + at least one item has activity. Please note that starting from version 1.0.0 the poll timeout is defined in milliseconds, rather than microseconds. - + @@ -61,16 +61,16 @@ &reftitle.returnvalues; - + Returns an integer representing the amount of items with activity. - + &reftitle.errors; - - Throws ZMQPollException on error. - + + Throws ZMQPollException on error. + @@ -78,9 +78,9 @@ A <function>ZMQPoll</function> example - + Create a simple poll server - + - + diff --git a/reference/zmq/zmqpoll/remove.xml b/reference/zmq/zmqpoll/remove.xml index f7dfdcce6..d1647ce68 100644 --- a/reference/zmq/zmqpoll/remove.xml +++ b/reference/zmq/zmqpoll/remove.xml @@ -13,10 +13,10 @@ public boolZMQPoll::remove mixeditem - + Remove item from the poll set. The item parameter can be ZMQSocket object, a stream resource or the id returned from ZMQPoll::add method. - +     @@ -26,9 +26,9 @@ item - + The ZMQSocket object, PHP stream or &string; id of the item. - + @@ -37,10 +37,10 @@ &reftitle.returnvalues; - - Returns true if the item was removed and false if the object + + Returns true if the item was removed and false if the object with given id does not exist in the poll set. - + diff --git a/reference/zmq/zmqpollexception.xml b/reference/zmq/zmqpollexception.xml index ef8a93989..3c7d6bc73 100644 --- a/reference/zmq/zmqpollexception.xml +++ b/reference/zmq/zmqpollexception.xml @@ -11,9 +11,9 @@
    &reftitle.intro; - + - +
    @@ -55,25 +55,25 @@ message - + code - + file - + line - + diff --git a/reference/zmq/zmqsocket.xml b/reference/zmq/zmqsocket.xml index b31f6ef0b..7bf60dd21 100644 --- a/reference/zmq/zmqsocket.xml +++ b/reference/zmq/zmqsocket.xml @@ -11,9 +11,9 @@
    &reftitle.intro; - + - +
    @@ -31,7 +31,7 @@ - + &Methods; diff --git a/reference/zmq/zmqsocket/bind.xml b/reference/zmq/zmqsocket/bind.xml index 92a66e3cb..8959e3e76 100644 --- a/reference/zmq/zmqsocket/bind.xml +++ b/reference/zmq/zmqsocket/bind.xml @@ -14,10 +14,10 @@ stringdsn boolforce&false; - - Bind the socket to an endpoint. The endpoint is defined in format transport://address where + + Bind the socket to an endpoint. The endpoint is defined in format transport://address where transport is one of the following: inproc, ipc, tcp, pgm or epgm. - +     @@ -27,17 +27,17 @@ dsn - + The bind dsn, for example transport://address. - + force - + Tries to bind even if the socket has already been bound to the given endpoint. - + @@ -46,9 +46,9 @@ &reftitle.returnvalues; - + Returns the current object. Throws ZMQSocketException on error. - + diff --git a/reference/zmq/zmqsocket/connect.xml b/reference/zmq/zmqsocket/connect.xml index fe6612f5f..800d9190f 100644 --- a/reference/zmq/zmqsocket/connect.xml +++ b/reference/zmq/zmqsocket/connect.xml @@ -14,10 +14,10 @@ stringdsn boolforce&false; - - Connect the socket to a remote endpoint. The endpoint is defined in format transport://address where + + Connect the socket to a remote endpoint. The endpoint is defined in format transport://address where transport is one of the following: inproc, ipc, tcp, pgm or epgm. - + @@ -27,17 +27,17 @@ dsn - + The connect dsn, for example transport://address. - + force - + Tries to connect even if the socket has already been connected to given endpoint. - + @@ -46,16 +46,16 @@ &reftitle.returnvalues; - + Returns the current object. - + &reftitle.errors; - - Throws ZMQSocketException on error. - + + Throws ZMQSocketException on error. + @@ -63,9 +63,9 @@ A <function>ZMQContext</function> example - + Construct a new context and allocate request socket from it - + stringpersistent_id&null; callableon_new_socket&null; - + Constructs a ZMQSocket object. persistent_id parameter can be used to allocated a persistent socket. A persistent socket has to be allocated from a persistent context and it stays connected over multiple requests. - The persistent_id parameter can be used to recall the same socket over multiple requests. The + The persistent_id parameter can be used to recall the same socket over multiple requests. The on_new_socket is called only when a new underlying socket structure is created. - + @@ -31,51 +31,51 @@ context - + ZMQContext object. - + type - + The socket type. See ZMQ::SOCKET_* constants. - + persistent_id - + If persistent_id is specified the socket will be persisted over multiple requests. If context is not persistent the socket falls back to non-persistent mode. - + on_new_socket - + Callback function, which is executed when a new socket structure is created. This function does not get invoked if the underlying persistent connection is re-used. - + callback ZMQSocketsocket stringpersistent_id&null; - + &reftitle.errors; - - Throws ZMQSocketException on error. - + + Throws ZMQSocketException on error. + @@ -83,15 +83,15 @@ A <function>ZMQSocket</function> example - + Using callback the bind/connect socket - + - + diff --git a/reference/zmq/zmqsocket/disconnect.xml b/reference/zmq/zmqsocket/disconnect.xml index 2b499c6b1..2928ba81b 100644 --- a/reference/zmq/zmqsocket/disconnect.xml +++ b/reference/zmq/zmqsocket/disconnect.xml @@ -13,10 +13,10 @@ public ZMQSocketZMQSocket::disconnect stringdsn - + Disconnect the socket from a previously connected remote endpoint. The endpoint is defined in format transport://address where transport is one of the following: inproc, ipc, tcp, pgm or epgm. - +     @@ -26,9 +26,9 @@ dsn - + The connect dsn, for example transport://address. - + @@ -37,9 +37,9 @@ &reftitle.returnvalues; - + Returns the current object. Throws ZMQSocketException on error. - + diff --git a/reference/zmq/zmqsocket/getendpoints.xml b/reference/zmq/zmqsocket/getendpoints.xml index bc0a84698..3f42019e7 100644 --- a/reference/zmq/zmqsocket/getendpoints.xml +++ b/reference/zmq/zmqsocket/getendpoints.xml @@ -13,9 +13,9 @@ public arrayZMQSocket::getEndpoints - + Returns a list of endpoints where the socket is connected or bound to. - + @@ -25,9 +25,9 @@ &reftitle.returnvalues; - - Returns an array containing elements 'bind' and 'connect'. - + + Returns an array containing elements 'bind' and 'connect'. + diff --git a/reference/zmq/zmqsocket/getpersistentid.xml b/reference/zmq/zmqsocket/getpersistentid.xml index c05ed4293..214aca8e2 100644 --- a/reference/zmq/zmqsocket/getpersistentid.xml +++ b/reference/zmq/zmqsocket/getpersistentid.xml @@ -13,9 +13,9 @@ public stringZMQSocket::getPersistentId - + Returns the persistent id of the socket. - + @@ -25,9 +25,9 @@ &reftitle.returnvalues; - + Returns the persistent id string assigned of the object and &null; if socket is not persistent. - + diff --git a/reference/zmq/zmqsocket/getsockettype.xml b/reference/zmq/zmqsocket/getsockettype.xml index c4770fd9c..b6c0bf4d4 100644 --- a/reference/zmq/zmqsocket/getsockettype.xml +++ b/reference/zmq/zmqsocket/getsockettype.xml @@ -13,9 +13,9 @@ public intZMQSocket::getSocketType - + Gets the socket type. - + @@ -25,10 +25,10 @@ &reftitle.returnvalues; - + Returns an integer representing the socket type. The integer can be compared against ZMQ::SOCKET_* constants. - + diff --git a/reference/zmq/zmqsocket/getsockopt.xml b/reference/zmq/zmqsocket/getsockopt.xml index 1630f353d..56ce0ee1b 100644 --- a/reference/zmq/zmqsocket/getsockopt.xml +++ b/reference/zmq/zmqsocket/getsockopt.xml @@ -13,9 +13,9 @@ public mixedZMQSocket::getSockOpt stringkey - - Returns the value of a socket option. - + + Returns the value of a socket option. + @@ -25,10 +25,10 @@ key - + An integer representing the option. See the ZMQ::SOCKOPT_* constants. - + @@ -37,10 +37,10 @@ &reftitle.returnvalues; - + Returns either a &string; or an &integer; depending on key. Throws - ZMQSocketException on error. - + ZMQSocketException on error. + diff --git a/reference/zmq/zmqsocket/ispersistent.xml b/reference/zmq/zmqsocket/ispersistent.xml index 0d7e31c0c..1a51ccef5 100644 --- a/reference/zmq/zmqsocket/ispersistent.xml +++ b/reference/zmq/zmqsocket/ispersistent.xml @@ -13,9 +13,9 @@ public boolZMQSocket::isPersistent - + Check whether the socket is persistent. - + @@ -25,9 +25,9 @@ &reftitle.returnvalues; - + Returns a &boolean; based on whether the socket is persistent or not. - + diff --git a/reference/zmq/zmqsocket/recv.xml b/reference/zmq/zmqsocket/recv.xml index 1800d9aa5..bfe2a40d3 100644 --- a/reference/zmq/zmqsocket/recv.xml +++ b/reference/zmq/zmqsocket/recv.xml @@ -13,12 +13,12 @@ public stringZMQSocket::recv intmode0 - + Receive a message from a socket. By default receiving will block until a message is available unless ZMQ::MODE_DONTWAIT flag is used. ZMQ::SOCKOPT_RCVMORE - socket option can be used for receiving multi-part messages. See ZMQSocket::setSockOpt + socket option can be used for receiving multi-part messages. See ZMQSocket::setSockOpt for more information. - + @@ -28,10 +28,10 @@ mode - - Pass mode flags to receive multipart messages or non-blocking operation. + + Pass mode flags to receive multipart messages or non-blocking operation. See ZMQ::MODE_* constants. - + @@ -40,17 +40,17 @@ &reftitle.returnvalues; - - Returns the message. If ZMQ::MODE_DONTWAIT + + Returns the message. If ZMQ::MODE_DONTWAIT is used and the operation would block &false; shall be returned. - + &reftitle.errors; - - Throws ZMQSocketException on error. - + + Throws ZMQSocketException on error. + @@ -58,9 +58,9 @@ A send/recv example - + Non-blocking send / receive - + - + diff --git a/reference/zmq/zmqsocket/recvmulti.xml b/reference/zmq/zmqsocket/recvmulti.xml index a080bb9f0..aab125580 100644 --- a/reference/zmq/zmqsocket/recvmulti.xml +++ b/reference/zmq/zmqsocket/recvmulti.xml @@ -13,10 +13,10 @@ public arrayZMQSocket::recvMulti intmode0 - + Receive an array multipart message from a socket. By default receiving will block until a message is available unless ZMQ::MODE_NOBLOCK flag is used. - + @@ -26,10 +26,10 @@ mode - - Pass mode flags to receive multipart messages or non-blocking operation. + + Pass mode flags to receive multipart messages or non-blocking operation. See ZMQ::MODE_* constants. - + @@ -38,11 +38,11 @@ &reftitle.returnvalues; - - Returns the array of message parts. Throws ZMQSocketException in error. - If ZMQ::MODE_NOBLOCK is used and the operation would + + Returns the array of message parts. Throws ZMQSocketException in error. + If ZMQ::MODE_NOBLOCK is used and the operation would block &boolean; false shall be returned. - + diff --git a/reference/zmq/zmqsocket/send.xml b/reference/zmq/zmqsocket/send.xml index f8adc4f3f..e9d17196a 100644 --- a/reference/zmq/zmqsocket/send.xml +++ b/reference/zmq/zmqsocket/send.xml @@ -14,9 +14,9 @@ stringmessage intmode0 - + Send a message using the socket. The operation can block unless ZMQ::MODE_NOBLOCK is used. - + @@ -26,18 +26,18 @@ message - + The message to send. - + mode - - Pass mode flags to receive multipart messages or non-blocking operation. + + Pass mode flags to receive multipart messages or non-blocking operation. See ZMQ::MODE_* constants. - + @@ -46,11 +46,11 @@ &reftitle.returnvalues; - - Returns the current object. Throws ZMQSocketException on error. - If ZMQ::MODE_NOBLOCK is used and the operation would + + Returns the current object. Throws ZMQSocketException on error. + If ZMQ::MODE_NOBLOCK is used and the operation would block &boolean; false shall be returned. - + diff --git a/reference/zmq/zmqsocket/sendmulti.xml b/reference/zmq/zmqsocket/sendmulti.xml index 4e5b33265..af05f8372 100644 --- a/reference/zmq/zmqsocket/sendmulti.xml +++ b/reference/zmq/zmqsocket/sendmulti.xml @@ -14,9 +14,9 @@ arraymessage intmode0 - + Send a multipart message using the socket. The operation can block unless ZMQ::MODE_NOBLOCK is used. - + @@ -26,18 +26,18 @@ message - + The message to send - an array of strings - + mode - - Pass mode flags to receive multipart messages or non-blocking operation. + + Pass mode flags to receive multipart messages or non-blocking operation. See ZMQ::MODE_* constants. - + @@ -46,11 +46,11 @@ &reftitle.returnvalues; - - Returns the current object. Throws ZMQSocketException on error. - If ZMQ::MODE_NOBLOCK is used and the operation would + + Returns the current object. Throws ZMQSocketException on error. + If ZMQ::MODE_NOBLOCK is used and the operation would block &boolean; false shall be returned. - + diff --git a/reference/zmq/zmqsocket/setsockopt.xml b/reference/zmq/zmqsocket/setsockopt.xml index 0a826c248..a0ffcdaf8 100644 --- a/reference/zmq/zmqsocket/setsockopt.xml +++ b/reference/zmq/zmqsocket/setsockopt.xml @@ -14,10 +14,10 @@ intkey mixedvalue - + Sets a ZMQ socket option. The type of the value depends on the key. See ZMQ Constant Types for more information. - + @@ -27,17 +27,17 @@ key - + One of the ZMQ::SOCKOPT_* constants. - + value - + The value of the parameter. - + @@ -46,9 +46,9 @@ &reftitle.returnvalues; - + Returns the current object. Throws ZMQSocketException on error. - + diff --git a/reference/zmq/zmqsocket/unbind.xml b/reference/zmq/zmqsocket/unbind.xml index 60eda037f..b2946f5bf 100644 --- a/reference/zmq/zmqsocket/unbind.xml +++ b/reference/zmq/zmqsocket/unbind.xml @@ -13,10 +13,10 @@ public ZMQSocketZMQSocket::unbind stringdsn - - Unbind the socket from an endpoint. The endpoint is defined in format transport://address where + + Unbind the socket from an endpoint. The endpoint is defined in format transport://address where transport is one of the following: inproc, ipc, tcp, pgm or epgm. - + @@ -26,9 +26,9 @@ dsn - + The previously bound dsn, for example transport://address. - + @@ -37,9 +37,9 @@ &reftitle.returnvalues; - + Returns the current object. Throws ZMQSocketException on error. - + diff --git a/reference/zmq/zmqsocketexception.xml b/reference/zmq/zmqsocketexception.xml index edd00f49f..c9bc033a8 100644 --- a/reference/zmq/zmqsocketexception.xml +++ b/reference/zmq/zmqsocketexception.xml @@ -11,9 +11,9 @@
    &reftitle.intro; - + - +
    @@ -55,25 +55,25 @@ message - + code - + file - + line - + diff --git a/reference/zookeeper/book.xml b/reference/zookeeper/book.xml index e3b9a21ed..97e3d298b 100644 --- a/reference/zookeeper/book.xml +++ b/reference/zookeeper/book.xml @@ -9,12 +9,12 @@ &reftitle.intro; - + This extension uses libzookeeper library to provide API for communicating with ZooKeeper service. - - + + ZooKeeper is an Apache project that enables centralized service for maintaining configuration information, naming, providing distributed synchronization, and providing group services. - + diff --git a/reference/zookeeper/configure.xml b/reference/zookeeper/configure.xml index dec2af872..3368fa818 100644 --- a/reference/zookeeper/configure.xml +++ b/reference/zookeeper/configure.xml @@ -4,21 +4,21 @@
    &reftitle.install; - + &pecl.moved; - - + + &pecl.info; &url.pecl.package;zookeeper. - + - - To enable zookeeper support, configure with + + To enable zookeeper support, configure with . DIR is the install prefix of ZooKeeper C Binding, which must contain the include/zookeeper/zookeeper.h - - + + &pecl.windows.download; - +
    &reftitle.required; - + This extension requires ZooKeeper C Binding (version 3.4.1 or greater). For more information, see ZooKeeper Programmer's Guide. - +
    diff --git a/reference/zookeeper/zookeeper.xml b/reference/zookeeper/zookeeper.xml index 87c76c403..123e85508 100644 --- a/reference/zookeeper/zookeeper.xml +++ b/reference/zookeeper/zookeeper.xml @@ -8,34 +8,34 @@ xmlns="http://docbook.org/ns/docbook"> The Zookeeper class Zookeeper - + - +
    &reftitle.intro; - + Represents ZooKeeper session. - +
    - +
    &reftitle.classsynopsis; - + Zookeeper - + Zookeeper - + - + &Methods; @@ -399,37 +399,37 @@ Zookeeper::PERM_READ - Can read nodes value and list its children + Can read nodes value and list its children Zookeeper::PERM_WRITE - Can set the nodes value + Can set the nodes value Zookeeper::PERM_CREATE - Can create children + Can create children Zookeeper::PERM_DELETE - Can delete children + Can delete children Zookeeper::PERM_ADMIN - Can execute set_acl() + Can execute set_acl() Zookeeper::PERM_ALL - All of the above flags ORd together + All of the above flags ORd together @@ -445,13 +445,13 @@ Zookeeper::EPHEMERAL - If Zookeeper::EPHEMERAL flag is set, the node will automatically get removed if the client session goes away. + If Zookeeper::EPHEMERAL flag is set, the node will automatically get removed if the client session goes away. Zookeeper::SEQUENCE - If the Zookeeper::SEQUENCE flag is set, a unique monotonically increasing sequence number is appended to the path name. The sequence number is always fixed length of 10 digits, 0 padded. + If the Zookeeper::SEQUENCE flag is set, a unique monotonically increasing sequence number is appended to the path name. The sequence number is always fixed length of 10 digits, 0 padded. @@ -472,19 +472,19 @@ Zookeeper::LOG_LEVEL_WARN - Outputs errors/warnings + Outputs errors/warnings Zookeeper::LOG_LEVEL_INFO - Outputs big action messages besides errors/warnings + Outputs big action messages besides errors/warnings Zookeeper::LOG_LEVEL_DEBUG - Outputs all + Outputs all @@ -500,43 +500,43 @@ Zookeeper::EXPIRED_SESSION_STATE - Connected but session expired + Connected but session expired Zookeeper::AUTH_FAILED_STATE - Connected but auth failed + Connected but auth failed Zookeeper::CONNECTING_STATE - Connecting + Connecting Zookeeper::ASSOCIATING_STATE - Associating + Associating Zookeeper::CONNECTED_STATE - Connected + Connected Zookeeper::READONLY_STATE - TODO: help us improve this extension. + TODO: help us improve this extension. Zookeeper::NOTCONNECTED_STATE - Connection failed + Connection failed @@ -552,43 +552,43 @@ Zookeeper::CREATED_EVENT - A node has been created - This is only generated by watches on non-existent nodes. These watches are set using Zookeeper::exists. + A node has been created + This is only generated by watches on non-existent nodes. These watches are set using Zookeeper::exists. Zookeeper::DELETED_EVENT - A node has been deleted - This is only generated by watches on nodes. These watches are set using Zookeeper::exists and Zookeeper::get. + A node has been deleted + This is only generated by watches on nodes. These watches are set using Zookeeper::exists and Zookeeper::get. Zookeeper::CHANGED_EVENT - A node has changed - This is only generated by watches on nodes. These watches are set using Zookeeper::exists and Zookeeper::get. + A node has changed + This is only generated by watches on nodes. These watches are set using Zookeeper::exists and Zookeeper::get. Zookeeper::CHILD_EVENT A change has occurred in the list of children - This is only generated by watches on the child list of a node. These watches are set using Zookeeper::getChildren. + This is only generated by watches on the child list of a node. These watches are set using Zookeeper::getChildren. Zookeeper::SESSION_EVENT - A session has been lost - This is generated when a client loses contact or reconnects with a server. + A session has been lost + This is generated when a client loses contact or reconnects with a server. Zookeeper::NOTWATCHING_EVENT - A watch has been removed - This is generated when the server for some reason, probably a resource constraint, will no longer watch a node for a client. + A watch has been removed + This is generated when the server for some reason, probably a resource constraint, will no longer watch a node for a client. @@ -603,69 +603,69 @@ Zookeeper::SYSTEMERROR - This is never thrown by the server, it shouldn't be used other than to indicate a range. Specifically error codes greater than this value, but lesser than Zookeeper::APIERROR, are system errors. + This is never thrown by the server, it shouldn't be used other than to indicate a range. Specifically error codes greater than this value, but lesser than Zookeeper::APIERROR, are system errors. Zookeeper::RUNTIMEINCONSISTENCY - A runtime inconsistency was found. + A runtime inconsistency was found. Zookeeper::DATAINCONSISTENCY - A data inconsistency was found. + A data inconsistency was found. Zookeeper::CONNECTIONLOSS - Connection to the server has been lost. + Connection to the server has been lost. Zookeeper::MARSHALLINGERROR - Error while marshalling or unmarshalling data. + Error while marshalling or unmarshalling data. Zookeeper::UNIMPLEMENTED - Operation is unimplemented. + Operation is unimplemented. Zookeeper::OPERATIONTIMEOUT - Operation timeout. + Operation timeout. Zookeeper::BADARGUMENTS - Invalid arguments. + Invalid arguments. Zookeeper::INVALIDSTATE - Invalid zhandle state. + Invalid zhandle state. Zookeeper::NEWCONFIGNOQUORUM - No quorum of new config is connected and up-to-date with the leader of last committed config - try invoking reconfiguration after new servers are connected and synced. - Available as of ZooKeeper 3.5.0 + No quorum of new config is connected and up-to-date with the leader of last committed config - try invoking reconfiguration after new servers are connected and synced. + Available as of ZooKeeper 3.5.0 Zookeeper::RECONFIGINPROGRESS - Reconfiguration requested while another reconfiguration is currently in progress. This is currently not supported. Please retry. - Available as of ZooKeeper 3.5.0 + Reconfiguration requested while another reconfiguration is currently in progress. This is currently not supported. Please retry. + Available as of ZooKeeper 3.5.0 @@ -679,115 +679,115 @@ Zookeeper::OK - Everything is OK. + Everything is OK. Zookeeper::APIERROR - This is never thrown by the server, it shouldn't be used other than to indicate a range. Specifically error codes greater than this value are API errors (while values less than this indicate a Zookeeper::SYSTEMERROR). + This is never thrown by the server, it shouldn't be used other than to indicate a range. Specifically error codes greater than this value are API errors (while values less than this indicate a Zookeeper::SYSTEMERROR). Zookeeper::NONODE - Node does not exist. + Node does not exist. Zookeeper::NOAUTH - Not authenticated. + Not authenticated. Zookeeper::BADVERSION - Version conflict. + Version conflict. Zookeeper::NOCHILDRENFOREPHEMERALS - Ephemeral nodes may not have children. + Ephemeral nodes may not have children. Zookeeper::NODEEXISTS - The node already exists. + The node already exists. Zookeeper::NOTEMPTY - The node has children. + The node has children. Zookeeper::SESSIONEXPIRED - The session has been expired by the server. + The session has been expired by the server. Zookeeper::INVALIDCALLBACK - Invalid callback specified. + Invalid callback specified. Zookeeper::INVALIDACL - Invalid ACL specified. + Invalid ACL specified. Zookeeper::AUTHFAILED - Client authentication failed. + Client authentication failed. Zookeeper::CLOSING - ZooKeeper is closing. + ZooKeeper is closing. Zookeeper::NOTHING - (not error) No server responses to process. + (not error) No server responses to process. Zookeeper::SESSIONMOVED - Session moved to another server, so operation is ignored. + Session moved to another server, so operation is ignored. Zookeeper::NOTREADONLY - State-changing request is passed to read-only server. + State-changing request is passed to read-only server. Zookeeper::EPHEMERALONLOCALSESSION - Attempt to create ephemeral node on a local session. + Attempt to create ephemeral node on a local session. Zookeeper::NOWATCHER - The watcher couldn't be found. + The watcher couldn't be found. Zookeeper::RECONFIGDISABLED - Attempts to perform a reconfiguration operation when reconfiguration feature is disabled. + Attempts to perform a reconfiguration operation when reconfiguration feature is disabled. @@ -797,13 +797,13 @@
    - +     - + &reference.zookeeper.entities.zookeeper; - + - +
    &reftitle.intro; - + The ZooKeeper authentication exception handling class. - +
    - +
    &reftitle.classsynopsis; - + ZookeeperAuthenticationException - + @@ -47,9 +47,9 @@
    - + - +
    &reftitle.intro; - + The ZooKeeper Config handling class. - +
    - +
    &reftitle.classsynopsis; - + ZookeeperConfig - + @@ -50,7 +50,7 @@ &reference.zookeeper.entities.zookeeperconfig; - +
    &reftitle.intro; - + The ZooKeeper connection exception handling class. - +
    - +
    &reftitle.classsynopsis; - + ZookeeperConnectionException - + @@ -48,9 +48,9 @@
    - + - +
    &reftitle.intro; - + The ZooKeeper exception handling class. - +
    - +
    &reftitle.classsynopsis; - + ZookeeperException - + @@ -48,9 +48,9 @@
    - + - +
    &reftitle.intro; - + The ZooKeeper exception (while marshalling or unmarshalling data) handling class. - +
    - +
    &reftitle.classsynopsis; - + ZookeeperMarshallingException - + @@ -48,9 +48,9 @@
    - + - +
    &reftitle.intro; - + The ZooKeeper exception (when node does not exist) handling class. - +
    - +
    &reftitle.classsynopsis; - + ZookeeperNoNodeException - + @@ -48,9 +48,9 @@
    - + - +
    &reftitle.intro; - + The ZooKeeper operation timeout exception handling class. - +
    - +
    &reftitle.classsynopsis; - + ZookeeperOperationTimeoutException - + @@ -48,9 +48,9 @@
    - + - +
    &reftitle.intro; - + The ZooKeeper session exception handling class. - +
    - +
    &reftitle.classsynopsis; - + ZookeeperSessionException - + @@ -48,9 +48,9 @@
    - + - +